diff --git a/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/Compose b/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/Compose new file mode 100644 index 0000000000000000000000000000000000000000..9b4b556e5d8c45d34aa8686a3092179c4cc25703 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/Compose @@ -0,0 +1,13 @@ +# +# ibm-cp1133 Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..02ca83b1605f24f87b9f9130d0358c1fb0624978 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for ibm-cp1133 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..f9c4e65b3ef0fd2d9eedf81850d0f032de859845 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ibm-cp1133/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for ibm-cp1133. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary IBM-CP1133:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset IBM-CP1133:GR + font IBM-CP1133:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name IBM-CP1133 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name IBM-CP1133 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding IBM-CP1133:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding IBM-CP1133:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iscii-dev/Compose b/miniconda3/envs/ladir/share/X11/locale/iscii-dev/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/iscii-dev/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iscii-dev/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..0dbaed515e74eb5c8a1ab6a7aa7473ff8e4bbeef --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iscii-dev/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iscii-dev locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iscii-dev/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iscii-dev/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..503c3f14f6fa045ce119dd8460fecd5c239f8c91 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iscii-dev/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for mulelao-1. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISCII-DEV:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset ISCII-DEV:GR + font ISCII-DEV:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name ISCII-DEV + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISCII-DEV +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISCII-DEV:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISCII-DEV:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/isiri-3342/Compose b/miniconda3/envs/ladir/share/X11/locale/isiri-3342/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/isiri-3342/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/isiri-3342/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..028d847167881b847114dc7e59a00ffb54632d9a --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/isiri-3342/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for isiri-3342 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/isiri-3342/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/isiri-3342/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..c67bdf0c2235cc0938892bd9d582b80c1f09d62e --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/isiri-3342/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for mulelao-1. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISIRI-3342:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset ISIRI-3342:GR + font ISIRI-3342:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name ISIRI-3342 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISIRI-3342 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISIRI-3342:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISIRI-3342:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-1/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-1/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bb870c46fc6639a053b598c204de5cd303ead64 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-1/Compose @@ -0,0 +1,474 @@ +# +# ISO 8859-1 (Latin1) Compose Sequence +# +# +# +# Sequence Definition +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "@" at + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\241" exclamdown + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + : "\251" copyright + : "\252" ordfeminine + : "\252" ordfeminine + : "\252" ordfeminine + : "\252" ordfeminine + : "\272" masculine + : "\272" masculine + : "\272" masculine + : "\272" masculine + : "\253" guillemotleft + : "\273" guillemotright + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + : "\261" plusminus + : "\261" plusminus + : "\265" mu + : "\265" mu + : "\265" mu + : "\265" mu + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph + : "\267" periodcentered + : "\267" periodcentered + : "\267" periodcentered + <1> <4> : "\274" onequarter + <1> <2> : "\275" onehalf + <3> <4> : "\276" threequarters + : "\277" questiondown + : "\240" nobreakspace + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\254" notsign + : "\254" notsign + : "\255" hyphen + : "\256" registered + : "\256" registered + : "\256" registered + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\367" division + : "\367" division + : "\327" multiply + : "\264" acute + : "\270" cedilla + : "\250" diaeresis +# Accented Alphabet + : "\300" Agrave + : "\300" Agrave + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\305" Aring + : "\305" Aring + : "\305" Aring + : "\305" Aring + : "\306" AE + : "\340" agrave + : "\340" agrave + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\345" aring + : "\345" aring + : "\345" aring + : "\345" aring + : "\346" ae + : "\307" Ccedilla + : "\347" ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\320" ETH + : "\320" ETH + : "\360" eth + : "\360" eth + : "\310" Egrave + : "\310" Egrave + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\350" egrave + : "\350" egrave + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\314" Igrave + : "\314" Igrave + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\354" igrave + : "\354" igrave + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\322" Ograve + : "\322" Ograve + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\330" Ooblique + : "\330" Ooblique + : "\362" ograve + : "\362" ograve + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\370" oslash + : "\370" oslash + : "\331" Ugrave + : "\331" Ugrave + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\371" ugrave + : "\371" ugrave + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\337" ssharp + : "\336" THORN + : "\376" thorn + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis +# +# +# dead key accent keysyms +# Special Character + : "|" bar + : "^" asciicircum + : "^" asciicircum + : "~" asciitilde + : "~" asciitilde + : "`" grave + : "`" grave +# These are for us_intl, that does not have diaeresis, etc + : "'" apostrophe + : "\264" acute + : "\"" quotedbl + : "\250" diaeresis + : "\"" quotedbl + : "\260" degree + : "\260" degree + <0> : "\260" degree + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + : "\267" periodcentered + : "\246" brokenbar + : "\254" notsign + : "\257" macron + : "\257" macron + : "\264" acute + : "\270" cedilla + : "\250" diaeresis +# Accented Alphabet + : "\305" Aring + : "\300" Agrave + : "\301" Aacute + : "\302" Acircumflex + : "\303" Atilde + : "\304" Adiaeresis + : "\345" aring + : "\340" agrave + : "\341" aacute + : "\342" acircumflex + : "\343" atilde + : "\344" adiaeresis + : "\307" Ccedilla + : "\347" ccedilla + : "\310" Egrave + : "\311" Eacute + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\350" egrave + : "\351" eacute + : "\352" ecircumflex + : "\353" ediaeresis + : "\314" Igrave + : "\315" Iacute + : "\316" Icircumflex + : "\317" Idiaeresis + : "\354" igrave + : "\355" iacute + : "\356" icircumflex + : "\357" idiaeresis + : "\321" Ntilde + : "\361" ntilde + : "\322" Ograve + : "\323" Oacute + : "\324" Ocircumflex + : "\325" Otilde + : "\326" Odiaeresis + : "\362" ograve + : "\363" oacute + : "\364" ocircumflex + : "\365" otilde + : "\366" odiaeresis + : "\331" Ugrave + : "\332" Uacute + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\371" ugrave + : "\372" uacute + : "\373" ucircumflex + : "\374" udiaeresis + : "\374" udiaeresis + : "\335" Yacute + : "\375" yacute + : "\377" ydiaeresis +# Useful for portuguese language + : "\307" Ccedilla + : "\347" ccedilla +# +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-1/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-1/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..3a9a1bb5adb016b27182ae3d23c0c0c23f3fa3c5 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-1/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for euro locales +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open + diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-1/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-1/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..53e1d526d74c12956d80791d6364508824168e06 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-1/XLC_LOCALE @@ -0,0 +1,52 @@ +# XLocale Database Sample for iso8859-1. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-1 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-1:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-10/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-10/Compose new file mode 100644 index 0000000000000000000000000000000000000000..dffafd420b989a05f00fe4f52eb6c871a82d6476 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-10/Compose @@ -0,0 +1,13 @@ +# +# ISO 8859-10 Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-10/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-10/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..7e3b8549ccebb64a155275d32df2f4b210bcbfe9 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-10/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-10 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-10/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-10/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..baadc671bf77e8c5851720114a5b31e8b38b6d73 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-10/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-4. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-10:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-10:GR + } + font { + primary ISO8859-10:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-10 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-10:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-10:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-11/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-11/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-11/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-11/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..168ccc04d11f81f150c2bf4918301a6a9e6de089 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-11/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-11 locale +# +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-11/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-11/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..2cb30735d6784a224a1f094029a0f5a91e7f4b48 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-11/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-11. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-11:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-11:GR + } + font { + primary ISO8859-11:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-11 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-11:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-11:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-13/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-13/Compose new file mode 100644 index 0000000000000000000000000000000000000000..c170c3fda0ee15749c8bcec930578e0fe5f1a377 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-13/Compose @@ -0,0 +1,430 @@ +# +# ISO 8859-13 (Latin7) Compose Sequence +# +# Sequence Definition +# +# Means +# Special Character +# Right-hand side (Accented Alphabet) +# These compose sequences are pure supposition on my part. +# It would be nice to know what the real cultural conventions +# are for compose sequences. + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "@" at + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\241" rightdoublequotemark + : "\241" rightdoublequotemark + : "\245" doublelowquotemark + : "\245" doublelowquotemark + : "\264" leftdoublequotemark + : "\264" leftdoublequotemark + : "\253" guillemotleft + : "\273" guillemotright + : "\377" rightsinglequotemark + : "\377" rightsinglequotemark + : "\377" rightsinglequotemark + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + : "\251" copyright + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + : "\261" plusminus + : "\261" plusminus + : "\265" mu + : "\265" mu + : "\265" mu + : "\265" mu + : "\265" mu + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph + : "\267" periodcentered + : "\267" periodcentered + : "\267" periodcentered + <1> <4> : "\274" onequarter + <1> <2> : "\275" onehalf + <3> <4> : "\276" threequarters + : "\277" questiondown + : "\240" nobreakspace + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\254" notsign + : "\254" notsign + : "\255" hyphen + : "\256" registered + : "\256" registered + : "\256" registered + : "\367" division + : "\367" division + : "\327" multiply +# Accented Alphabet + : "\300" Aogonek + : "\300" Aogonek + : "\300" Aogonek + : "\300" Aogonek + : "\252" Rcedilla + : "\252" Rcedilla + : "\252" Rcedilla + : "\252" Rcedilla + : "\317" Lcedilla + : "\317" Lcedilla + : "\317" Lcedilla + : "\317" Lcedilla + : "\320" Scaron + : "\320" Scaron + : "\307" Emacron + : "\307" Emacron + : "\307" Emacron + : "\307" Emacron + : "\314" Gcedilla + : "\314" Gcedilla + : "\314" Gcedilla + : "\314" Gcedilla + : "\336" Zcaron + : "\336" Zcaron + : "\340" aogonek + : "\340" aogonek + : "\340" aogonek + : "\340" aogonek + : "\272" rcedilla + : "\272" rcedilla + : "\272" rcedilla + : "\272" rcedilla + : "\357" lcedilla + : "\357" lcedilla + : "\357" lcedilla + : "\357" lcedilla + : "\360" scaron + : "\360" scaron + : "\347" emacron + : "\347" emacron + : "\347" emacron + : "\347" emacron + : "\354" gcedilla + : "\354" gcedilla + : "\354" gcedilla + : "\354" gcedilla + : "\376" zcaron + : "\376" zcaron + : "\302" Amacron + : "\302" Amacron + : "\302" Amacron + : "\302" Amacron + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\305" Aring + : "\305" Aring + : "\305" Aring + : "\305" Aring + : "\257" AE + : "\301" Iogonek + : "\301" Iogonek + : "\301" Iogonek + : "\301" Iogonek + : "\310" Ccaron + : "\310" Ccaron + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\306" Eogonek + : "\306" Eogonek + : "\306" Eogonek + : "\306" Eogonek + : "\313" Eabovedot + : "\313" Eabovedot + : "\316" Imacron + : "\316" Imacron + : "\316" Imacron + : "\316" Imacron + : "\322" Ncedilla + : "\322" Ncedilla + : "\322" Ncedilla + : "\322" Ncedilla + : "\324" Omacron + : "\324" Omacron + : "\324" Omacron + : "\324" Omacron + : "\315" Kcedilla + : "\315" Kcedilla + : "\315" Kcedilla + : "\315" Kcedilla + : "\325" Otilde + : "\325" Otilde + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\250" Ooblique + : "\250" Ooblique + : "\330" Uogonek + : "\330" Uogonek + : "\330" Uogonek + : "\330" Uogonek + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\333" Umacron + : "\333" Umacron + : "\333" Umacron + : "\333" Umacron + : "\337" ssharp + : "\342" amacron + : "\342" amacron + : "\342" amacron + : "\342" amacron + : "\344" adiaeresis + : "\344" adiaeresis + : "\345" aring + : "\345" aring + : "\345" aring + : "\345" aring + : "\277" ae + : "\341" iogonek + : "\341" iogonek + : "\341" iogonek + : "\341" iogonek + : "\350" ccaron + : "\350" ccaron + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\346" eogonek + : "\346" eogonek + : "\346" eogonek + : "\346" eogonek + : "\353" eabovedot + : "\353" eabovedot + : "\356" imacron + : "\356" imacron + : "\356" imacron + : "\356" imacron + : "\362" ncedilla + : "\362" ncedilla + : "\362" ncedilla + : "\362" ncedilla + : "\364" omacron + : "\364" omacron + : "\364" omacron + : "\364" omacron + : "\355" kcedilla + : "\355" kcedilla + : "\355" kcedilla + : "\355" kcedilla + : "\365" otilde + : "\365" otilde + : "\366" odiaeresis + : "\366" odiaeresis + : "\270" ooblique + : "\270" ooblique + : "\370" uogonek + : "\370" uogonek + : "\370" uogonek + : "\370" uogonek + : "\374" udiaeresis + : "\374" udiaeresis + : "\373" umacron + : "\373" umacron + : "\373" umacron + : "\373" umacron + : "\303" Cacute + : "\303" Cacute + : "\343" cacute + : "\343" cacute + : "\323" Oacute + : "\323" Oacute + : "\363" oacute + : "\363" oacute + : "\312" Zacute + : "\312" Zacute + : "\352" zacute + : "\352" zacute + : "\321" Nacute + : "\321" Nacute + : "\361" nacute + : "\361" nacute + : "\331" Lstroke + : "\331" Lstroke + : "\331" Lstroke + : "\331" Lstroke + : "\371" lstroke + : "\371" lstroke + : "\371" lstroke + : "\371" lstroke + : "\332" Sacute + : "\332" Sacute + : "\372" sacute + : "\372" sacute + : "\335" Zabovedot + : "\335" Zabovedot + : "\375" zabovedot + : "\375" zabovedot + : "\305" Aring + : "\345" aring + : "\313" Eabovedot + : "\353" eabovedot + : "\335" Zabovedot + : "\375" zabovedot + : "\267" abovedot + : "\305" Aring + : "\345" aring + : "\313" Eabovedot + : "\353" eabovedot + : "\335" Zabovedot + : "\375" zabovedot + : "\260" ring + : "\260" ring + : "\377" rightsinglequotemark + : "\303" Cacute + : "\311" Eacute + : "\312" Zacute + : "\321" Nacute + : "\323" Oacute + : "\332" Sacute + : "\343" cacute + : "\351" eacute + : "\352" zacute + : "\361" nacute + : "\363" oacute + : "\372" sacute + : "\310" Ccaron + : "\320" Scaron + : "\336" Zcaron + : "\350" ccaron + : "\360" scaron + : "\376" zcaron + : "\252" Rcedilla + : "\314" Gcedilla + : "\315" Kcedilla + : "\317" Lcedilla + : "\322" Ncedilla + : "\272" rcedilla + : "\354" gcedilla + : "\355" kcedilla + : "\357" lcedilla + : "\362" ncedilla + : "\304" Adiaeresis + : "\326" Odiaeresis + : "\334" Udiaeresis + : "\344" adiaeresis + : "\366" odiaeresis + : "\374" udiaeresis + : "\302" Amacron + : "\307" Emacron + : "\316" Imacron + : "\324" Omacron + : "\333" Umacron + : "\342" amacron + : "\347" emacron + : "\356" imacron + : "\364" omacron + : "\373" umacron + : "\255" macron + : "\255" macron + : "\300" Aogonek + : "\301" Iogonek + : "\306" Eogonek + : "\330" Uogonek + : "\340" aogonek + : "\341" iogonek + : "\346" eogonek + : "\370" uogonek + : "\325" Otilde + : "\365" otilde + : "~" asciitilde + : "~" asciitilde +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-13/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-13/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..f20902a61fa1161c0cfd9d131b84e96a81d6b858 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-13/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for euro locales +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/xiiimp _XimpLocalOpenIM # XIM_open +XOM common/xomGeneric _XomGenericOpenOM # XOM_open + diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-13/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-13/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..05acac0778a389b2a11ac7d6bf7a2f410eef3bc6 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-13/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-13. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-13:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-13:GR + } + font { + primary ISO8859-13:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-13 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-13:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-13:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-14/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-14/Compose new file mode 100644 index 0000000000000000000000000000000000000000..9d0562b61515e24ebe798136931bac3fd53bb464 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-14/Compose @@ -0,0 +1,484 @@ +# ISO 8859-14 (Latin 8) Compose Sequences +# +# Original version by Alastair McKinstry, +# Fixed and tidied up by Seamus O Ciardhuain (Dec 2002) +# +# +# First part is taken from the Latin-1 definitions, +# i.e. characters the same in 8859-1 and 8859-14. +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "@" at + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph + : "\240" nobreakspace + : "\255" hyphen + : "\256" registered + : "\256" registered + : "\256" registered + : "\256" registered + <0> : "\256" registered + <0> : "\256" registered + <0> : "\256" registered + <0> : "\256" registered +# Accented Alphabet + : "\300" Agrave + : "\300" Agrave + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\305" Aring + : "\305" Aring + : "\306" AE + : "\340" agrave + : "\340" agrave + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\345" aring + : "\345" aring + : "\346" ae + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\310" Egrave + : "\310" Egrave + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\350" egrave + : "\350" egrave + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\314" Igrave + : "\314" Igrave + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\354" igrave + : "\354" igrave + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\322" Ograve + : "\322" Ograve + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\330" Ooblique + : "\330" Ooblique + : "\362" ograve + : "\362" ograve + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\370" oslash + : "\370" oslash + : "\331" Ugrave + : "\331" Ugrave + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\371" ugrave + : "\371" ugrave + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\337" ssharp + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis +# +# dead key accent keysyms +# Special Character + : "|" bar + : "`" grave + : "'" apostrophe + : "^" asciicircum + : "~" asciitilde +# Accented Alphabet + : "\300" Agrave + : "\301" Aacute + : "\302" Acircumflex + : "\303" Atilde + : "\304" Adiaeresis + : "\340" agrave + : "\341" aacute + : "\342" acircumflex + : "\343" atilde + : "\344" adiaeresis + : "\307" Ccedilla + : "\347" ccedilla + : "\310" Egrave + : "\311" Eacute + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\350" egrave + : "\351" eacute + : "\352" ecircumflex + : "\353" ediaeresis + : "\314" Igrave + : "\315" Iacute + : "\316" Icircumflex + : "\317" Idiaeresis + : "\354" igrave + : "\355" iacute + : "\356" icircumflex + : "\357" idiaeresis + : "\321" Ntilde + : "\361" ntilde + : "\322" Ograve + : "\323" Oacute + : "\324" Ocircumflex + : "\325" Otilde + : "\326" Odiaeresis + : "\362" ograve + : "\363" oacute + : "\364" ocircumflex + : "\365" otilde + : "\366" odiaeresis + : "\331" Ugrave + : "\332" Uacute + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\371" ugrave + : "\372" uacute + : "\373" ucircumflex + : "\374" udiaeresis + : "\335" Yacute + : "\375" yacute + : "\377" ydiaeresis +# The following is Celtic character support, +# i.e. the characters in 8859-14 which differ from 8859-1. + : "\242" babovedot + : "\241" Babovedot + : "\245" cabovedot + : "\245" Cabovedot + : "\253" dabovedot + : "\246" Dabovedot + : "\261" fabovedot + : "\260" Fabovedot + : "\263" gabovedot + : "\262" Gabovedot + : "\265" mabovedot + : "\264" Mabovedot +

: "\271" pabovedot +

: "\267" Pabovedot + : "\277" sabovedot + : "\273" Sabovedot + : "\367" tabovedot + : "\327" Tabovedot + : "\242" babovedot + : "\241" Babovedot + : "\245" cabovedot + : "\245" Cabovedot + : "\253" dabovedot + : "\246" Dabovedot + : "\261" fabovedot + : "\260" Fabovedot + : "\263" gabovedot + : "\262" Gabovedot + : "\265" mabovedot + : "\264" Mabovedot +

: "\271" pabovedot +

: "\267" Pabovedot + : "\277" sabovedot + : "\273" Sabovedot + : "\367" tabovedot + : "\327" Tabovedot + : "\376" ycircumflex + : "\376" ycircumflex + : "\336" Ycircumflex + : "\336" Ycircumflex + : "\360" wcircumflex + : "\360" wcircumflex + : "\320" Wcircumflex + : "\320" Wcircumflex + : "\257" Ydiaeresis + : "\257" Ydiaeresis + : "\257" Ydiaeresis + : "\257" Ydiaeresis + : "\275" Wdiaeresis + : "\275" Wdiaeresis + : "\275" Wdiaeresis + : "\275" Wdiaeresis + : "\276" wdiaeresis + : "\276" wdiaeresis + : "\276" wdiaeresis + : "\276" wdiaeresis + : "\254" Ygrave + : "\254" Ygrave + : "\274" ygrave + : "\274" ygrave + : "\250" Wgrave + : "\250" Wgrave + : "\270" wgrave + : "\270" wgrave + : "\252" Wacute + : "\252" Wacute + : "\252" Wacute + : "\252" Wacute + : "\272" wacute + : "\272" wacute + : "\272" wacute + : "\272" wacute + : "\242" babovedot + : "\241" Babovedot + : "\245" cabovedot + : "\245" Cabovedot + : "\253" dabovedot + : "\246" Dabovedot + : "\261" fabovedot + : "\260" Fabovedot + : "\263" gabovedot + : "\262" Gabovedot + : "\265" mabovedot + : "\264" Mabovedot +

: "\271" pabovedot +

: "\267" Pabovedot + : "\277" sabovedot + : "\273" Sabovedot + : "\367" tabovedot + : "\327" Tabovedot + : "\242" babovedot + : "\241" Babovedot + : "\245" cabovedot + : "\245" Cabovedot + : "\253" dabovedot + : "\246" Dabovedot + : "\261" fabovedot + : "\260" Fabovedot + : "\263" gabovedot + : "\262" Gabovedot + : "\265" mabovedot + : "\264" Mabovedot +

: "\271" pabovedot +

: "\267" Pabovedot + : "\277" sabovedot + : "\273" Sabovedot + : "\367" tabovedot + : "\327" Tabovedot + : "\242" babovedot + : "\241" Babovedot + : "\245" cabovedot + : "\245" Cabovedot + : "\253" dabovedot + : "\246" Dabovedot + : "\261" fabovedot + : "\260" Fabovedot + : "\263" gabovedot + : "\262" Gabovedot + : "\265" mabovedot + : "\264" Mabovedot +

: "\271" pabovedot +

: "\267" Pabovedot + : "\277" sabovedot + : "\273" Sabovedot + : "\367" tabovedot + : "\327" Tabovedot + : "\257" Ydiaeresis + : "\254" Ygrave + : "\274" ygrave + : "\376" ycircumflex + : "\336" Ycircumflex + : "\360" wcircumflex + : "\320" Wcircumflex + : "\276" wdiaeresis + : "\275" Wdiaeresis + : "\272" wacute + : "\252" Wacute + : "\250" Wgrave + : "\270" wgrave +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-14/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-14/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..ebd00a6bb57070e4cafe966cab3e3df99a59700f --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-14/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-14 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-14/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-14/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..0820c4a46485b845b3bc941dd57eb2b7a718fbb1 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-14/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-14. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-14:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-14:GR + } + font { + primary ISO8859-14:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-14 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-14:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-14:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-15/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-15/Compose new file mode 100644 index 0000000000000000000000000000000000000000..497f3b19eb9937c6d2006f75304f3dadfed4c9d7 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-15/Compose @@ -0,0 +1,476 @@ +# +# ISO 8859-15 (Latin1) Compose Sequence +# +# +# Sequence Definition +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "@" at + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\241" exclamdown + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\252" ordfeminine + : "\252" ordfeminine + : "\252" ordfeminine + : "\252" ordfeminine + : "\272" masculine + : "\272" masculine + : "\272" masculine + : "\272" masculine + : "\253" guillemotleft + : "\273" guillemotright + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + : "\261" plusminus + : "\261" plusminus + : "\265" mu + : "\265" mu + : "\265" mu + : "\265" mu + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph + : "\267" periodcentered + : "\267" periodcentered + : "\267" periodcentered + : "\277" questiondown + : "\240" nobreakspace + : "\254" notsign + : "\254" notsign + : "\255" hyphen + : "\256" registered + : "\256" registered + : "\256" registered + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\367" division + : "\367" division + : "\327" multiply + : "\264" acute + : "\270" cedilla + : "\"" quotedbl +# Accented Alphabet + : "\300" Agrave + : "\300" Agrave + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\305" Aring + : "\305" Aring + : "\305" Aring + : "\305" Aring + : "\306" AE + : "\340" agrave + : "\340" agrave + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\345" aring + : "\345" aring + : "\345" aring + : "\345" aring + : "\346" ae + : "\307" Ccedilla + : "\347" ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\320" ETH + : "\320" ETH + : "\360" eth + : "\360" eth + : "\310" Egrave + : "\310" Egrave + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\350" egrave + : "\350" egrave + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\314" Igrave + : "\314" Igrave + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\354" igrave + : "\354" igrave + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\322" Ograve + : "\322" Ograve + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\330" Ooblique + : "\330" Ooblique + : "\274" OE + : "\362" ograve + : "\362" ograve + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\370" oslash + : "\370" oslash + : "\275" oe + : "\246" Scaron + : "\246" Scaron + : "\250" scaron + : "\250" scaron + : "\331" Ugrave + : "\331" Ugrave + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\371" ugrave + : "\371" ugrave + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\337" ssharp + : "\336" THORN + : "\376" thorn + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\264" Zcaron + : "\264" Zcaron + : "\270" zcaron + : "\270" zcaron +# +# dead key accent keysyms +# Special Character + : "|" bar + : "^" asciicircum + : "^" asciicircum + : "~" asciitilde + : "~" asciitilde + : "`" grave + : "`" grave +# These are for us_intl, that does not have diaeresis, etc + : "'" apostrophe + : "\264" acute + : "\"" quotedbl + : "\"" quotedbl + : "\"" quotedbl + <0> : "\260" degree + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + : "\267" periodcentered + : "\254" notsign + : "\257" macron + : "\257" macron + : "\264" acute + : "\270" cedilla + : "\"" quotedbl +# Accented Alphabet + : "\305" Aring + : "\300" Agrave + : "\301" Aacute + : "\302" Acircumflex + : "\303" Atilde + : "\304" Adiaeresis + : "\345" aring + : "\340" agrave + : "\341" aacute + : "\342" acircumflex + : "\343" atilde + : "\344" adiaeresis + : "\307" Ccedilla + : "\347" ccedilla + : "\310" Egrave + : "\311" Eacute + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\350" egrave + : "\351" eacute + : "\352" ecircumflex + : "\353" ediaeresis + : "\314" Igrave + : "\315" Iacute + : "\316" Icircumflex + : "\317" Idiaeresis + : "\354" igrave + : "\355" iacute + : "\356" icircumflex + : "\357" idiaeresis + : "\321" Ntilde + : "\361" ntilde + : "\322" Ograve + : "\323" Oacute + : "\324" Ocircumflex + : "\325" Otilde + : "\326" Odiaeresis + : "\362" ograve + : "\363" oacute + : "\364" ocircumflex + : "\365" otilde + : "\366" odiaeresis + : "\246" Scaron + : "\250" scaron + : "\246" Scaron + : "\250" scaron + : "\331" Ugrave + : "\332" Uacute + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\371" ugrave + : "\372" uacute + : "\373" ucircumflex + : "\374" udiaeresis + : "\335" Yacute + : "\276" Ydiaeresis + : "\375" yacute + : "\377" ydiaeresis + : "\264" Zcaron + : "\270" zcaron + : "\264" Zcaron + : "\270" zcaron +# Useful for portuguese language + : "\307" Ccedilla + : "\347" ccedilla +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-15/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-15/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..1e4f6cc512f9e2a9db94cc53a8d7a9dd15cf2d47 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-15/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-15 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-15/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-15/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..1c0cfbd6174bea1068f7ab3a0af3d73c87a78141 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-15/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for fcd/dis/iso 8859-15. +# When Final Committee Draft (FCD) 8859-15 is formalized +# then this file will be renamed iso8859-15. +# This file is provided as preliminary support for the Latin-9 +# (a.k.a. Latin-0) character set so that Europeans who want +# the Euro currency character can do so. +# +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-15:GL + substitute ISO8859-15:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-15:GR + } + font { + primary ISO8859-15:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-15 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-15:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-15:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-2/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-2/Compose new file mode 100644 index 0000000000000000000000000000000000000000..2de9db9934f4181723d602db023e1d31743959fa --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-2/Compose @@ -0,0 +1,535 @@ +# +# ISO 8859-2 (Latin2) Compose Sequence +# +# +# Sequence Definition +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "@" at + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\244" currency +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph +# Right-hand side (Accented Alphabet) +# These compose sequences are pure supposition on my part. +# It would be nice to know what the real cultural conventions +# are for compose sequences. + : "\241" Aogonek + : "\241" Aogonek + : "\241" Aogonek + : "\241" Aogonek + : "\242" breve + : "\243" Lstroke + : "\245" Lcaron + : "\245" Lcaron + : "\245" Lcaron + : "\245" Lcaron + : "\246" Sacute + : "\246" Sacute + : "\246" Sacute + : "\246" Sacute + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\250" diaeresis + : "\251" Scaron + : "\251" Scaron + : "\251" Scaron + : "\251" Scaron + : "\252" Scedilla + : "\252" Scedilla + : "\252" Scedilla + : "\252" Scedilla + : "\253" Tcaron + : "\253" Tcaron + : "\253" Tcaron + : "\253" Tcaron + : "\254" Zacute + : "\254" Zacute + : "\254" Zacute + : "\254" Zacute + : "\255" hyphen + : "\256" Zcaron + : "\256" Zcaron + : "\256" Zcaron + : "\256" Zcaron + : "\257" Zabovedot + <0> : "\260" degree + <0> : "\260" degree + : "\261" aogonek + : "\261" aogonek + : "\261" aogonek + : "\261" aogonek + : "\263" lstroke + : "\265" lcaron + : "\265" lcaron + : "\265" lcaron + : "\265" lcaron + : "\266" sacute + : "\266" sacute + : "\266" sacute + : "\266" sacute + : "\267" caron + : "\270" cedilla + : "\271" scaron + : "\271" scaron + : "\271" scaron + : "\271" scaron + : "\272" scedilla + : "\272" scedilla + : "\272" scedilla + : "\272" scedilla + : "\273" tcaron + : "\273" tcaron + : "\273" tcaron + : "\273" tcaron + : "\274" zacute + : "\274" zacute + : "\274" zacute + : "\274" zacute + : "\275" doubleacute + : "\275" doubleacute + : "\276" zcaron + : "\276" zcaron + : "\276" zcaron + : "\276" zcaron + : "\277" zabovedot + : "\300" Racute + : "\300" Racute + : "\300" Racute + : "\300" Racute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\303" Abreve + : "\303" Abreve + : "\303" Abreve + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\305" Lacute + : "\305" Lacute + : "\305" Lacute + : "\305" Lacute + : "\306" Cacute + : "\306" Cacute + : "\306" Cacute + : "\306" Cacute + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\310" Ccaron + : "\310" Ccaron + : "\310" Ccaron + : "\310" Ccaron + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\312" Eogonek + : "\312" Eogonek + : "\312" Eogonek + : "\312" Eogonek + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\314" Ecaron + : "\314" Ecaron + : "\314" Ecaron + : "\314" Ecaron + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\317" Dcaron + : "\317" Dcaron + : "\317" Dcaron + : "\317" Dcaron + : "\320" Dstroke + : "\320" Dstroke + : "\321" Nacute + : "\321" Nacute + : "\321" Nacute + : "\321" Nacute + : "\322" Ncaron + : "\322" Ncaron + : "\322" Ncaron + : "\322" Ncaron + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\325" Odoubleacute + : "\325" Odoubleacute + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\327" multiply + : "\330" Rcaron + : "\330" Rcaron + : "\330" Rcaron + : "\330" Rcaron + : "\331" Uring + : "\331" Uring + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\333" Udoubleacute + : "\333" Udoubleacute + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\336" Tcedilla + : "\336" Tcedilla + : "\336" Tcedilla + : "\336" Tcedilla + : "\337" ssharp + : "\340" racute + : "\340" racute + : "\340" racute + : "\340" racute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\343" abreve + : "\343" abreve + : "\343" abreve + : "\344" adiaeresis + : "\344" adiaeresis + : "\345" lacute + : "\345" lacute + : "\345" lacute + : "\345" lacute + : "\346" cacute + : "\346" cacute + : "\346" cacute + : "\346" cacute + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\350" ccaron + : "\350" ccaron + : "\350" ccaron + : "\350" ccaron + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\352" eogonek + : "\352" eogonek + : "\352" eogonek + : "\352" eogonek + : "\353" ediaeresis + : "\353" ediaeresis + : "\354" ecaron + : "\354" ecaron + : "\354" ecaron + : "\354" ecaron + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\357" dcaron + : "\357" dcaron + : "\357" dcaron + : "\357" dcaron + : "\360" dstroke + : "\360" dstroke + : "\361" nacute + : "\361" nacute + : "\361" nacute + : "\361" nacute + : "\362" ncaron + : "\362" ncaron + : "\362" ncaron + : "\362" ncaron + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\365" odoubleacute + : "\365" odoubleacute + : "\366" odiaeresis + : "\366" odiaeresis + : "\367" division + : "\367" division + : "\370" rcaron + : "\370" rcaron + : "\370" rcaron + : "\370" rcaron + : "\371" uring + : "\371" uring + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\373" udoubleacute + : "\373" udoubleacute + : "\374" udiaeresis + : "\374" udiaeresis + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\376" tcedilla + : "\376" tcedilla + : "\376" tcedilla + : "\376" tcedilla + : "\377" abovedot + : "\301" Aacute + : "\306" Cacute + : "\311" Eacute + : "\315" Iacute + : "\305" Lacute + : "\321" Nacute + : "\323" Oacute + : "\300" Racute + : "\246" Sacute + : "\332" Uacute + : "\335" Yacute + : "\254" Zacute + : "\341" aacute + : "\346" cacute + : "\351" eacute + : "\355" iacute + : "\345" lacute + : "\361" nacute + : "\363" oacute + : "\340" racute + : "\266" sacute + : "\372" uacute + : "\375" yacute + : "\274" zacute + : "\303" Abreve + : "\343" abreve + : "\304" Adiaeresis + : "\313" Ediaeresis + : "\326" Odiaeresis + : "\334" Udiaeresis + : "\344" adiaeresis + : "\353" ediaeresis + : "\366" odiaeresis + : "\374" udiaeresis + : "\331" Uring + : "\371" uring + : "\325" Odoubleacute + : "\333" Udoubleacute + : "\365" odoubleacute + : "\373" udoubleacute + : "\310" Ccaron + : "\317" Dcaron + : "\314" Ecaron + : "\245" Lcaron + : "\322" Ncaron + : "\330" Rcaron + : "\251" Scaron + : "\253" Tcaron + : "\256" Zcaron + : "\350" ccaron + : "\357" dcaron + : "\354" ecaron + : "\265" lcaron + : "\362" ncaron + : "\370" rcaron + : "\271" scaron + : "\273" tcaron + : "\276" zcaron + : "\252" Scedilla + : "\307" Ccedilla + : "\336" Tcedilla + : "\347" ccedilla + : "\272" scedilla + : "\376" tcedilla +# those are for ease of use + : "\331" Uring + : "\371" uring + : "\331" Uring + : "\371" uring +# traditional sequences + : "\274" OE + : "\275" oe + : "\305" Aring + : "\345" aring + : "\260" degree + : "\260" degree + : "\260" degree + : "\260" degree + : "\245" Itilde + : "\265" itilde + : "\303" Atilde + : "\325" Otilde + : "\335" Utilde + : "\343" atilde + : "\365" otilde + : "\375" utilde + : "\321" Ntilde + : "\361" ntilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\267" caron + : "\267" caron + : "\267" caron + : "\267" caron + : "\302" Acircumflex + : "\316" Icircumflex + : "\324" Ocircumflex + : "\333" Ucircumflex + : "\342" acircumflex + : "\356" icircumflex + : "\364" ocircumflex + : "\373" ucircumflex + : "\136" asciicircum + : "\136" asciicircum + : "\136" asciicircum + : "\136" asciicircum + : "\253" Gbreve + : "\273" gbreve + : "\335" Ubreve + : "\375" ubreve + : "\242" breve + : "\242" breve + : "\242" breve + : "\242" breve + : "\241" Aogonek + : "\307" Iogonek + : "\312" Eogonek + : "\331" Uogonek + : "\261" aogonek + : "\347" iogonek + : "\352" eogonek + : "\371" uogonek + : "\662" ogonek + : "\662" ogonek + : "\662" ogonek + : "\662" ogonek + : "\300" Agrave + : "\340" agrave + : "\310" Egrave + : "\350" egrave + : "\314" Igrave + : "\354" igrave + : "\322" Ograve + : "\362" ograve + : "\331" Ugrave + : "\371" ugrave + : "`" grave + : "`" grave + : "`" grave + : "`" grave + : "\305" Cabovedot + : "\345" cabovedot + : "\251" Iabovedot + : "\271" idotless + : "\257" Zabovedot + : "\277" zabovedot + : "\314" Eabovedot + : "\354" eabovedot + : "\377" abovedot + : "\377" abovedot + : "\377" abovedot + : "\377" abovedot + : "\264" acute + : "\264" acute + : "\264" acute + : "\264" acute + : "\675" doubleacute + : "\675" doubleacute + : "\675" doubleacute + : "\675" doubleacute + : "\317" Idiaeresis + : "\357" idiaeresis + : "\377" ydiaeresis + : "\250" diaeresis + : "\250" diaeresis + : "\250" diaeresis + : "\250" diaeresis + : "\270" cedilla + : "\270" cedilla + : "\270" cedilla + : "\270" cedilla + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-2/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-2/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..f20902a61fa1161c0cfd9d131b84e96a81d6b858 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-2/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for euro locales +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/xiiimp _XimpLocalOpenIM # XIM_open +XOM common/xomGeneric _XomGenericOpenOM # XOM_open + diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-2/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-2/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..9f68becf5a3af409bb36a7f68b5420fe0f64b86a --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-2/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-2. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-2:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-2:GR + } + font { + primary ISO8859-2:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-2 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-2:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-2:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-3/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-3/Compose new file mode 100644 index 0000000000000000000000000000000000000000..d5808f03a5aca9de597827ec3527ad2e24a8dbd4 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-3/Compose @@ -0,0 +1,483 @@ +# +# ISO 8859-3 (Latin3) Compose Sequence +# +# Sequence Definition +# +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "@" at + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + : "\265" mu + : "\265" mu + : "\265" mu + : "\265" mu + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + : "\267" periodcentered + : "\267" periodcentered + : "\267" periodcentered + : "\240" nobreakspace + : "\255" hyphen + : "\256" registered + : "\256" registered + : "\256" registered + : "\367" division + : "\367" division + : "\327" multiply + : "\264" acute + : "\270" cedilla + : "\250" diaeresis +# Accented Alphabet + : "\300" Agrave + : "\300" Agrave + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\340" agrave + : "\340" agrave + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\305" Cabovedot + : "\305" Cabovedot + : "\306" Ccircumflex + : "\306" Ccircumflex + : "\306" Ccircumflex + : "\306" Ccircumflex + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\345" cabovedot + : "\345" cabovedot + : "\346" ccircumflex + : "\346" ccircumflex + : "\346" ccircumflex + : "\346" ccircumflex + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\320" ETH + : "\320" ETH + : "\360" eth + : "\360" eth + : "\310" Egrave + : "\310" Egrave + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\350" egrave + : "\350" egrave + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\253" Gbreve + : "\253" Gbreve + : "\253" Gbreve + : "\253" Gbreve + : "\253" Gbreve + : "\325" Gabovedot + : "\325" Gabovedot + : "\330" Gcircumflex + : "\330" Gcircumflex + : "\330" Gcircumflex + : "\330" Gcircumflex + : "\273" gbreve + : "\273" gbreve + : "\273" gbreve + : "\273" gbreve + : "\273" gbreve + : "\365" gabovedot + : "\365" gabovedot + : "\370" gcircumflex + : "\370" gcircumflex + : "\370" gcircumflex + : "\370" gcircumflex + : "\241" Hstroke + : "\241" Hstroke + : "\246" Hcircumflex + : "\246" Hcircumflex + : "\246" Hcircumflex + : "\246" Hcircumflex + : "\261" hstroke + : "\261" hstroke + : "\266" hcircumflex + : "\266" hcircumflex + : "\266" hcircumflex + : "\266" hcircumflex + : "\251" Iabovedot + : "\251" Iabovedot + : "\314" Igrave + : "\314" Igrave + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\271" idotless + : "\271" idotless + : "\354" igrave + : "\354" igrave + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\254" Jcircumflex + : "\254" Jcircumflex + : "\254" Jcircumflex + : "\254" Jcircumflex + : "\274" jcircumflex + : "\274" jcircumflex + : "\274" jcircumflex + : "\274" jcircumflex + : "\322" Ograve + : "\322" Ograve + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\362" ograve + : "\362" ograve + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\252" Scedilla + : "\252" Scedilla + : "\252" Scedilla + : "\272" scedilla + : "\252" Scedilla + : "\272" scedilla + : "\272" scedilla + : "\272" scedilla + : "\336" Scircumflex + : "\336" Scircumflex + : "\336" Scircumflex + : "\336" Scircumflex + : "\376" scircumflex + : "\376" scircumflex + : "\376" scircumflex + : "\376" scircumflex + : "\331" Ugrave + : "\331" Ugrave + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\335" Ubreve + : "\335" Ubreve + : "\335" Ubreve + : "\335" Ubreve + : "\335" Ubreve + : "\371" ugrave + : "\371" ugrave + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\375" ubreve + : "\375" ubreve + : "\375" ubreve + : "\375" ubreve + : "\375" ubreve + : "\337" ssharp + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\257" Zabovedot + : "\257" Zabovedot + : "\277" zabovedot + : "\277" zabovedot +# +# dead key accent keysyms +# Special Character + : "|" bar + : "`" grave + : "'" apostrophe + : "\250" diaeresis + : "^" asciicircum + : "~" asciitilde + <0> : "\260" degree + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + : "\267" periodcentered + : "\254" notsign + : "\257" macron + : "\257" macron + : "\264" acute + : "\270" cedilla + : "\250" diaeresis +# Accented Alphabet + : "\305" Aring + : "\345" aring + : "\300" Agrave + : "\301" Aacute + : "\302" Acircumflex + : "\303" Atilde + : "\304" Adiaeresis + : "\340" agrave + : "\341" aacute + : "\342" acircumflex + : "\343" atilde + : "\344" adiaeresis + : "\307" Ccedilla + : "\306" Ccircumflex + : "\305" Cabovedot + : "\347" ccedilla + : "\346" ccircumflex + : "\345" cabovedot + : "\310" Egrave + : "\311" Eacute + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\350" egrave + : "\351" eacute + : "\352" ecircumflex + : "\353" ediaeresis + : "\253" Gbreve + : "\330" Gcircumflex + : "\273" gbreve + : "\370" gcircumflex + : "\246" Hcircumflex + : "\266" hcircumflex + : "\314" Igrave + : "\315" Iacute + : "\316" Icircumflex + : "\317" Idiaeresis + : "\251" Iabovedot + : "\354" igrave + : "\355" iacute + : "\356" icircumflex + : "\357" idiaeresis + : "\271" idotless + : "\254" Jcircumflex + : "\274" jcircumflex + : "\321" Ntilde + : "\361" ntilde + : "\322" Ograve + : "\323" Oacute + : "\324" Ocircumflex + : "\325" Otilde + : "\326" Odiaeresis + : "\362" ograve + : "\363" oacute + : "\364" ocircumflex + : "\365" otilde + : "\366" odiaeresis + : "\246" Scaron + : "\252" Scedilla + : "\336" Scircumflex + : "\250" scaron + : "\272" scedilla + : "\376" scircumflex + : "\335" Ubreve + : "\331" Ugrave + : "\332" Uacute + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\375" ubreve + : "\371" ugrave + : "\372" uacute + : "\373" ucircumflex + : "\374" udiaeresis + : "\335" Yacute + : "\276" Ydiaeresis + : "\375" yacute + : "\377" ydiaeresis + : "\264" Zcaron + : "\257" Zabovedot + : "\270" zcaron + : "\277" zabovedot +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-3/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-3/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..1f39eba731aead2937a1eacccf3ff2ba82262f34 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-3/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-3 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-3/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-3/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..084570b6ae1974e3c6381e99b90d8f313e9467fa --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-3/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-3. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-3:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-3:GR + } + font { + primary ISO8859-3:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-3 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-3:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-3:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-4/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-4/Compose new file mode 100644 index 0000000000000000000000000000000000000000..dfa770926706a3ce433ebb3271aa8c50eb887f6d --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-4/Compose @@ -0,0 +1,372 @@ +# +# ISO 8859-4 (Latin4) Compose Sequence +# +# Sequence Definition +# +# Means +# Special Character +# Right-hand side (Accented Alphabet) +# These compose sequences are pure supposition on my part. +# It would be nice to know what the real cultural conventions +# are for compose sequences. + : "\241" Aogonek + : "\241" Aogonek + : "\242" kra + : "\243" Rcedilla + : "\243" Rcedilla + : "\243" Rcedilla + : "\243" Rcedilla + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + <0> : "\244" currency + : "\245" Itilde + : "\245" Itilde + : "\246" Lcedilla + : "\246" Lcedilla + : "\246" Lcedilla + : "\246" Lcedilla + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\250" diaeresis + : "\251" Scaron + : "\251" Scaron + : "\252" Emacron + : "\252" Emacron + : "\252" Emacron + : "\252" Emacron + : "\253" Gcedilla + : "\253" Gcedilla + : "\253" Gcedilla + : "\253" Gcedilla + : "\254" Tstroke + : "\254" Tstroke + : "\254" Tstroke + : "\255" hyphen + : "\256" Zcaron + : "\256" Zcaron + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + <0> : "\260" degree + <0> : "\260" degree + : "\261" aogonek + : "\261" aogonek + : "\263" rcedilla + : "\263" rcedilla + : "\263" rcedilla + : "\263" rcedilla + : "\264" acute + : "\265" itilde + : "\265" itilde + : "\266" lcedilla + : "\266" lcedilla + : "\266" lcedilla + : "\266" lcedilla + : "\267" caron + : "\270" cedilla + : "\271" scaron + : "\271" scaron + : "\272" emacron + : "\272" emacron + : "\272" emacron + : "\272" emacron + : "\273" gcedilla + : "\273" gcedilla + : "\273" gcedilla + : "\273" gcedilla + : "\274" tstroke + : "\274" tstroke + : "\274" tstroke + : "\275" ENG + : "\276" zcaron + : "\276" zcaron + : "\277" eng + : "\300" Amacron + : "\300" Amacron + : "\300" Amacron + : "\300" Amacron + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\303" Atilde + : "\303" Atilde + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\305" Aring + : "\305" Aring + : "\306" AE + : "\307" Iogonek + : "\307" Iogonek + : "\310" Ccaron + : "\310" Ccaron + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\312" Eogonek + : "\312" Eogonek + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\314" Eabovedot + : "\314" Eabovedot + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\317" Imacron + : "\317" Imacron + : "\317" Imacron + : "\317" Imacron + : "\320" Dstroke + : "\320" Dstroke + : "\321" Ncedilla + : "\321" Ncedilla + : "\321" Ncedilla + : "\321" Ncedilla + : "\322" Omacron + : "\322" Omacron + : "\322" Omacron + : "\322" Omacron + : "\323" Kcedilla + : "\323" Kcedilla + : "\323" Kcedilla + : "\323" Kcedilla + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\325" Otilde + : "\325" Otilde + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\327" multiply + : "\330" Ooblique + : "\330" Ooblique + : "\331" Uogonek + : "\331" Uogonek + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\335" Utilde + : "\335" Utilde + : "\336" Umacron + : "\336" Umacron + : "\336" Umacron + : "\336" Umacron + : "\337" ssharp + : "\340" amacron + : "\340" amacron + : "\340" amacron + : "\340" amacron + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\343" atilde + : "\343" atilde + : "\344" adiaeresis + : "\344" adiaeresis + : "\345" aring + : "\345" aring + : "\346" ae + : "\347" iogonek + : "\347" iogonek + : "\350" ccaron + : "\350" ccaron + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\352" eogonek + : "\352" eogonek + : "\353" ediaeresis + : "\353" ediaeresis + : "\354" eabovedot + : "\354" eabovedot + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\357" imacron + : "\357" imacron + : "\357" imacron + : "\357" imacron + : "\360" dstroke + : "\360" dstroke + : "\361" ncedilla + : "\361" ncedilla + : "\361" ncedilla + : "\361" ncedilla + : "\362" omacron + : "\362" omacron + : "\362" omacron + : "\362" omacron + : "\363" kcedilla + : "\363" kcedilla + : "\363" kcedilla + : "\363" kcedilla + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\365" otilde + : "\365" otilde + : "\366" odiaeresis + : "\366" odiaeresis + : "\367" division + : "\367" division + : "\370" ooblique + : "\370" ooblique + : "\371" uogonek + : "\371" uogonek + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\374" udiaeresis + : "\374" udiaeresis + : "\375" utilde + : "\375" utilde + : "\376" umacron + : "\376" umacron + : "\376" umacron + : "\376" umacron + : "\377" abovedot + : "\314" Eabovedot + : "\354" eabovedot + : "\377" abovedot + : "\377" abovedot + : "\305" Aring + : "\345" aring + : "\264" acute + : "\264" acute + : "\301" Aacute + : "\311" Eacute + : "\315" Iacute + : "\332" Uacute + : "\341" aacute + : "\351" eacute + : "\355" iacute + : "\372" uacute + : "\251" Scaron + : "\256" Zcaron + : "\267" caron + : "\267" caron + : "\271" scaron + : "\276" zcaron + : "\310" Ccaron + : "\350" ccaron + : "\243" Rcedilla + : "\246" Lcedilla + : "\253" Gcedilla + : "\263" rcedilla + : "\266" lcedilla + : "\270" cedilla + : "\270" cedilla + : "\273" gcedilla + : "\321" Ncedilla + : "\323" Kcedilla + : "\361" ncedilla + : "\363" kcedilla + : "\302" Acircumflex + : "\316" Icircumflex + : "\324" Ocircumflex + : "\333" Ucircumflex + : "\342" acircumflex + : "\356" icircumflex + : "\364" ocircumflex + : "\373" ucircumflex + : "\250" diaeresis + : "\250" diaeresis + : "\304" Adiaeresis + : "\313" Ediaeresis + : "\326" Odiaeresis + : "\334" Udiaeresis + : "\344" adiaeresis + : "\353" ediaeresis + : "\366" odiaeresis + : "\374" udiaeresis + : "\252" Emacron + : "\257" macron + : "\257" macron + : "\272" emacron + : "\300" Amacron + : "\317" Imacron + : "\322" Omacron + : "\336" Umacron + : "\340" amacron + : "\357" imacron + : "\362" omacron + : "\376" umacron + : "\241" Aogonek + : "\261" aogonek + : "\262" ogonek + : "\262" ogonek + : "\307" Iogonek + : "\312" Eogonek + : "\331" Uogonek + : "\347" iogonek + : "\352" eogonek + : "\371" uogonek + : "\260" ring + : "\260" ring + : "\245" Itilde + : "\265" itilde + : "\303" Atilde + : "\325" Otilde + : "\335" Utilde + : "\343" atilde + : "\365" otilde + : "\375" utilde + : "~" asciitilde + : "~" asciitilde +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-4/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-4/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..7404dab998daeafec08f236c397829f4ccc57afc --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-4/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-4 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-4/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-4/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..27b595159977b63cff3d09ff5b8d51558bac82eb --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-4/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-4. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-4:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-4:GR + } + font { + primary ISO8859-4:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-4 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-4:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-4:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-5/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-5/Compose new file mode 100644 index 0000000000000000000000000000000000000000..6c304c93766c16b71f1b8e3a5c3740e24cd7e26f --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-5/Compose @@ -0,0 +1,13 @@ +# +# ISO 8859-5 Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-5/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-5/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..f20902a61fa1161c0cfd9d131b84e96a81d6b858 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-5/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for euro locales +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/xiiimp _XimpLocalOpenIM # XIM_open +XOM common/xomGeneric _XomGenericOpenOM # XOM_open + diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-5/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-5/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..df53a60800e5430dff718e5124ac03ff340337d0 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-5/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-5. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-5:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-5:GR + } + font { + primary ISO8859-5:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-5 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-5:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-5:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-6/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-6/Compose new file mode 100644 index 0000000000000000000000000000000000000000..c9d4aef375b6ad16b5cb1b61b48082f30773d8db --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-6/Compose @@ -0,0 +1,13 @@ +# +# ISO 8859-6 Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-6/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-6/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..ab2d300767286db745366fe4ce6776c64b4f226f --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-6/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-6 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-6/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-6/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..d009a13ea161712313bf339f93129641c40eaa40 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-6/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-6. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-6:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-6:GR + } + font { + primary ISO8859-6:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-6 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-6:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-6:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-7/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-7/Compose new file mode 100644 index 0000000000000000000000000000000000000000..c003ab954d276856b8882101642b6f4312f253b0 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-7/Compose @@ -0,0 +1,213 @@ +# +# ISO 8859-7 (Greek) Compose Sequence +# +# +# +# Sequence Definition +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "@" at + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + : "\251" copyright + : "\253" guillemotleft + : "\273" guillemotright + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + : "\261" plusminus + : "\261" plusminus + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + : "\267" periodcentered + : "\267" periodcentered + : "\267" periodcentered + <1> <2> : "\275" onehalf + : "\240" nobreakspace + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\246" brokenbar + : "\254" notsign + : "\254" notsign + : "\255" hyphen +# should be Greek tonos but not defined in X11 + : "\264" acute +# should be Greek dialytika but not defined in X11 + : "\250" diaeresis +# special characters that don't exist in Latin-1 + : "\241" leftsinglequotemark + : "\241" leftsinglequotemark + : "\242" rightsinglequotemark + : "\242" rightsinglequotemark + : "\257" Greek_horizbar +# Accented Alphabet + : "\266" Greek_ALPHAaccent + : "\266" Greek_ALPHAaccent + : "\270" Greek_EPSILONaccent + : "\270" Greek_EPSILONaccent + : "\271" Greek_ETAaccent + : "\271" Greek_ETAaccent + : "\272" Greek_IOTAaccent + : "\272" Greek_IOTAaccent + : "\274" Greek_OMICRONaccent + : "\274" Greek_OMICRONaccent + : "\276" Greek_UPSILONaccent + : "\276" Greek_UPSILONaccent + : "\277" Greek_OMEGAaccent + : "\277" Greek_OMEGAaccent + : "\332" Greek_IOTAdieresis + : "\332" Greek_IOTAdieresis + : "\333" Greek_UPSILONdieresis + : "\333" Greek_UPSILONdieresis + : "\334" Greek_alphaaccent + : "\334" Greek_alphaaccent + : "\335" Greek_epsilonaccent + : "\335" Greek_epsilonaccent + : "\336" Greek_etaaccent + : "\336" Greek_etaaccent + : "\337" Greek_iotaaccent + : "\337" Greek_iotaaccent + : "\374" Greek_omicronaccent + : "\374" Greek_omicronaccent + : "\375" Greek_upsilonaccent + : "\375" Greek_upsilonaccent + : "\376" Greek_omegaaccent + : "\376" Greek_omegaaccent + : "\372" Greek_iotadieresis + : "\372" Greek_iotadieresis + : "\373" Greek_upsilondieresis + : "\373" Greek_upsilondieresis + : "\300" Greek_iotaaccentdieresis + : "\300" Greek_iotaaccentdieresis + : "\340" Greek_upsilonaccentdieresis + : "\340" Greek_upsilonaccentdieresis + : "\265" Greek_accentdieresis + : "\265" Greek_accentdieresis +# +# +# dead key accent keysyms +# Special Character + : "|" bar + : "`" grave + : "\250" diaeresis + : "^" asciicircum + : "~" asciitilde + : "\"" quotedbl + : "\260" degree + : "\260" degree + <0> : "\260" degree + <2> : "\262" twosuperior + <3> : "\263" threesuperior + : "\267" periodcentered + : "\246" brokenbar + : "\254" notsign + : "\264" acute + : "\250" diaeresis +# Accented Alphabet (plus some more symbols) + : "\334" Greek_alphaaccent + : "\335" Greek_epsilonaccent + : "\336" Greek_etaaccent + : "\337" Greek_iotaaccent + : "\374" Greek_omicronaccent + : "\375" Greek_upsilonaccent + : "\376" Greek_omegaaccent + : "\266" Greek_ALPHAaccent + : "\270" Greek_EPSILONaccent + : "\271" Greek_ETAaccent + : "\272" Greek_IOTAaccent + : "\274" Greek_OMICRONaccent + : "\276" Greek_UPSILONaccent + : "\277" Greek_OMEGAaccent + : "\264" acute + : "\264" acute + : "\267" periodcentered + : "\253" guillemotleft + : "\273" guillemotright + : "\372" Greek_iotadieresis + : "\373" Greek_upsilondieresis + : "\332" Greek_IOTAdieresis + : "\333" Greek_UPSILONdieresis + : "\250" diaeresis + : "\267" periodcentered + : "\253" guillemotleft + : "\273" guillemotright + : "\300" Greek_iotaaccentdieresis + : "\340" Greek_upsilonaccentdieresis + : "\265" Greek_accentdieresis + : "\300" Greek_iotaaccentdieresis + : "\340" Greek_upsilonaccentdieresis + : "\265" Greek_accentdieresis diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-7/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-7/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..f20902a61fa1161c0cfd9d131b84e96a81d6b858 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-7/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for euro locales +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/xiiimp _XimpLocalOpenIM # XIM_open +XOM common/xomGeneric _XomGenericOpenOM # XOM_open + diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-7/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-7/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..b4a3792fa1746ce8beaa6e4cea501740a50b0941 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-7/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-7. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-7:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-7:GR + } + font { + primary ISO8859-7:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-7 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-7:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-7:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-8/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..6c6c43ed67035df282d8f380b2b9feae567ec1a6 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-8/Compose @@ -0,0 +1,13 @@ +# +# ISO 8859-8 Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..e85b513b30e5f71a7491e5e782326216833506c6 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-8/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-8 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..b24f678a23bb982fda7112e17a7b0032b9d47be3 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-8/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-8. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-8:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-8:GR + } + font { + primary ISO8859-8:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-8 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-8:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-8:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-9/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-9/Compose new file mode 100644 index 0000000000000000000000000000000000000000..deb184183e8c8e39111f472f13ecf48b5151c34b --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-9/Compose @@ -0,0 +1,481 @@ +# +# ISO 8859-9 (Latin5) Compose Sequence +# +# Sequence Definition +# +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\241" exclamdown + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + : "\251" copyright + : "\252" ordfeminine + : "\252" ordfeminine + : "\252" ordfeminine + : "\252" ordfeminine + : "\272" masculine + : "\272" masculine + : "\272" masculine + : "\272" masculine + : "\253" guillemotleft + : "\273" guillemotright + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + : "\261" plusminus + : "\261" plusminus + : "\265" mu + : "\265" mu + : "\265" mu + : "\265" mu + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph + : "\267" periodcentered + : "\267" periodcentered + : "\267" periodcentered + : "\277" questiondown + : "\240" nobreakspace + : "\254" notsign + : "\254" notsign + : "\255" hyphen + : "\256" registered + : "\256" registered + : "\256" registered + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\367" division + : "\367" division + : "\327" multiply + : "\264" acute + : "\270" cedilla + : "\250" diaeresis +# Accented Alphabet + : "\300" Agrave + : "\300" Agrave + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\305" Aring + : "\305" Aring + : "\305" Aring + : "\306" AE + : "\340" agrave + : "\340" agrave + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\345" aring + : "\345" aring + : "\345" aring + : "\346" ae + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\320" ETH + : "\320" ETH + : "\360" eth + : "\360" eth + : "\310" Egrave + : "\310" Egrave + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\350" egrave + : "\350" egrave + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\320" Gbreve + : "\320" Gbreve + : "\320" Gbreve + : "\320" Gbreve + : "\320" Gbreve + : "\360" gbreve + : "\360" gbreve + : "\360" gbreve + : "\360" gbreve + : "\360" gbreve + : "\314" Igrave + : "\314" Igrave + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\335" Iabovedot + : "\335" Iabovedot + : "\354" igrave + : "\354" igrave + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\375" idotless + : "\375" idotless + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\322" Ograve + : "\322" Ograve + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\330" Ooblique + : "\330" Ooblique + : "\274" OE + : "\362" ograve + : "\362" ograve + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\370" oslash + : "\370" oslash + : "\336" Scedilla + : "\336" Scedilla + : "\336" Scedilla + : "\376" scedilla + : "\336" Scedilla + : "\376" scedilla + : "\376" scedilla + : "\376" scedilla + : "\331" Ugrave + : "\331" Ugrave + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\371" ugrave + : "\371" ugrave + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\337" ssharp + : "\336" THORN + : "\376" thorn + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\335" Yacute + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\375" yacute + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\264" Zcaron + : "\264" Zcaron + : "\270" zcaron + : "\270" zcaron + : "\264" Zcaron + : "\270" zcaron +# +# dead key accent keysyms +# Special Character + : "|" bar + : "`" grave + : "'" apostrophe + : "\250" diaeresis + : "^" asciicircum + : "~" asciitilde + <0> : "\260" degree + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + : "\267" periodcentered + : "\254" notsign + : "\257" macron + : "\257" macron + : "\264" acute + : "\270" cedilla + : "\250" diaeresis +# Accented Alphabet + : "\305" Aring + : "\345" aring + : "\300" Agrave + : "\301" Aacute + : "\302" Acircumflex + : "\303" Atilde + : "\304" Adiaeresis + : "\340" agrave + : "\341" aacute + : "\342" acircumflex + : "\343" atilde + : "\344" adiaeresis + : "\307" Ccedilla + : "\347" ccedilla + : "\310" Egrave + : "\311" Eacute + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\350" egrave + : "\351" eacute + : "\352" ecircumflex + : "\353" ediaeresis + : "\320" Gbreve + : "\360" gbreve + : "\335" Iabovedot + : "\314" Igrave + : "\315" Iacute + : "\316" Icircumflex + : "\317" Idiaeresis + : "\375" idotless + : "\354" igrave + : "\355" iacute + : "\356" icircumflex + : "\357" idiaeresis + : "\321" Ntilde + : "\361" ntilde + : "\322" Ograve + : "\323" Oacute + : "\324" Ocircumflex + : "\325" Otilde + : "\326" Odiaeresis + : "\362" ograve + : "\363" oacute + : "\364" ocircumflex + : "\365" otilde + : "\366" odiaeresis + : "\246" Scaron + : "\250" scaron + : "\336" Scedilla + : "\376" scedilla + : "\331" Ugrave + : "\332" Uacute + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\371" ugrave + : "\372" uacute + : "\373" ucircumflex + : "\374" udiaeresis + : "\335" Yacute + : "\276" Ydiaeresis + : "\375" yacute + : "\377" ydiaeresis + : "\264" Zcaron + : "\270" zcaron +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-9/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-9/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..f20902a61fa1161c0cfd9d131b84e96a81d6b858 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-9/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for euro locales +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/xiiimp _XimpLocalOpenIM # XIM_open +XOM common/xomGeneric _XomGenericOpenOM # XOM_open + diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-9/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-9/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..8c72631b053ab9203768941507d19a385442ced4 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-9/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for iso8859-9. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-9:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-9:GR + } + font { + primary ISO8859-9:GR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-9 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-9:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-9:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/Compose b/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/Compose new file mode 100644 index 0000000000000000000000000000000000000000..ee6484478850654969bda00e5cdc8ae091fb40a3 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/Compose @@ -0,0 +1,493 @@ +# +# ISO 8859-9e (Latin??) Compose Sequence +# +# Sequence Definition +# +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\241" exclamdown + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\242" cent + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\243" sterling + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\244" EuroSign + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\245" yen + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + <0> : "\247" section + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + <0> : "\251" copyright + : "\251" copyright + : "\252" ordfeminine + : "\252" ordfeminine + : "\252" ordfeminine + : "\252" ordfeminine + : "\272" masculine + : "\272" masculine + : "\272" masculine + : "\272" masculine + : "\253" guillemotleft + : "\273" guillemotright + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + <0> : "\260" degree + : "\261" plusminus + : "\261" plusminus + : "\265" mu + : "\265" mu + : "\265" mu + : "\265" mu + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior + <3> : "\263" threesuperior +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph +

: "\266" paragraph + : "\267" periodcentered + : "\267" periodcentered + : "\267" periodcentered + : "\277" questiondown + : "\240" nobreakspace + : "\254" notsign + : "\254" notsign + : "\255" hyphen + : "\256" registered + : "\256" registered + : "\256" registered + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\257" macron + : "\367" division + : "\367" division + : "\327" multiply + : "\264" acute + : "\270" cedilla + : "\250" diaeresis +# Accented Alphabet + : "\300" Agrave + : "\300" Agrave + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\301" Aacute + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\302" Acircumflex + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\303" Atilde + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\304" Adiaeresis + : "\305" Aring + : "\305" Aring + : "\305" Aring + : "\306" SCHWA + : "\340" agrave + : "\340" agrave + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\341" aacute + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\342" acircumflex + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\343" atilde + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\344" adiaeresis + : "\345" aring + : "\345" aring + : "\345" aring + : "\346" schwa + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\307" Ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\347" ccedilla + : "\320" ETH + : "\320" ETH + : "\360" eth + : "\360" eth + : "\310" Egrave + : "\310" Egrave + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\311" Eacute + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\313" Ediaeresis + : "\350" egrave + : "\350" egrave + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\351" eacute + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\352" ecircumflex + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\353" ediaeresis + : "\320" Gbreve + : "\320" Gbreve + : "\320" Gbreve + : "\320" Gbreve + : "\320" Gbreve + : "\360" gbreve + : "\360" gbreve + : "\360" gbreve + : "\360" gbreve + : "\360" gbreve + : "\314" Igrave + : "\314" Igrave + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\315" Iacute + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\316" Icircumflex + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\317" Idiaeresis + : "\335" Iabovedot + : "\335" Iabovedot + : "\354" igrave + : "\354" igrave + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\355" iacute + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\356" icircumflex + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\357" idiaeresis + : "\375" idotless + : "\375" idotless + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\321" Ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\361" ntilde + : "\322" Ograve + : "\322" Ograve + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\323" Oacute + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\324" Ocircumflex + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\325" Otilde + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\326" Odiaeresis + : "\330" Ooblique + : "\330" Ooblique + : "\274" OE + : "\362" ograve + : "\362" ograve + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\363" oacute + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\364" ocircumflex + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\365" otilde + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\366" odiaeresis + : "\370" oslash + : "\370" oslash + : "\336" Scedilla + : "\336" Scedilla + : "\336" Scedilla + : "\376" scedilla + : "\336" Scedilla + : "\376" scedilla + : "\376" scedilla + : "\376" scedilla + : "\331" Ugrave + : "\331" Ugrave + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\332" Uacute + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\334" Udiaeresis + : "\371" ugrave + : "\371" ugrave + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\372" uacute + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\373" ucircumflex + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\374" udiaeresis + : "\337" ssharp + : "\336" THORN + : "\376" thorn + : "\327" Yacute + : "\327" Yacute + : "\327" Yacute + : "\327" Yacute + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\276" Ydiaeresis + : "\367" yacute + : "\367" yacute + : "\367" yacute + : "\367" yacute + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\377" ydiaeresis + : "\241" Zcaron + : "\241" Zcaron + : "\261" zcaron + : "\261" zcaron + : "\241" Zcaron + : "\261" zcaron + : "\252" Gcaron + : "\252" Gcaron + : "\272" gcaron + : "\272" gcaron + : "\252" Gcaron + : "\272" gcaron + : "\264" Ocaron + : "\264" Ocaron + : "\275" ocaron + : "\275" ocaron + : "\264" Ocaron + : "\275" ocaron +# +# dead key accent keysyms +# Special Character + : "|" bar + : "`" grave + : "'" apostrophe + : "\250" diaeresis + : "^" asciicircum + : "~" asciitilde + <0> : "\260" degree + <1> : "\271" onesuperior + <2> : "\262" twosuperior + <3> : "\263" threesuperior + : "\267" periodcentered + : "\254" notsign + : "\257" macron + : "\257" macron + : "\264" acute + : "\270" cedilla + : "\250" diaeresis +# Accented Alphabet + : "\305" Aring + : "\345" aring + : "\300" Agrave + : "\301" Aacute + : "\302" Acircumflex + : "\303" Atilde + : "\304" Adiaeresis + : "\340" agrave + : "\341" aacute + : "\342" acircumflex + : "\343" atilde + : "\344" adiaeresis + : "\307" Ccedilla + : "\347" ccedilla + : "\310" Egrave + : "\311" Eacute + : "\312" Ecircumflex + : "\313" Ediaeresis + : "\350" egrave + : "\351" eacute + : "\352" ecircumflex + : "\353" ediaeresis + : "\320" Gbreve + : "\360" gbreve + : "\335" Iabovedot + : "\314" Igrave + : "\315" Iacute + : "\316" Icircumflex + : "\317" Idiaeresis + : "\375" idotless + : "\354" igrave + : "\355" iacute + : "\356" icircumflex + : "\357" idiaeresis + : "\321" Ntilde + : "\361" ntilde + : "\322" Ograve + : "\323" Oacute + : "\324" Ocircumflex + : "\325" Otilde + : "\326" Odiaeresis + : "\362" ograve + : "\363" oacute + : "\364" ocircumflex + : "\365" otilde + : "\366" odiaeresis + : "\336" Scedilla + : "\376" scedilla + : "\331" Ugrave + : "\332" Uacute + : "\333" Ucircumflex + : "\334" Udiaeresis + : "\371" ugrave + : "\372" uacute + : "\373" ucircumflex + : "\374" udiaeresis + : "\327" Yacute + : "\276" Ydiaeresis + : "\367" yacute + : "\377" ydiaeresis + : "\241" Zcaron + : "\261" zcaron + : "\252" Gcaron + : "\272" gcaron +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..a0d710b6b01cf7ced4cd961a9ef26e9225954c59 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for iso8859-9e locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..dc511270bff00785d582a95f4f2b885a399612a9 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/iso8859-9e/XLC_LOCALE @@ -0,0 +1,65 @@ +# XLocale Database Sample for iso8859-9e. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-9E:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name ISO8859-9E:GR + } + font { + primary ISO8859-9E:GR + } +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name ISO8859-9E + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ISO8859-9E +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-9E:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-9E:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/ja.JIS/Compose b/miniconda3/envs/ladir/share/X11/locale/ja.JIS/Compose new file mode 100644 index 0000000000000000000000000000000000000000..8796e864e8a827a588419e86e70be7de026568f3 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja.JIS/Compose @@ -0,0 +1,13 @@ +# +# ja.JIS Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/ja.JIS/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/ja.JIS/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..0cf97ee81c48ccc70631bcc14b0215c34e0f8c47 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja.JIS/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for ja.JIS locale +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/ja.JIS/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/ja.JIS/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..cbccfea1c6de9dd613293235c8738f81c850e079 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja.JIS/XLC_LOCALE @@ -0,0 +1,97 @@ +# +# XLocale Database Sample for ja_JP.jis +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + substitute JISX0201.1976-0:GL + vertical_rotate all + } +} +# fs1 class (Kanji) +fs1 { + charset { + name JISX0208.1983-0:GL + } + font { + primary JISX0208.1983-0:GL + substitute JISX0208.1990-0:GL + } +} +# fs2 class (Half Kana) +fs2 { + charset { + name JISX0201.1976-0:GR + } + font { + primary JISX0201.1976-0:GR + substitute JISX0201.1976-0:GR + vertical_rotate all + } +} +# fs3 class (Supplementary Kanji) +# fs3 { +# charset { +# name JISX0212.1990-0:GL +# } +# font { +# primary JISX0212.1990-0:GL +# } +# } +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ja.jis +mb_cur_max 5 +state_depend_encoding True +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + mb_encoding \x1b \x28 \x4a; \x1b \x28 \x42 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL; JISX0201.1976-0:GL +} +# cs1 class +cs1 { + side GL + length 2 + mb_encoding \x1b \x24 \x42; \x1b \x24 \x40 + wc_encoding \x30000000 + ct_encoding JISX0208.1983-0:GL; JISX0208.1983-0:GR; JISX0208.1983-1:GL; JISX0208.1983-1:GR +} +# cs2 class +cs2 { + side GL + length 1 + mb_encoding \x1b \x28 \x49 + wc_encoding \x10000000 + ct_encoding JISX0201.1976-0:GR +} +# cs3 class +# cs3 { +# side GL +# length 2 +# mb_encoding \x1b \x24 \x28 \x44 +# #if 1 +# wc_encoding \x20000000 +# #else +# wc_encoding \x00008000 +# #endif +# ct_encoding JISX0212.1990-0:GL; JISX0212.1990-0:GR +# } +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/Compose b/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/Compose new file mode 100644 index 0000000000000000000000000000000000000000..c071b1f948c045c54dfb27ad6a2075ad5fd81265 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/Compose @@ -0,0 +1,13 @@ +# +# ja.SJIS Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..29dffff7e1e92cd52643c2d2019cff7569c695b5 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/XI18N_OBJS @@ -0,0 +1,10 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for ja locale +# +XLC ja_JP.PCK/xlibi18n_PCK _XlcGenericLoader # XLC_open +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximp40 _Ximp_OpenIM # XIM_open +XIM common/ximlocal _XimpLocalOpenIM # XIM_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_regiser XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..6acbbeabdcbcfe1f83eda0ef1dcdfc807c753d7b --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja.SJIS/XLC_LOCALE @@ -0,0 +1,96 @@ +# +# XLocale Database Sample for ja_JP.sjis +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + substitute JISX0201.1976-0:GL + vertical_rotate all + } +} +# fs1 class (Kanji) +fs1 { + charset { + name JISX0208.1983-0:GL + } + font { + primary JISX0208.1983-0:GL + substitute JISX0208.1990-0:GL + } +} +# fs2 class (Half Kana) +fs2 { + charset { + name JISX0201.1976-0:GR + } + font { + primary JISX0201.1976-0:GR + substitute JISX0201.1976-0:GR + vertical_rotate all + } +} +# fs3 class (Supplementary Kanji) +# fs3 { +# charset { +# name JISX0212.1990-0:GL +# } +# font { +# primary JISX0212.1990-0:GL +# } +# } +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ja.sjis +mb_cur_max 2 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL; JISX0201.1976-0:GL +} +# cs1 class +cs1 { + side none + length 2 + byte1 \x81,\x9f;\xe0,\xef + byte2 \x40,\x7e;\x80,\xfc + wc_encoding \x30000000 + ct_encoding JISX0208.1983-0:GL; JISX0208.1983-0:GR; JISX0208.1983-1:GL; JISX0208.1983-1:GR + mb_conversion [\x8140,\x817e]->\x2121,[\x8180,\x819e]->\x2160,[\x819f,\x81fc]->\x2221, [\x8240,\x827e]->\x2321,[\x8280,\x829e]->\x2360,[\x829f,\x82fc]->\x2421, [\x8340,\x837e]->\x2521,[\x8380,\x839e]->\x2560,[\x839f,\x83fc]->\x2621, [\x8440,\x847e]->\x2721,[\x8480,\x849e]->\x2760,[\x849f,\x84fc]->\x2821, [\x8540,\x857e]->\x2921,[\x8580,\x859e]->\x2960,[\x859f,\x85fc]->\x2a21, [\x8640,\x867e]->\x2b21,[\x8680,\x869e]->\x2b60,[\x869f,\x86fc]->\x2c21, [\x8740,\x877e]->\x2d21,[\x8780,\x879e]->\x2d60,[\x879f,\x87fc]->\x2e21, [\x8840,\x887e]->\x2f21,[\x8880,\x889e]->\x2f60,[\x889f,\x88fc]->\x3021, [\x8940,\x897e]->\x3121,[\x8980,\x899e]->\x3160,[\x899f,\x89fc]->\x3221, [\x8a40,\x8a7e]->\x3321,[\x8a80,\x8a9e]->\x3360,[\x8a9f,\x8afc]->\x3421, [\x8b40,\x8b7e]->\x3521,[\x8b80,\x8b9e]->\x3560,[\x8b9f,\x8bfc]->\x3621, [\x8c40,\x8c7e]->\x3721,[\x8c80,\x8c9e]->\x3760,[\x8c9f,\x8cfc]->\x3821, [\x8d40,\x8d7e]->\x3921,[\x8d80,\x8d9e]->\x3960,[\x8d9f,\x8dfc]->\x3a21, [\x8e40,\x8e7e]->\x3b21,[\x8e80,\x8e9e]->\x3b60,[\x8e9f,\x8efc]->\x3c21, [\x8f40,\x8f7e]->\x3d21,[\x8f80,\x8f9e]->\x3d60,[\x8f9f,\x8ffc]->\x3e21, [\x9040,\x907e]->\x3f21,[\x9080,\x909e]->\x3f60,[\x909f,\x90fc]->\x4021, [\x9140,\x917e]->\x4121,[\x9180,\x919e]->\x4160,[\x919f,\x91fc]->\x4221, [\x9240,\x927e]->\x4321,[\x9280,\x929e]->\x4360,[\x929f,\x92fc]->\x4421, [\x9340,\x937e]->\x4521,[\x9380,\x939e]->\x4560,[\x939f,\x93fc]->\x4621, [\x9440,\x947e]->\x4721,[\x9480,\x949e]->\x4760,[\x949f,\x94fc]->\x4821, [\x9540,\x957e]->\x4921,[\x9580,\x959e]->\x4960,[\x959f,\x95fc]->\x4a21, [\x9640,\x967e]->\x4b21,[\x9680,\x969e]->\x4b60,[\x969f,\x96fc]->\x4c21, [\x9740,\x977e]->\x4d21,[\x9780,\x979e]->\x4d60,[\x979f,\x97fc]->\x4e21, [\x9840,\x987e]->\x4f21,[\x9880,\x989e]->\x4f60,[\x989f,\x98fc]->\x5021, [\x9940,\x997e]->\x5121,[\x9980,\x999e]->\x5160,[\x999f,\x99fc]->\x5221, [\x9a40,\x9a7e]->\x5321,[\x9a80,\x9a9e]->\x5360,[\x9a9f,\x9afc]->\x5421, [\x9b40,\x9b7e]->\x5521,[\x9b80,\x9b9e]->\x5560,[\x9b9f,\x9bfc]->\x5621, [\x9c40,\x9c7e]->\x5721,[\x9c80,\x9c9e]->\x5760,[\x9c9f,\x9cfc]->\x5821, [\x9d40,\x9d7e]->\x5921,[\x9d80,\x9d9e]->\x5960,[\x9d9f,\x9dfc]->\x5a21, [\x9e40,\x9e7e]->\x5b21,[\x9e80,\x9e9e]->\x5b60,[\x9e9f,\x9efc]->\x5c21, [\x9f40,\x9f7e]->\x5d21,[\x9f80,\x9f9e]->\x5d60,[\x9f9f,\x9ffc]->\x5e21, [\xe040,\xe07e]->\x5f21,[\xe080,\xe09e]->\x5f60,[\xe09f,\xe0fc]->\x6021, [\xe140,\xe17e]->\x6121,[\xe180,\xe19e]->\x6160,[\xe19f,\xe1fc]->\x6221, [\xe240,\xe27e]->\x6321,[\xe280,\xe29e]->\x6360,[\xe29f,\xe2fc]->\x6421, [\xe340,\xe37e]->\x6521,[\xe380,\xe39e]->\x6560,[\xe39f,\xe3fc]->\x6621, [\xe440,\xe47e]->\x6721,[\xe480,\xe49e]->\x6760,[\xe49f,\xe4fc]->\x6821, [\xe540,\xe57e]->\x6921,[\xe580,\xe59e]->\x6960,[\xe59f,\xe5fc]->\x6a21, [\xe640,\xe67e]->\x6b21,[\xe680,\xe69e]->\x6b60,[\xe69f,\xe6fc]->\x6c21, [\xe740,\xe77e]->\x6d21,[\xe780,\xe79e]->\x6d60,[\xe79f,\xe7fc]->\x6e21, [\xe840,\xe87e]->\x6f21,[\xe880,\xe89e]->\x6f60,[\xe89f,\xe8fc]->\x7021, [\xe940,\xe97e]->\x7121,[\xe980,\xe99e]->\x7160,[\xe99f,\xe9fc]->\x7221, [\xea40,\xea7e]->\x7321,[\xea80,\xea9e]->\x7360,[\xea9f,\xeafc]->\x7421, [\xeb40,\xeb7e]->\x7521,[\xeb80,\xeb9e]->\x7560,[\xeb9f,\xebfc]->\x7621, [\xec40,\xec7e]->\x7721,[\xec80,\xec9e]->\x7760,[\xec9f,\xecfc]->\x7821, [\xed40,\xed7e]->\x7921,[\xed80,\xed9e]->\x7960,[\xed9f,\xedfc]->\x7a21, [\xee40,\xee7e]->\x7b21,[\xee80,\xee9e]->\x7b60,[\xee9f,\xeefc]->\x7c21, [\xef40,\xef7e]->\x7d21,[\xef80,\xef9e]->\x7d60,[\xef9f,\xeffc]->\x7e21 +} +# cs2 class +cs2 { + side GR + length 1 + wc_encoding \x10000000 + ct_encoding JISX0201.1976-0:GR +} +# cs3 class +# cs3 { +# side GR +# length 2 +# #if 1 +# wc_encoding \x20000000 +# #else +# wc_encoding \x00008000 +# #endif +# ct_encoding JISX0212.1990-0:GL; JISX0212.1990-0:GR +# } +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/ja/Compose b/miniconda3/envs/ladir/share/X11/locale/ja/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7abee78995a5992188e4a2aa5298c627671527d0 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja/Compose @@ -0,0 +1,13 @@ +# +# ja Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/ja/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/ja/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..50b51fecde038189c19c4b9fde9001e0764c5ce3 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja/XI18N_OBJS @@ -0,0 +1,11 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for ja locale +# +XLC ja/xlibi18n_ja _XlcGenericLoader # XLC_open +XLC common/xlibi18n _XlcGenericLoader # XLC_open +#XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_regiser XIM_unregister +XIM common/ximp40 _Ximp_OpenIM # XIM_open +XIM common/ximlocal _XimpLocalOpenIM # XIM_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_regiser XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/ja/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/ja/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..b7277a0ce9e656ad0a62147eaecf0e2957a473a1 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja/XLC_LOCALE @@ -0,0 +1,97 @@ +# +# XLocale Database Sample for ja_JP.euc +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + substitute JISX0201.1976-0:GL + vertical_rotate all + } +} +# fs1 class (Kanji) +fs1 { + charset { + name JISX0208.1983-0:GL + udc_area \x7521,\x7e7e + } + font { + primary JISX0208.1983-0:GL + substitute JISX0208.1990-0:GL + } +} +# fs2 class (Half Kana) +fs2 { + charset { + name JISX0201.1976-0:GR + } + font { + primary JISX0201.1976-0:GR + substitute JISX0201.1976-0:GR + vertical_rotate all + } +} +# fs3 class (Supplementary Kanji) +# fs3 { +# charset { +# name JISX0212.1990-0:GL +# udc_area \x7521,\x7e7e +# } +# font { +# primary JISX0212.1990-0:GL +# } +# } +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ja.euc +mb_cur_max 3 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL; JISX0201.1976-0:GL +} +# cs1 class +cs1 { + side GR:Default + length 2 + wc_encoding \x30000000 + ct_encoding JISX0208.1983-0:GL; JISX0208.1983-0:GR; JISX0208.1983-1:GL; JISX0208.1983-1:GR +} +# cs2 class +cs2 { + side GR + length 1 + mb_encoding \x8e + wc_encoding \x10000000 + ct_encoding JISX0201.1976-0:GR +} +# cs3 class +# cs3 { +# side GL +# length 2 +# mb_encoding \x8f +# #if 1 +# wc_encoding \x20000000 +# #else +# wc_encoding \x00008000 +# #endif +# ct_encoding JISX0212.1990-0:GL; JISX0212.1990-0:GR +# } +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bedb703475f40767ef29d06a356fc39c52e18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/Compose @@ -0,0 +1 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" diff --git a/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..9159b67e9bdf53749b8e5b9e0fab29507cf27303 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for ja_JP.UTF-8 locale +# +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..d2b2453bb8cd40a5a0c10a1dbc7a435c66821c19 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ja_JP.UTF-8/XLC_LOCALE @@ -0,0 +1,130 @@ +# +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# We leave the legacy encodings in for the moment, because we don't +# have that many ISO10646 fonts yet. +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class (Kanji) +fs2 { + charset { + name JISX0208.1983-0:GL + } + font { + primary JISX0208.1983-0:GL + } +} +# fs3 class (Korean Character) +fs3 { + charset { + name KSC5601.1987-0:GL + } + font { + primary KSC5601.1987-0:GL + } +} +# fs4 class (Chinese Han Character) +fs4 { + charset { + name GB2312.1980-0:GL + } + font { + primary GB2312.1980-0:GL + } +} +# fs5 class (Half Kana) +fs5 { + charset { + name JISX0201.1976-0:GR + } + font { + primary JISX0201.1976-0:GR + vertical_rotate all + } +} +# ISO10646-1 is put last to make usually better-looking +# other fonts are picked up before iso10646-1 fonts. +# Moreover, some iso10646-1 fonts don't have any glyph at all +# in ISO8859-X ranges. +# fs6 class +fs6 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 6 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} +# cs2 class +cs2 { + side GR + length 2 + ct_encoding JISX0208.1983-0:GL; JISX0208.1983-0:GR; JISX0208.1983-1:GL; JISX0208.1983-1:GR +} +# cs3 class +cs3 { + side GL + length 2 + ct_encoding KSC5601.1987-0:GL; KSC5601.1987-0:GR; KSC5601.1987-1:GL; KSC5601.1987-1:GR +} + +# cs4 class +cs4 { + side GR + length 2 + ct_encoding GB2312.1980-0:GL; GB2312.1980-0:GR +} + +# cs5 class +cs5 { + side GR + length 1 + ct_encoding JISX0201.1976-0:GR +} +# cs6 class +cs6 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/km_KH.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/km_KH.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bedb703475f40767ef29d06a356fc39c52e18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/km_KH.UTF-8/Compose @@ -0,0 +1 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" diff --git a/miniconda3/envs/ladir/share/X11/locale/km_KH.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/km_KH.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..f201bf435c8481586d7905cb7bfe3b7b9dd37fd7 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/km_KH.UTF-8/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for euro locales +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XOM common/xomLTRTTB _XomGenericOpenOM # XOM_open +XIM common/xiiimp _SwitchOpenIM # XIM_open +XIM common/xiiimp _XimpLocalOpenIM # XIM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/km_KH.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/km_KH.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/ko/Compose b/miniconda3/envs/ladir/share/X11/locale/ko/Compose new file mode 100644 index 0000000000000000000000000000000000000000..985be109f7b6f83d595e52eeca1e3760e0aecdea --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ko/Compose @@ -0,0 +1,13 @@ +# +# ko Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/ko/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/ko/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..5ee5237990876e17f3d65a3b81c9f7364cea093e --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ko/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for ko locale +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximp40 _Ximp_OpenIM # XIM_open +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/ko/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/ko/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..07bafe721c34d78bf75026e8ba62cee2993044d2 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ko/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for ko. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name KSC5601.1987-0:GL + } + font { + primary KSC5601.1987-0:GL + substitute KSC5601.1987-0:GL + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name ko.euc +mb_cur_max 2 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 2 + wc_encoding \x30000000 + ct_encoding KSC5601.1987-0:GL; KSC5601.1987-0:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bedb703475f40767ef29d06a356fc39c52e18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/Compose @@ -0,0 +1 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" diff --git a/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..96e753cb6bad553d7eb8c74851f89e8ab075ae06 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for ko_KR.UTF-8 locale +# +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..0fcc580adf40b5b10685b99dd9902099e64de229 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ko_KR.UTF-8/XLC_LOCALE @@ -0,0 +1,130 @@ +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# We leave the legacy encodings in for the moment, because we don't +# have that many ISO10646 fonts yet. +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class (Korean Character) +fs2 { + charset { + name KSC5601.1987-0:GL + } + font { + primary KSC5601.1987-0:GL + } +} +# fs3 class (Kanji) +fs3 { + charset { + name JISX0208.1983-0:GL + } + font { + primary JISX0208.1983-0:GL + } +} +# fs4 class (Chinese Han Character) +fs4 { + charset { + name GB2312.1980-0:GL + } + font { + primary GB2312.1980-0:GL + } +} +# fs5 class (Half Kana) +fs5 { + charset { + name JISX0201.1976-0:GR + } + font { + primary JISX0201.1976-0:GR + vertical_rotate all + } +} +# ISO10646-1 is put last to make usually better-looking +# other fonts are picked up before iso10646-1 fonts. +# Moreover, some iso10646-1 fonts don't have any glyph at all +# in ISO8859-X ranges. +# fs6 class +fs6 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 6 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} +# cs2 class +cs2 { + side GL + length 2 + ct_encoding KSC5601.1987-0:GL; KSC5601.1987-0:GR; KSC5601.1987-1:GL; KSC5601.1987-1:GR +} + +# cs3 class +cs3 { + side GR + length 2 + ct_encoding JISX0208.1983-0:GL; JISX0208.1983-0:GR; JISX0208.1983-1:GL; JISX0208.1983-1:GR +} + +# cs4 class +cs4 { + side GR + length 2 + ct_encoding GB2312.1980-0:GL; GB2312.1980-0:GR +} + +# cs5 class +cs5 { + side GR + length 1 + ct_encoding JISX0201.1976-0:GR +} +# cs6 class +cs6 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-c/Compose b/miniconda3/envs/ladir/share/X11/locale/koi8-c/Compose new file mode 100644 index 0000000000000000000000000000000000000000..0ac80372b3f9204260ef9accb1cf0628a69cbdcd --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-c/Compose @@ -0,0 +1,109 @@ +# +# koi8-c Compose Sequence +# +# Sequence Definition +# +# +# Means +# Special Character + : "#" numbersign + : "'" apostrophe + : "'" apostrophe + : "@" at + : "[" bracketleft + : "\\" backslash + : "\\" backslash + : "\\" backslash + : "]" bracketright + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "^" asciicircum + : "`" grave + : "`" grave + : "{" braceleft + : "{" braceleft + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "|" bar + : "}" braceright + : "}" braceright + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "~" asciitilde + : "\240" nobreakspace + : "\200" Cyrillic_ghe_bar + : "\220" Cyrillic_GHE_bar + : "\201" Cyrillic_zhe_descender + : "\221" Cyrillic_ZHE_descender + : "\202" Cyrillic_ka_descender + : "\222" Cyrillic_KA_descender + : "\203" Cyrillic_ka_vertstroke + : "\223" Cyrillic_KA_vertstroke + : "\203" Cyrillic_ka_vertstroke + : "\223" Cyrillic_KA_vertstroke + : "\204" Cyrillic_en_descender + : "\224" Cyrillic_EN_descender + : "\205" Cyrillic_u_straight + : "\225" Cyrillic_U_straight + : "\205" Cyrillic_u_straight + : "\225" Cyrillic_U_straight + : "\206" Cyrillic_u_straight_bar + : "\226" Cyrillic_U_straight_bat + : "\206" Cyrillic_u_straight_bar + : "\226" Cyrillic_U_straight_bat + : "\207" Cyrillic_ha_descender + : "\227" Cyrillic_HA_descender + : "\210" Cyrillic_che_descender + : "\230" Cyrillic_CHE_descender + : "\211" Cyrillic_che_vertstroke + : "\231" Cyrillic_CHE_vertstroke + : "\211" Cyrillic_che_vertstroke + : "\231" Cyrillic_CHE_vertstroke + : "\212" Cyrillic_shha + : "\232" Cyrillic_SHHA + : "\212" Cyrillic_shha + : "\232" Cyrillic_SHHA + : "\212" Cyrillic_shha + : "\232" Cyrillic_SHHA + : "\213" Cyrillic_schwa + : "\233" Cyrillic_SCHWA + : "\213" Cyrillic_schwa + : "\233" Cyrillic_SCHWA + : "\214" Cyrillic_i_macron + : "\234" Cyrillic_I_macron + : "\215" Cyrillic_o_bar + : "\235" Cyrillic_O_bar + : "\216" Cyrillic_u_macron + : "\236" Cyrillic_U_macron + : "\241" Serbian_dje + : "\261" Serbian_DJE + : "\242" Macedonia_gje + : "\262" Macedonia_GJE + : "\243" Cyrillic_io + : "\263" Cyrillic_IO + : "\243" Cyrillic_io + : "\263" Cyrillic_IO + : "\243" Cyrillic_io + : "\263" Cyrillic_IO + : "\251" Cyrillic_lje + : "\271" Cyrillic_LJE + : "\252" Cyrillic_nje + : "\272" Cyrillic_NJE + : "\300" Cyrillic_yu + : "\340" Cyrillic_YU + : "\300" Cyrillic_yu + : "\340" Cyrillic_YU + : "\303" Cyrillic_tse + : "\343" Cyrillic_TSE + : "\321" Cyrillic_ya + : "\361" Cyrillic_YA + : "\321" Cyrillic_ya + : "\361" Cyrillic_YA + : "\335" Cyrillic_shcha + : "\375" Cyrillic_SHCHA +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-c/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/koi8-c/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..a6374f3583582450651fd0ecd58f5f2c9c347135 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-c/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for koi8-c locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-c/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/koi8-c/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..93cc895701ab1960a8c6743f342417495717dcb6 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-c/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for koi8-c. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary KOI8-C:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset KOI8-C:GR + font KOI8-C:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name KOI8-C + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name KOI8-C +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding KOI8-C:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding KOI8-C:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-r/Compose b/miniconda3/envs/ladir/share/X11/locale/koi8-r/Compose new file mode 100644 index 0000000000000000000000000000000000000000..1422ad019da9396c67a025def7040163c9ed6b4d --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-r/Compose @@ -0,0 +1,13 @@ +# +# koi8-r Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-r/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/koi8-r/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..b704fec523b10758bc84c2a4a12a9423faed044c --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-r/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for koi8-r locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-r/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/koi8-r/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..ea2e0e8262b8b2005db9d9d97c085d38064d18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-r/XLC_LOCALE @@ -0,0 +1,60 @@ +# XLocale Database Sample for koi8-r. +# +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary KOI8-R:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset KOI8-R:GR + font KOI8-R:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name KOI8-R + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name KOI8-R +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding KOI8-R:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding KOI8-R:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-u/Compose b/miniconda3/envs/ladir/share/X11/locale/koi8-u/Compose new file mode 100644 index 0000000000000000000000000000000000000000..b33b6ce1ecd550a3b5798dbbc61cdb46f4daf660 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-u/Compose @@ -0,0 +1,13 @@ +# +# koi8-u Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-u/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/koi8-u/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..dd2c992f1856b4e8cea175766f840a9da844a2e7 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-u/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for koi8-u locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/koi8-u/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/koi8-u/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..cccc71b6621bfa353ebb64fb463ae751cd792358 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/koi8-u/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for koi8-u. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary KOI8-U:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset KOI8-U:GR + font KOI8-U:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name KOI8-U + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name KOI8-U +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding KOI8-U:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding KOI8-U:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1251/Compose b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1251/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1251/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1251/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..98c5ef5edad77f6e67ba950fab16be92ab611a63 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1251/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for microsoft-cp1251 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1251/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1251/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..f7944b72cdc6581fcecccf016dffaff972aad62e --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1251/XLC_LOCALE @@ -0,0 +1,65 @@ +# XLocale Database Sample for microsoft-cp1251. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary MICROSOFT-CP1251:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name MICROSOFT-CP1251:GR + } + font { + primary MICROSOFT-CP1251:GR + } +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name MICROSOFT-CP1251 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name MICROSOFT-CP1251 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding MICROSOFT-CP1251:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding MICROSOFT-CP1251:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1255/Compose b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1255/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1255/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1255/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..3d0d9a5db314ec8a953108b9acf2c97d79499c19 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1255/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for microsoft-cp1255 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1255/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1255/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..0626092070600e674f34e23bdd3bb21bda2cbfb1 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1255/XLC_LOCALE @@ -0,0 +1,65 @@ +# XLocale Database Sample for microsoft-cp1255. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary MICROSOFT-CP1255:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name MICROSOFT-CP1255:GR + } + font { + primary MICROSOFT-CP1255:GR + } +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name MICROSOFT-CP1255 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name MICROSOFT-CP1255 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding MICROSOFT-CP1255:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding MICROSOFT-CP1255:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1256/Compose b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1256/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1256/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1256/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..e58719d06808c473d43bacb2e0228dc01be76236 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1256/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for microsoft-cp1256 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1256/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1256/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..c0a85693c44a22cd3f030736b4c6726d4f53b71f --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/microsoft-cp1256/XLC_LOCALE @@ -0,0 +1,65 @@ +# XLocale Database Sample for microsoft-cp1256. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary MICROSOFT-CP1256:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name MICROSOFT-CP1256:GR + } + font { + primary MICROSOFT-CP1256:GR + } +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name MICROSOFT-CP1256 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name MICROSOFT-CP1256 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding MICROSOFT-CP1256:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding MICROSOFT-CP1256:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/mulelao-1/Compose b/miniconda3/envs/ladir/share/X11/locale/mulelao-1/Compose new file mode 100644 index 0000000000000000000000000000000000000000..ff2d33b1649aedd5d76ed59c44bec2c1c3c84747 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/mulelao-1/Compose @@ -0,0 +1,13 @@ +# +# mulelao-1 Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/mulelao-1/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/mulelao-1/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..10d7248f8bd8b75c9a4f73a12d1c745c54e90af0 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/mulelao-1/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for mulelao-1 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/mulelao-1/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/mulelao-1/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..837c8f110472befc24f268ab45cead2bd82406bb --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/mulelao-1/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for mulelao-1. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary MULELAO-1:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset MULELAO-1:GR + font MULELAO-1:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name MULELAO-1 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name MULELAO-1 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding MULELAO-1:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding MULELAO-1:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/nokhchi-1/Compose b/miniconda3/envs/ladir/share/X11/locale/nokhchi-1/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/nokhchi-1/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/nokhchi-1/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..58b1d01f7d50218ad83b9ccc0df8d8f2d1389fa1 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/nokhchi-1/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for nokhchi-1 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/nokhchi-1/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/nokhchi-1/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..96639d36ba6a9dcea98be76aaa19e2b930c8d895 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/nokhchi-1/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for mulelao-1. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary NOKHCHI-1:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset NOKHCHI-1:GR + font NOKHCHI-1:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name NOKHCHI-1 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name NOKHCHI-1 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding NOKHCHI-1:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding NOKHCHI-1:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..91096c21d2f1a0dfa52e74e5b728541d23f2ab77 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/Compose @@ -0,0 +1,24 @@ +# UTF-8 (Unicode) compose sequences +# +# Originally modified for Brazilian Portuguese +# by Gustavo Noronha Silva . +# Transformed to an include file plus some overrides +# by Benno Schulenberg +# Use the sequences from en_US.UTF-8 as the basis: +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" +# Two nice additions -- maybe add to en_US.UTF8? + : "〝" U301d # REVERSED DOUBLE PRIME QUOTATION MARK + : "〞" U301e # DOUBLE PRIME QUOTATION MARK +# Overriding C with acute: + : "Ç" Ccedilla # LATIN CAPITAL LETTER C WITH CEDILLA + : "ç" ccedilla # LATIN SMALL LETTER C WITH CEDILLA +# Overriding E with ogonek: + : "Ȩ" U0228 # LATIN CAPITAL LETTER E WITH CEDILLA + : "ȩ" U0229 # LATIN SMALL LETTER E WITH CEDILLA +# Overriding U with ogonek: + : "Ḝ" U1E1C # LATIN CAPITAL LETTER E WITH CEDILLA AND BREVE + : "ḝ" U1E1D # LATIN SMALL LETTER E WITH CEDILLA AND BREVE +# These two should probably go back into en_US.UTF8; +# they were most likely mistakenly dropped in June 2006: + : "ϓ" U03D3 # GREEK UPSILON WITH ACUTE AND HOOK SYMBOL + : "ϓ" U03D3 # GREEK UPSILON WITH ACUTE AND HOOK SYMBOL diff --git a/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..8eac6d8af5e0a93c94f0526276dab1b85754af7c --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for pt_BR.UTF-8 locale +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..71b28a1025104aac8cc4a4f9570eec380d0f79fe --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/pt_BR.UTF-8/XLC_LOCALE @@ -0,0 +1,129 @@ +# XLocale Database Sample for pt_BR.UTF-8 +# +# Based on XLocale Database Sample for en_US.UTF-8 +# +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class (Kanji) +fs2 { + charset { + name JISX0208.1983-0:GL + } + font { + primary JISX0208.1983-0:GL + } +} +# fs3 class (Korean Character) +fs3 { + charset { + name KSC5601.1987-0:GL + } + font { + primary KSC5601.1987-0:GL + } +} +# fs4 class (Chinese Han Character) +fs4 { + charset { + name GB2312.1980-0:GL + } + font { + primary GB2312.1980-0:GL + } +} +# fs5 class (Half Kana) +fs5 { + charset { + name JISX0201.1976-0:GR + } + font { + primary JISX0201.1976-0:GR + vertical_rotate all + } +} +# ISO10646 is last, per Roland Mainz in +# http://bugs.freedesktop.org/show_bug.cgi?id=1896 +fs6 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 6 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} + +# cs2 class +cs2 { + side GR + length 2 + ct_encoding JISX0208.1983-0:GL; JISX0208.1983-0:GR; JISX0208.1983-1:GL; JISX0208.1983-1:GR +} +# cs3 class +cs3 { + side GL + length 2 + ct_encoding KSC5601.1987-0:GL; KSC5601.1987-0:GR; KSC5601.1987-1:GL; KSC5601.1987-1:GR +} + +# cs4 class +cs4 { + side GR + length 2 + ct_encoding GB2312.1980-0:GL; GB2312.1980-0:GR +} + +# cs5 class +cs5 { + side GR + length 1 + ct_encoding JISX0201.1976-0:GR +} +# cs6 class +cs6 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..ce4c5ed5cb903f8ebfd0b4a7082bcb6b59d4555f --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/Compose @@ -0,0 +1,3 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" + : "Ç" Ccedilla # LATIN CAPITAL LETTER C WITH CEDILLA + : "ç" ccedilla # LATIN SMALL LETTER C WITH CEDILLA diff --git a/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..628fc7bc05b2e82fb8b4915a482f555562f616f2 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for pt_PT.UTF-8 locale +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..a44e0b55634f0d38e645ae6323b2cf45b47c9481 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/pt_PT.UTF-8/XLC_LOCALE @@ -0,0 +1,129 @@ +# XLocale Database Sample for pt_PT.UTF-8 +# +# Based on XLocale Database Sample for en_US.UTF-8 +# +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class (Kanji) +fs2 { + charset { + name JISX0208.1983-0:GL + } + font { + primary JISX0208.1983-0:GL + } +} +# fs3 class (Korean Character) +fs3 { + charset { + name KSC5601.1987-0:GL + } + font { + primary KSC5601.1987-0:GL + } +} +# fs4 class (Chinese Han Character) +fs4 { + charset { + name GB2312.1980-0:GL + } + font { + primary GB2312.1980-0:GL + } +} +# fs5 class (Half Kana) +fs5 { + charset { + name JISX0201.1976-0:GR + } + font { + primary JISX0201.1976-0:GR + vertical_rotate all + } +} +# ISO10646 is last, per Roland Mainz in +# http://bugs.freedesktop.org/show_bug.cgi?id=1896 +fs6 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 6 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} + +# cs2 class +cs2 { + side GR + length 2 + ct_encoding JISX0208.1983-0:GL; JISX0208.1983-0:GR; JISX0208.1983-1:GL; JISX0208.1983-1:GR +} +# cs3 class +cs3 { + side GL + length 2 + ct_encoding KSC5601.1987-0:GL; KSC5601.1987-0:GR; KSC5601.1987-1:GL; KSC5601.1987-1:GR +} + +# cs4 class +cs4 { + side GR + length 2 + ct_encoding GB2312.1980-0:GL; GB2312.1980-0:GR +} + +# cs5 class +cs5 { + side GR + length 1 + ct_encoding JISX0201.1976-0:GR +} +# cs6 class +cs6 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bedb703475f40767ef29d06a356fc39c52e18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/Compose @@ -0,0 +1 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" diff --git a/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..842fc27f3281f5b337afaba8f059c6a1497b3057 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for ru_RU.UTF-8 locale +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..676145f9b7645c61f90758bbda7f635b7c830627 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/ru_RU.UTF-8/XLC_LOCALE @@ -0,0 +1,153 @@ +# +# XLocale Database Sample for ru_RU.UTF-8 +# Derived from en_US.UTF-8 +# +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class (KOI8-R) +fs2 { + charset { + name KOI8-R:GR + } + font { + primary KOI8-R:GR + } +} +# fs3 class (MICROSOFT-CP1251) +fs3 { + charset { + name MICROSOFT-CP1251:GR + } + font { + primary MICROSOFT-CP1251:GR + } +} +# fs4 class (ISO8859-5) +fs4 { + charset { + name ISO8859-5:GR + } + font { + primary ISO8859-5:GR + } +} +# fs5 class (Kanji) +fs5 { + charset { + name JISX0208.1983-0:GL + } + font { + primary JISX0208.1983-0:GL + } +} +# fs6 class (Korean Character) +fs6 { + charset { + name KSC5601.1987-0:GL + } + font { + primary KSC5601.1987-0:GL + } +} +# fs7 class (Chinese Han Character) +fs7 { + charset { + name GB2312.1980-0:GL + } + font { + primary GB2312.1980-0:GL + } +} +# fs8 class (Half Kana) +fs8 { + charset { + name JISX0201.1976-0:GR + } + font { + primary JISX0201.1976-0:GR + vertical_rotate all + } +} +# ISO10646 should come last so the fonts above will actually be used +# fs9 class +fs9 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 6 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} +# cs2 class +cs2 { + side GR + length 2 + ct_encoding JISX0208.1983-0:GL; JISX0208.1983-0:GR; JISX0208.1983-1:GL; JISX0208.1983-1:GR +} +# cs3 class +cs3 { + side GL + length 2 + ct_encoding KSC5601.1987-0:GL; KSC5601.1987-0:GR; KSC5601.1987-1:GL; KSC5601.1987-1:GR +} +# cs4 class +cs4 { + side GR + length 2 + ct_encoding GB2312.1980-0:GL; GB2312.1980-0:GR +} +# cs5 class +cs5 { + side GR + length 1 + ct_encoding JISX0201.1976-0:GR +} +# cs6 class +cs6 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/sr_RS.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/sr_RS.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..d33a97c3ba977158211dd09b95e076d92dcea805 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/sr_RS.UTF-8/Compose @@ -0,0 +1,112 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" +# Serbian accentable Cyrillic letters: +# а А - U+0430, U+0410 Cyrillic_a, Cyrillic_A +# е Е - U+0435, U+0415 Cyrillic_e, Cyrillic_E +# о О - U+043E, U+041E Cyrillic_o, Cyrillic_O +# у У - U+0443, U+0423 Cyrillic_u, Cyrillic_U +# и И - U+0438, U+0418 Cyrillic_i, Cyrillic_I +# +# Possible accents: +# ̀ - U+0300 combining grave +# ́ - U+0301 combining acute +# ̂ - U+0302 combining circumflex +# ̏ - U+030F combining doublegrave +# +# ̀ - kratkouzlazni, U+0300 combining grave + : "а̀" + : "а̀" + : "А̀" + : "А̀" + : "ѐ" + : "ѐ" + : "Ѐ" + : "Ѐ" + : "ѝ" + : "ѝ" + : "Ѝ" + : "Ѝ" + : "о̀" + : "о̀" + : "О̀" + : "О̀" + : "у̀" + : "у̀" + : "У̀" + : "У̀" +# +# ́ - dugouzlazni, U+0301 combining acute + : "а́" + : "а́" + : "а́" + : "А́" + : "А́" + : "А́" + : "е́" + : "е́" + : "е́" + : "Е́" + : "Е́" + : "Е́" + : "и́" + : "и́" + : "и́" + : "И́" + : "И́" + : "И́" + : "о́" + : "о́" + : "о́" + : "О́" + : "О́" + : "О́" + : "у́" + : "у́" + : "у́" + : "У́" + : "У́" + : "У́" +# +# ̂ - dugosilazni, U+0302 combining circumflex + : "а̂" + : "а̂" + : "А̂" + : "А̂" + : "е̂" + : "е̂" + : "Е̂" + : "Е̂" + : "и̂" + : "и̂" + : "И̂" + : "И̂" + : "о̂" + : "о̂" + : "О̂" + : "О̂" + : "у̂" + : "у̂" + : "У̂" + : "У̂" +# +# ̏ - kratkosilazni, U+030F combining doublegrave +# there's no dead_doublegrave, so we use two vaguely similar dead keys + : "а̏" + : "а̏" + : "А̏" + : "А̏" + : "е̏" + : "е̏" + : "Е̏" + : "Е̏" + : "и̏" + : "и̏" + : "И̏" + : "И̏" + : "о̏" + : "о̏" + : "О̏" + : "О̏" + : "у̏" + : "у̏" + : "У̏" + : "У̏" diff --git a/miniconda3/envs/ladir/share/X11/locale/sr_RS.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/sr_RS.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..f201bf435c8481586d7905cb7bfe3b7b9dd37fd7 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/sr_RS.UTF-8/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for euro locales +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XOM common/xomLTRTTB _XomGenericOpenOM # XOM_open +XIM common/xiiimp _SwitchOpenIM # XIM_open +XIM common/xiiimp _XimpLocalOpenIM # XIM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/sr_RS.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/sr_RS.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/tatar-cyr/Compose b/miniconda3/envs/ladir/share/X11/locale/tatar-cyr/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/tatar-cyr/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/tatar-cyr/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..074f2a173bc965a371d040ae2de37ac85f1a9a5f --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/tatar-cyr/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for tatar-cyr locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/tatar-cyr/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/tatar-cyr/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..fced00c7f0d47cde5f1d3386052f1f501d897617 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/tatar-cyr/XLC_LOCALE @@ -0,0 +1,65 @@ +# XLocale Database Sample for tatar-cyr. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary TATAR-CYR:GL + substitute ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name TATAR-CYR:GR + } + font { + primary TATAR-CYR:GR + } +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name TATAR-CYR + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name TATAR-CYR +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding TATAR-CYR:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding TATAR-CYR:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bedb703475f40767ef29d06a356fc39c52e18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/Compose @@ -0,0 +1 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" diff --git a/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..dec38b0f5b858536638f384d5280b8aa5d2fda3e --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for th_TH.UTF-8 locale +# +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..c1fd2a95539dcfa86165367b7bd5fce82db7df84 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/th_TH.UTF-8/XLC_LOCALE @@ -0,0 +1,61 @@ +# XLocale Database Sample for th_TH +# +# +# Modified from original th_TH.TACTIS +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class +fs0 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +# We leave the legacy encodings in for the moment, because we don't +# have that many ISO10646 fonts yet. +# fs0 class (7 bit ASCII) +fs1 { + charset ISO8859-1:GL + font ISO8859-1:GL +} +# fs1 class (Thai) +fs2 { + charset ISO8859-11:GR + font ISO8859-11:GR +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 3 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-11:GR +} +# cs2 class +cs2 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/th_TH/Compose b/miniconda3/envs/ladir/share/X11/locale/th_TH/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/th_TH/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/th_TH/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..d677a002dd4e7b7bc3b8d19df336af8c50d83c63 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/th_TH/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for th_TH locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/th_TH/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/th_TH/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..69e0060e1ff35615b79f1dcceb5f1c0f775156e0 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/th_TH/XLC_LOCALE @@ -0,0 +1,45 @@ +# XLocale Database Sample for th_TH +# +# +# Modified from original th_TH.TACTIS +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset ISO8859-1:GL + font ISO8859-1:GL +} +# fs1 class (Thai) +fs1 { + charset ISO8859-11:GR + font ISO8859-11:GR +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name TIS620 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding ISO8859-11:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/tscii-0/Compose b/miniconda3/envs/ladir/share/X11/locale/tscii-0/Compose new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/miniconda3/envs/ladir/share/X11/locale/tscii-0/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/tscii-0/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..237a337981d933088229f71097dc253ca6d76fb4 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/tscii-0/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for tscii-0 locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/tscii-0/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/tscii-0/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..d5a753dfcb5f60aacfdaa1ba695ad1430d2732b1 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/tscii-0/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for mulelao-1. +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary TSCII-0:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset TSCII-0:GR + font TSCII-0:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name TSCII-0 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name TSCII-0 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding TSCII-0:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding TSCII-0:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/Compose b/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/Compose new file mode 100644 index 0000000000000000000000000000000000000000..c8fa34b20dcf28584e3617d58178da4b3d6d4e27 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/Compose @@ -0,0 +1,135 @@ +# 1998/12/18 Le Hong Boi $ +# +# TCVN 5712-2 Compose Sequences +# +# Sequence Definition +# +# dead key accent keysyms +# Special Character + : "`" grave + : " " space + : "~" asciitilde + : "'" apostrophe + : "\264" acute +# Accented Alphabet + : "\200" Agrave + : "\265" agrave + : "\266" Ahook + : "\266" ahook + : "\202" Atilde + : "\267" atilde + : "\203" Aacute + : "\270" aacute + : "\271" Abelowdot + : "\271" abelowdot + : "\273" Abrevegrave + : "\273" abrevegrave + : "\274" Abrevehook + : "\274" abrevehook + : "\275" Abrevetilde + : "\275" abrevetilde + : "\276" Abreveacute + : "\276" abreveacute + : "\306" Abrevebelowdot + : "\306" abrevebelowdot + : "\307" Acircumflexgrave + : "\307" acircumflexgrave + : "\310" Acircumflexhook + : "\310" acircumflexhook + : "\311" Acircumflextilde + : "\311" acircumflextilde + : "\312" Acircumflexacute + : "\312" acircumflexacute + : "\313" Acircumflexbelowdot + : "\313" acircumflexbelowdot + : "\207" Egrave + : "\314" egrave + : "\316" Ehook + : "\316" ehook + : "\317" Etilde + : "\317" etilde + : "\212" Eacute + : "\320" eacute + : "\321" Ebelowdot + : "\321" ebelowdot + : "\322" Ecircumflexgrave + : "\322" ecircumflexgrave + : "\323" Ecircumflexhook + : "\323" ecircumflexhook + : "\324" Ecircumflextilde + : "\324" ecircumflextilde + : "\325" Ecircumflexacute + : "\325" ecircumflexacute + : "\326" Ecircumflexbelowdot + : "\326" ecircumflexbelowdot + : "\215" Igrave + : "\327" igrave + : "\330" Ihook + : "\330" ihook + : "\217" Itilde + : "\334" itilde + : "\220" Iacute + : "\335" iacute + : "\336" Ibelowdot + : "\336" ibelowdot + : "\222" Ograve + : "\337" ograve + : "\341" Ohook + : "\341" ohook + : "\224" Otilde + : "\342" otilde + : "\225" Oacute + : "\343" oacute + : "\344" Obelowdot + : "\344" obelowdot + : "\345" Ocircumflexgrave + : "\345" ocircumflexgrave + : "\346" Ocircumflexhook + : "\346" ocircumflexhook + : "\347" Ocircumflextilde + : "\347" ocircumflextilde + : "\350" Ocircumflexacute + : "\350" ocircumflexacute + : "\351" Ocircumflexbelowdot + : "\351" ocircumflexbelowdot + : "\352" Ohorngrave + : "\352" ohorngrave + : "\353" Ohornhook + : "\353" ohornhook + : "\354" Ohorntilde + : "\354" ohorntilde + : "\355" Ohornacute + : "\355" ohornacute + : "\356" Ohornbelowdot + : "\356" ohornbelowdot + : "\235" Ugrave + : "\357" ugrave + : "\361" Uhook + : "\361" uhook + : "\237" Utilde + : "\362" utilde + : "\001" Uacute + : "\363" uacute + : "\364" Ubelowdot + : "\364" ubelowdot + : "\365" Uhorngrave + : "\365" uhorngrave + : "\366" Uhornhook + : "\366" uhornhook + : "\367" Uhorntilde + : "\367" uhorntilde + : "\370" Uhornacute + : "\370" uhornacute + : "\371" Uhornbelowdot + : "\371" uhornbelowdot + : "\023" Ygrave + : "\372" ygrave + : "\373" Yhook + : "\373" yhook + : "\374" Ytilde + : "\374" ytilde + : "\026" Yacute + : "\375" yacute + : "\376" Ybelowdot + : "\376" ybelowdot +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..cff66dfca0a46da6a9a34b3ad0680030570abc9b --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for vi_VN.tcvn locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..58dce1a35a4f9f85d01d370fe2866745f45c2e75 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/vi_VN.tcvn/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for vi_VN.TCVN +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary TCVN-5712:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset TCVN-5712:GR + font TCVN-5712:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name TCVN-5712 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name TCVN-5712 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding TCVN-5712:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding TCVN-5712:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/Compose b/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/Compose new file mode 100644 index 0000000000000000000000000000000000000000..2d3a8eef0c3d732c5de1bb22e70cd4beda57cf7e --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/Compose @@ -0,0 +1,135 @@ +# 1998/12/18 Le Hong Boi $ +# +# TCVN 5712-2 Compose Sequences +# +# Sequence Definition +# +# dead key accent keysyms +# Special Character + : "`" grave + : " " space + : "~" asciitilde + : "'" apostrophe + : "\264" acute +# Accented Alphabet + : "\300" Agrave + : "\340" agrave + : "\304" Ahook + : "\344" ahook + : "\303" Atilde + : "\343" atilde + : "\301" Aacute + : "\341" aacute + : "\200" Abelowdot + : "\325" abelowdot + : "\202" Abrevegrave + : "\242" abrevegrave + : "\002" Abrevehook + : "\306" abrevehook + : "\005" Abrevetilde + : "\307" abrevetilde + : "\201" Abreveacute + : "\241" abreveacute + : "\203" Abrevebelowdot + : "\243" abrevebelowdot + : "\205" Acircumflexgrave + : "\245" acircumflexgrave + : "\206" Acircumflexhook + : "\246" acircumflexhook + : "\006" Acircumflextilde + : "\347" acircumflextilde + : "\204" Acircumflexacute + : "\244" acircumflexacute + : "\207" Acircumflexbelowdot + : "\247" acircumflexbelowdot + : "\310" Egrave + : "\350" egrave + : "\313" Ehook + : "\353" ehook + : "\210" Etilde + : "\250" etilde + : "\311" Eacute + : "\351" eacute + : "\211" Ebelowdot + : "\251" ebelowdot + : "\213" Ecircumflexgrave + : "\253" ecircumflexgrave + : "\214" Ecircumflexhook + : "\254" ecircumflexhook + : "\215" Ecircumflextilde + : "\255" ecircumflextilde + : "\212" Ecircumflexacute + : "\252" ecircumflexacute + : "\216" Ecircumflexbelowdot + : "\256" ecircumflexbelowdot + : "\314" Igrave + : "\354" igrave + : "\233" Ihook + : "\357" ihook + : "\316" Itilde + : "\356" itilde + : "\315" Iacute + : "\355" iacute + : "\230" Ibelowdot + : "\270" ibelowdot + : "\322" Ograve + : "\362" ograve + : "\231" Ohook + : "\366" ohook + : "\240" Otilde + : "\365" otilde + : "\323" Oacute + : "\363" oacute + : "\232" Obelowdot + : "\367" obelowdot + : "\220" Ocircumflexgrave + : "\260" ocircumflexgrave + : "\221" Ocircumflexhook + : "\261" ocircumflexhook + : "\222" Ocircumflextilde + : "\262" ocircumflextilde + : "\217" Ocircumflexacute + : "\257" ocircumflexacute + : "\223" Ocircumflexbelowdot + : "\265" ocircumflexbelowdot + : "\226" Ohorngrave + : "\266" ohorngrave + : "\227" Ohornhook + : "\267" ohornhook + : "\263" Ohorntilde + : "\336" ohorntilde + : "\225" Ohornacute + : "\276" ohornacute + : "\224" Ohornbelowdot + : "\376" ohornbelowdot + : "\331" Ugrave + : "\371" ugrave + : "\234" Uhook + : "\374" uhook + : "\235" Utilde + : "\373" utilde + : "\332" Uacute + : "\372" uacute + : "\236" Ubelowdot + : "\370" ubelowdot + : "\273" Uhorngrave + : "\327" uhorngrave + : "\274" Uhornhook + : "\330" uhornhook + : "\377" Uhorntilde + : "\346" uhorntilde + : "\272" Uhornacute + : "\321" uhornacute + : "\271" Uhornbelowdot + : "\361" uhornbelowdot + : "\237" Ygrave + : "\317" ygrave + : "\024" Yhook + : "\326" yhook + : "\031" Ytilde + : "\333" ytilde + : "\335" Yacute + : "\375" yacute + : "\036" Ybelowdot + : "\334" ybelowdot +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..5f4b3b604c9380e641c1a35f138021d7f60ed6bd --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for vi_VN.viscii locale +# +XLC common/xlcDef _XlcDefaultLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..868f5e5535f41f3f072bf216e57016e58ea19662 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/vi_VN.viscii/XLC_LOCALE @@ -0,0 +1,59 @@ +# XLocale Database Sample for vi_VN.VISCII +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary VISCII1.1-1:GL + substitute ISO8859-1:GL + } +} +# fs1 class +fs1 { + charset VISCII1.1-1:GR + font VISCII1.1-1:GR +} +END XLC_FONTSET +# +# XLC_CHARSET_DEFINE category +# +XLC_CHARSET_DEFINE +csd0 { + charset_name VISCII1.1-1 + side GR + length 1 + string_encoding False + sequence \x1b%/1 +} +END XLC_CHARSET_DEFINE +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name VISCII1.1-1 +mb_cur_max 1 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding VISCII1.1-1:GL; ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + wc_encoding \x30000000 + ct_encoding VISCII1.1-1:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bedb703475f40767ef29d06a356fc39c52e18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/Compose @@ -0,0 +1 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..29dd53a3039ae35a790632a2829e61bd503955bd --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_CN.UTF-8 locale +# +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..f08de3590bb2afe350e6455c46211e8dc99859ff --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.UTF-8/XLC_LOCALE @@ -0,0 +1,92 @@ +# XFree86 NLS for Chinese locale zh_CN.UTF-8 +# Modified from xc/nls/XLC_LOCALE/en_US.UTF-8 +# by James Su +# +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# We leave the legacy encodings in for the moment, because we don't +# have that many ISO10646 fonts yet. +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class (Chinese Han Character) +fs2 { + charset { + name GB2312.1980-0:GL + } + font { + primary GB2312.1980-0:GL + } +} +# fs3 class (Chinese Han Character GBK) +fs3 { + charset { + name GBK-0:GLGR + } + font { + primary GBK-0:GLGR + substitute GB13000.1993-1:GLGR + } +} +# fs4 class +fs4 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 6 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} + +# cs2 class +cs2 { + side GR + length 2 + ct_encoding GB2312.1980-0:GL; GB2312.1980-0:GR +} +# cs3 class +cs3 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/Compose new file mode 100644 index 0000000000000000000000000000000000000000..76373f96fc1a687f93ffad965a8966d0a8e12aa8 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/Compose @@ -0,0 +1,13 @@ +# +# zh_CN.GB18030 Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..a92b4033c558229dd4d5034fe4b8dce9562dd851 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_CN.gb18030 locale +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..937a702c149dc859d6d9584c94408d2d322cb8ea --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gb18030/XLC_LOCALE @@ -0,0 +1,92 @@ +# XFree86 NLS for Chinese encoding GB18030 +# Modified from xc/nls/XLC_LOCALE/en_US.UTF-8 +# by James Su +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# We leave the legacy encodings in for the moment, because we don't +# have that many ISO10646 fonts yet. +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class (Chinese Han Character) +fs2 { + charset { + name GB2312.1980-0:GL + } + font { + primary GB2312.1980-0:GL + } +} +# fs3 class (Chinese Han Character GBK) +fs3 { + charset { + name GBK-0:GLGR + } + font { + primary GBK-0:GLGR + substitute GB13000.1993-1:GLGR + } +} +# fs4 class +fs4 { + charset { + name ISO10646-1 + } + font { + primary GB18030-0 + substitute GBK2K-0 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name GB18030 +mb_cur_max 4 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} + +# cs2 class +cs2 { + side GR + length 2 + ct_encoding GB2312.1980-0:GL; GB2312.1980-0:GR +} +# cs3 class +cs3 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/Compose new file mode 100644 index 0000000000000000000000000000000000000000..5789002375e14f08ad3220299d6c81a27f03c193 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/Compose @@ -0,0 +1,13 @@ +# +# zh_CN.GBK Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..197a3e194f4f2b6d7efb1d783613c10f5a433d53 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_CN.gbk locale +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..0b91f936bf26e0c4c4adcd7c7be9366134e4784a --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN.gbk/XLC_LOCALE @@ -0,0 +1,60 @@ +# +# X11R6 L10N for Chinese GBK Encoding. +# modified from xc/nls/XLC_LOCALE/zh_TW.Big5 +# by Sean Chen +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name GBK-0:GLGR + } + font { + primary GBK-0:GLGR + substitute GB13000.1993-1:GLGR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name zh_CN.GBK +mb_cur_max 2 +state_depend_encoding False +wc_encoding_mask \x00008000 +wc_shift_bits 8 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side none + length 2 + byte1 \x81,\xfe + byte2 \x40,\x7e;\x80,\xfe + wc_encoding \x00008000 + ct_encoding GBK-0:GLGR:\x1b\x25\x2f\x32 + mb_conversion [\x8140,\xfefe]->\x0140 + ct_conversion [\x0140,\x7efe]->\x8140 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_CN/Compose new file mode 100644 index 0000000000000000000000000000000000000000..98ac0d6b162f5594476d89ec86e94b26520e6249 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN/Compose @@ -0,0 +1,13 @@ +# +# zh Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_CN/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..24d066be87c41f3eea3218de79a4eff4252f468b --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN/XI18N_OBJS @@ -0,0 +1,8 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh locale +# +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_CN/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_CN/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..bc5246b4953185643988b4eb109e4d1e61603317 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_CN/XLC_LOCALE @@ -0,0 +1,53 @@ +# XLocale Database Sample for zh (eucCN). +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name GB2312.1980-0:GL + } + font { + primary GB2312.1980-0:GL + substitute GB2312.1980-0:GLGR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name zh.euc +mb_cur_max 2 +state_depend_encoding False +wc_encoding_mask \x30000000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 2 + wc_encoding \x30000000 + ct_encoding GB2312.1980-0:GL; GB2312.1980-0:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bedb703475f40767ef29d06a356fc39c52e18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/Compose @@ -0,0 +1 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..e9d5ef8ad4e0fefe14ce7ec7b91290a9bf1f6a95 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_HK.UTF-8 locale +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..12d39d41cbadd8eaeaff97bc232719fb300a6c0f --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.UTF-8/XLC_LOCALE @@ -0,0 +1,82 @@ +# XFree86 NLS for Chinese locale zh_HK.UTF-8 +# Modified from xc/nls/XLC_LOCALE/en_US.UTF-8 +# by James Su +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# We leave the legacy encodings in for the moment, because we don't +# have that many ISO10646 fonts yet. +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class +fs2 { + charset { + name BIG5HKSCS-0:GLGR + } + font { + primary BIG5HKSCS-0:GLGR + substitute BIG5-0:GLGR + } +} +# fs3 class +fs3 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 6 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} + +# cs2 class +cs2 { + side none + length 2 + ct_encoding BIG5HKSCS-0:GLGR +} +# cs3 class +cs3 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/Compose new file mode 100644 index 0000000000000000000000000000000000000000..87fc299d11450ebb4b3c296e9bc88d85a4861867 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/Compose @@ -0,0 +1,12 @@ +# +# zh_HK.big5 Compose Sequence +# +# Sequence Definition +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..826c79831ee1a6f04a05cc9edb5734596eea666d --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_HK.big5 locale +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..f34d81a607c0dc2cc5a3efb3abd99f3dc08eff2f --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5/XLC_LOCALE @@ -0,0 +1,60 @@ +# +# (c) 1996, X11R6 L10N for Taiwan and Big5 Encoding Project +# +# modified for X11R6.3 by Hung-Chi Chu 1998/01/10 +# +# XLC_FONTSET category +# +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name BIG5-0:GLGR + } + font { + primary BIG5-0:GLGR + substitute BIG5-0:GLGR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name zh_HK.Big5 +mb_cur_max 2 +state_depend_encoding False +wc_encoding_mask \x00008000 +wc_shift_bits 8 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side none + length 2 + byte1 \xa1,\xf9 + byte2 \x40,\x7e;\xa1,\xfe + wc_encoding \x00008000 + ct_encoding BIG5-0:GLGR:\x1b\x25\x2f\x32\x80\x89\x42\x49\x47\x35\x2d\x30\x02 + mb_conversion [\xa140,\xf9fe]->\x2140 + ct_conversion [\x2140,\x79fe]->\xa140 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/Compose new file mode 100644 index 0000000000000000000000000000000000000000..433c71c927de01c8baf6aa3ea1443fa0940ea8bf --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/Compose @@ -0,0 +1,12 @@ +# +# zh_HK.big5hkscs Compose Sequence +# +# Sequence Definition +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..29dc2167ae40a973478fa7383635f0a4bc0d3e54 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_HK.big5hkscs locale +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..c8984111eb770dd1652a945d4bf15548eec40aa4 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_HK.big5hkscs/XLC_LOCALE @@ -0,0 +1,61 @@ +# +# (c) 1996, X11R6 L10N for Taiwan and Big5 Encoding Project +# +# modified for X11R6.3 by Hung-Chi Chu 1998/01/10 +# modified for Big5HKSCS by Roger So +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (HKSCS extensions) +fs1 { + charset { + name BIG5HKSCS-0:GLGR + } + font { + primary BIG5HKSCS-0:GLGR + substitute BIG5HKSCS-0:GLGR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name zh_HK.big5hkscs +mb_cur_max 2 +state_depend_encoding False +wc_encoding_mask \x00008000 +wc_shift_bits 8 +use_stdc_env True +force_convert_to_mb True ++XCOMM cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side none + length 2 + byte1 \x85,\xfe + byte2 \x40,\x7e;\xa1,\xfe + wc_encoding \x00008000 + ct_encoding BIG5HKSCS-0:GLGR:\x1b\x25\x2f\x32 + mb_conversion [\x8540,\xfefe]->\x0540 + ct_conversion [\x0540,\x7efe]->\x8540 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/Compose new file mode 100644 index 0000000000000000000000000000000000000000..7bedb703475f40767ef29d06a356fc39c52e18af --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/Compose @@ -0,0 +1 @@ +include "/mnt/bn/bohanzhainas1/jiashuo/miniconda3/envs/ladir/share/X11/locale/en_US.UTF-8/Compose" diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..a3a644b7c4e1cda4e1c3063b51ec92ac77b6e3ca --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_TW.UTF-8 locale +# +XLC common/xlcUTF8Load _XlcUtf8Loader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..d41c9a9720b5fc71061eb801ddf850b17cac0ae3 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW.UTF-8/XLC_LOCALE @@ -0,0 +1,81 @@ +# XLocale Database Sample for zh_TW.UTF-8 +# +# +# XLC_FONTSET category +# +XLC_FONTSET +on_demand_loading True +object_name generic +# We leave the legacy encodings in for the moment, because we don't +# have that many ISO10646 fonts yet. +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class (ISO8859 families) +fs1 { + charset { + name ISO8859-1:GR + } + font { + primary ISO8859-1:GR + } +} +# fs2 class (Chinese Han Character (Traditional)) +fs2 { + charset { + name BIG5-0:GLGR + } + font { + primary BIG5-0:GLGR + substitute BIG5-0:GLGR + } +} +# fs3 class +fs3 { + charset { + name ISO10646-1 + } + font { + primary ISO10646-1 + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name UTF-8 +mb_cur_max 6 +state_depend_encoding False +# cs0 class +cs0 { + side GL:Default + length 1 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side GR:Default + length 1 + ct_encoding ISO8859-1:GR +} + +# cs2 class +cs2 { + side none + length 2 + ct_encoding BIG5-0:GLGR +} +# cs3 class +cs3 { + side none + ct_encoding ISO10646-1 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/Compose new file mode 100644 index 0000000000000000000000000000000000000000..42bbfa00eccd7bbe3aefff8d845848bac37009e8 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/Compose @@ -0,0 +1,13 @@ +# +# zh_TW.big5 Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..6937f614b63f61645ca5f7d85573d827359e655e --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_TW.big5 locale +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximcp _XimOpenIM _XimRegisterIMInstantiateCallback _XimUnRegisterIMInstantiateCallback # XIM_open XIM_register XIM_unregister +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..44cf1a2330740773be15bb88ec1a37622b2752ed --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW.big5/XLC_LOCALE @@ -0,0 +1,80 @@ +# +# (c) 1996, X11R6 L10N for Taiwan and Big5 Encoding Project +# +# modified for X11R6.3 by Hung-Chi Chu 1998/01/10 +# +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name BIG5-0:GLGR + } + font { + primary BIG5-0:GLGR + substitute BIG5-0:GLGR + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name zh_TW.Big5 +mb_cur_max 2 +state_depend_encoding False +wc_encoding_mask \x00038000 +wc_shift_bits 8 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL +} +# cs1 class +cs1 { + side none + length 2 + byte1 \xa1,\xf9 + byte2 \x40,\x7e;\xa1,\xfe + wc_encoding \x00008000 + ct_encoding BIG5-0:GLGR:\x1b\x25\x2f\x32 + mb_conversion [\xa140,\xf9fe]->\x2140 + ct_conversion [\x2140,\x79fe]->\xa140 +} +# cs2 class +cs2 { + side none + length 2 + byte1 \xa1,\xc7 + byte2 \x40,\x7e;\xa1,\xfe + wc_encoding \x00010000 + ct_encoding BIG5-E0:GL;BIG5-E0:GR + mb_conversion [\xa140,\xa17e]->\x2121, [\xa1a1,\xa1bf]->\x2160, [\xa1c0,\xa1fe]->\x2221, [\xa240,\xa25e]->\x2260, [\xa25f,\xa27e]->\x2321, [\xa2a1,\xa2de]->\x2341, [\xa2df,\xa2fe]->\x2421, [\xa340,\xa37d]->\x2441, [\xa37e,\xa37e]->\x2521, [\xa3a1,\xa3fd]->\x2522, [\xa3fe,\xa3fe]->\x2621, [\xa440,\xa47e]->\x2622, [\xa4a1,\xa4be]->\x2661, [\xa4bf,\xa4fe]->\x2721, [\xa540,\xa55d]->\x2761, [\xa55e,\xa57e]->\x2821, [\xa5a1,\xa5dd]->\x2842, [\xa5de,\xa5fe]->\x2921, [\xa640,\xa67c]->\x2942, [\xa67d,\xa67e]->\x2a21, [\xa6a1,\xa6fc]->\x2a23, [\xa6fd,\xa6fe]->\x2b21, [\xa740,\xa77e]->\x2b23, [\xa7a1,\xa7bd]->\x2b62, [\xa7be,\xa7fe]->\x2c21, [\xa840,\xa85c]->\x2c62, [\xa85d,\xa87e]->\x2d21, [\xa8a1,\xa8dc]->\x2d43, [\xa8dd,\xa8fe]->\x2e21, [\xa940,\xa97b]->\x2e43, [\xa97c,\xa97e]->\x2f21, [\xa9a1,\xa9fb]->\x2f24, [\xa9fc,\xa9fe]->\x3021, [\xaa40,\xaa7e]->\x3024, [\xaaa1,\xaabc]->\x3063, [\xaabd,\xaafe]->\x3121, [\xab40,\xab5b]->\x3163, [\xab5c,\xab7e]->\x3221, [\xaba1,\xabdb]->\x3244, [\xabdc,\xabfe]->\x3321, [\xac40,\xac7a]->\x3344, [\xac7b,\xac7e]->\x3421, [\xaca1,\xacfa]->\x3425, [\xacfb,\xacfe]->\x3521, [\xad40,\xad7e]->\x3525, [\xada1,\xadbb]->\x3564, [\xadbc,\xadfe]->\x3621, [\xae40,\xae5a]->\x3664, [\xae5b,\xae7e]->\x3721, [\xaea1,\xaeda]->\x3745, [\xaedb,\xaefe]->\x3821, [\xaf40,\xaf79]->\x3845, [\xaf7a,\xaf7e]->\x3921, [\xafa1,\xaff9]->\x3926, [\xaffa,\xaffe]->\x3a21, [\xb040,\xb07e]->\x3a26, [\xb0a1,\xb0ba]->\x3a65, [\xb0bb,\xb0fe]->\x3b21, [\xb140,\xb159]->\x3b65, [\xb15a,\xb17e]->\x3c21, [\xb1a1,\xb1d9]->\x3c46, [\xb1da,\xb1fe]->\x3d21, [\xb240,\xb278]->\x3d46, [\xb279,\xb27e]->\x3e21, [\xb2a1,\xb2f8]->\x3e27, [\xb2f9,\xb2fe]->\x3f21, [\xb340,\xb37e]->\x3f27, [\xb3a1,\xb3b9]->\x3f66, [\xb3ba,\xb3fe]->\x4021, [\xb440,\xb458]->\x4066, [\xb459,\xb47e]->\x4121, [\xb4a1,\xb4d8]->\x4147, [\xb4d9,\xb4fe]->\x4221, [\xb540,\xb577]->\x4247, [\xb578,\xb57e]->\x4321, [\xb5a1,\xb5f7]->\x4328, [\xb5f8,\xb5fe]->\x4421, [\xb640,\xb67e]->\x4428, [\xb6a1,\xb6b8]->\x4467, [\xb6b9,\xb6fe]->\x4521, [\xb740,\xb757]->\x4567, [\xb758,\xb77e]->\x4621, [\xb7a1,\xb7d7]->\x4648, [\xb7d8,\xb7fe]->\x4721, [\xb840,\xb876]->\x4748, [\xb877,\xb87e]->\x4821, [\xb8a1,\xb8f6]->\x4829, [\xb8f7,\xb8fe]->\x4921, [\xb940,\xb97e]->\x4929, [\xb9a1,\xb9b7]->\x4968, [\xb9b8,\xb9fe]->\x4a21, [\xba40,\xba56]->\x4a68, [\xba57,\xba7e]->\x4b21, [\xbaa1,\xbad6]->\x4b49, [\xbad7,\xbafe]->\x4c21, [\xbb40,\xbb75]->\x4c49, [\xbb76,\xbb7e]->\x4d21, [\xbba1,\xbbf5]->\x4d2a, [\xbbf6,\xbbfe]->\x4e21, [\xbc40,\xbc7e]->\x4e2a, [\xbca1,\xbcb6]->\x4e69, [\xbcb7,\xbcfe]->\x4f21, [\xbd40,\xbd55]->\x4f69, [\xbd56,\xbd7e]->\x5021, [\xbda1,\xbdd5]->\x504a, [\xbdd6,\xbdfe]->\x5121, [\xbe40,\xbe74]->\x514a, [\xbe75,\xbe7e]->\x5221, [\xbea1,\xbef4]->\x522b, [\xbef5,\xbefe]->\x5321, [\xbf40,\xbf7e]->\x532b, [\xbfa1,\xbfb5]->\x536a, [\xbfb6,\xbffe]->\x5421, [\xc040,\xc054]->\x546a, [\xc055,\xc07e]->\x5521, [\xc0a1,\xc0d4]->\x554b, [\xc0d5,\xc0fe]->\x5621, [\xc140,\xc173]->\x564b, [\xc174,\xc17e]->\x5721, [\xc1a1,\xc1f3]->\x572c, [\xc1f4,\xc1fe]->\x5821, [\xc240,\xc27e]->\x582c, [\xc2a1,\xc2b4]->\x586b, [\xc2b5,\xc2fe]->\x5921, [\xc340,\xc353]->\x596b, [\xc354,\xc37e]->\x5a21, [\xc3a1,\xc3d3]->\x5a4c, [\xc3d4,\xc3fe]->\x5b21, [\xc440,\xc472]->\x5b4c, [\xc473,\xc47e]->\x5c21, [\xc4a1,\xc4f2]->\x5c2d, [\xc4f3,\xc4fe]->\x5d21, [\xc540,\xc57e]->\x5d2d, [\xc5a1,\xc5b3]->\x5d6c, [\xc5b4,\xc5fe]->\x5e21, [\xc640,\xc652]->\x5e6c, [\xc653,\xc67e]->\x5f21, [\xc6a1,\xc6d2]->\x5f4d, [\xc6d3,\xc6fe]->\x6021, [\xc740,\xc771]->\x604d, [\xc772,\xc77e]->\x6121, [\xc7a1,\xc7f1]->\x612e, [\xc7f2,\xc7fe]->\x6221 +} +# cs3 class +cs3 { + side none + length 2 + byte1 \xc9,\xf9 + byte2 \x40,\x7e;\xa1,\xfe + wc_encoding \x00020000 + ct_encoding BIG5-E1:GL;BIG5-E1:GR + mb_conversion [\xc940,\xc97e]->\x2121, [\xc9a1,\xc9bf]->\x2160, [\xc9c0,\xc9fe]->\x2221, [\xca40,\xca5e]->\x2260, [\xca5f,\xca7e]->\x2321, [\xcaa1,\xcade]->\x2341, [\xcadf,\xcafe]->\x2421, [\xcb40,\xcb7d]->\x2441, [\xcb7e,\xcb7e]->\x2521, [\xcba1,\xcbfd]->\x2522, [\xcbfe,\xcbfe]->\x2621, [\xcc40,\xcc7e]->\x2622, [\xcca1,\xccbe]->\x2661, [\xccbf,\xccfe]->\x2721, [\xcd40,\xcd5d]->\x2761, [\xcd5e,\xcd7e]->\x2821, [\xcda1,\xcddd]->\x2842, [\xcdde,\xcdfe]->\x2921, [\xce40,\xce7c]->\x2942, [\xce7d,\xce7e]->\x2a21, [\xcea1,\xcefc]->\x2a23, [\xcefd,\xcefe]->\x2b21, [\xcf40,\xcf7e]->\x2b23, [\xcfa1,\xcfbd]->\x2b62, [\xcfbe,\xcffe]->\x2c21, [\xd040,\xd05c]->\x2c62, [\xd05d,\xd07e]->\x2d21, [\xd0a1,\xd0dc]->\x2d43, [\xd0dd,\xd0fe]->\x2e21, [\xd140,\xd17b]->\x2e43, [\xd17c,\xd17e]->\x2f21, [\xd1a1,\xd1fb]->\x2f24, [\xd1fc,\xd1fe]->\x3021, [\xd240,\xd27e]->\x3024, [\xd2a1,\xd2bc]->\x3063, [\xd2bd,\xd2fe]->\x3121, [\xd340,\xd35b]->\x3163, [\xd35c,\xd37e]->\x3221, [\xd3a1,\xd3db]->\x3244, [\xd3dc,\xd3fe]->\x3321, [\xd440,\xd47a]->\x3344, [\xd47b,\xd47e]->\x3421, [\xd4a1,\xd4fa]->\x3425, [\xd4fb,\xd4fe]->\x3521, [\xd540,\xd57e]->\x3525, [\xd5a1,\xd5bb]->\x3564, [\xd5bc,\xd5fe]->\x3621, [\xd640,\xd65a]->\x3664, [\xd65b,\xd67e]->\x3721, [\xd6a1,\xd6da]->\x3745, [\xd6db,\xd6fe]->\x3821, [\xd740,\xd779]->\x3845, [\xd77a,\xd77e]->\x3921, [\xd7a1,\xd7f9]->\x3926, [\xd7fa,\xd7fe]->\x3a21, [\xd840,\xd87e]->\x3a26, [\xd8a1,\xd8ba]->\x3a65, [\xd8bb,\xd8fe]->\x3b21, [\xd940,\xd959]->\x3b65, [\xd95a,\xd97e]->\x3c21, [\xd9a1,\xd9d9]->\x3c46, [\xd9da,\xd9fe]->\x3d21, [\xda40,\xda78]->\x3d46, [\xda79,\xda7e]->\x3e21, [\xdaa1,\xdaf8]->\x3e27, [\xdaf9,\xdafe]->\x3f21, [\xdb40,\xdb7e]->\x3f27, [\xdba1,\xdbb9]->\x3f66, [\xdbba,\xdbfe]->\x4021, [\xdc40,\xdc58]->\x4066, [\xdc59,\xdc7e]->\x4121, [\xdca1,\xdcd8]->\x4147, [\xdcd9,\xdcfe]->\x4221, [\xdd40,\xdd77]->\x4247, [\xdd78,\xdd7e]->\x4321, [\xdda1,\xddf7]->\x4328, [\xddf8,\xddfe]->\x4421, [\xde40,\xde7e]->\x4428, [\xdea1,\xdeb8]->\x4467, [\xdeb9,\xdefe]->\x4521, [\xdf40,\xdf57]->\x4567, [\xdf58,\xdf7e]->\x4621, [\xdfa1,\xdfd7]->\x4648, [\xdfd8,\xdffe]->\x4721, [\xe040,\xe076]->\x4748, [\xe077,\xe07e]->\x4821, [\xe0a1,\xe0f6]->\x4829, [\xe0f7,\xe0fe]->\x4921, [\xe140,\xe17e]->\x4929, [\xe1a1,\xe1b7]->\x4968, [\xe1b8,\xe1fe]->\x4a21, [\xe240,\xe256]->\x4a68, [\xe257,\xe27e]->\x4b21, [\xe2a1,\xe2d6]->\x4b49, [\xe2d7,\xe2fe]->\x4c21, [\xe340,\xe375]->\x4c49, [\xe376,\xe37e]->\x4d21, [\xe3a1,\xe3f5]->\x4d2a, [\xe3f6,\xe3fe]->\x4e21, [\xe440,\xe47e]->\x4e2a, [\xe4a1,\xe4b6]->\x4e69, [\xe4b7,\xe4fe]->\x4f21, [\xe540,\xe555]->\x4f69, [\xe556,\xe57e]->\x5021, [\xe5a1,\xe5d5]->\x504a, [\xe5d6,\xe5fe]->\x5121, [\xe640,\xe674]->\x514a, [\xe675,\xe67e]->\x5221, [\xe6a1,\xe6f4]->\x522b, [\xe6f5,\xe6fe]->\x5321, [\xe740,\xe77e]->\x532b, [\xe7a1,\xe7b5]->\x536a, [\xe7b6,\xe7fe]->\x5421, [\xe840,\xe854]->\x546a, [\xe855,\xe87e]->\x5521, [\xe8a1,\xe8d4]->\x554b, [\xe8d5,\xe8fe]->\x5621, [\xe940,\xe973]->\x564b, [\xe974,\xe97e]->\x5721, [\xe9a1,\xe9f3]->\x572c, [\xe9f4,\xe9fe]->\x5821, [\xea40,\xea7e]->\x582c, [\xeaa1,\xeab4]->\x586b, [\xeab5,\xeafe]->\x5921, [\xeb40,\xeb53]->\x596b, [\xeb54,\xeb7e]->\x5a21, [\xeba1,\xebd3]->\x5a4c, [\xebd4,\xebfe]->\x5b21, [\xec40,\xec72]->\x5b4c, [\xec73,\xec7e]->\x5c21, [\xeca1,\xecf2]->\x5c2d, [\xecf3,\xecfe]->\x5d21, [\xed40,\xed7e]->\x5d2d, [\xeda1,\xedb3]->\x5d6c, [\xedb4,\xedfe]->\x5e21, [\xee40,\xee52]->\x5e6c, [\xee53,\xee7e]->\x5f21, [\xeea1,\xeed2]->\x5f4d, [\xeed3,\xeefe]->\x6021, [\xef40,\xef71]->\x604d, [\xef72,\xef7e]->\x6121, [\xefa1,\xeff1]->\x612e, [\xeff2,\xeffe]->\x6221, [\xf040,\xf07e]->\x622e, [\xf0a1,\xf0b2]->\x626d, [\xf0b3,\xf0fe]->\x6321, [\xf140,\xf151]->\x636d, [\xf152,\xf17e]->\x6421, [\xf1a1,\xf1d1]->\x644e, [\xf1d2,\xf1fe]->\x6521, [\xf240,\xf270]->\x654e, [\xf271,\xf27e]->\x6621, [\xf2a1,\xf2f0]->\x662f, [\xf2f1,\xf2fe]->\x6721, [\xf340,\xf37e]->\x672f, [\xf3a1,\xf3b1]->\x676e, [\xf3b2,\xf3fe]->\x6821, [\xf440,\xf450]->\x686e, [\xf451,\xf47e]->\x6921, [\xf4a1,\xf4d0]->\x694f, [\xf4d1,\xf4fe]->\x6a21, [\xf540,\xf56f]->\x6a4f, [\xf570,\xf57e]->\x6b21, [\xf5a1,\xf5ef]->\x6b30, [\xf5f0,\xf5fe]->\x6c21, [\xf640,\xf67e]->\x6c30, [\xf6a1,\xf6b0]->\x6c6f, [\xf6b1,\xf6fe]->\x6d21, [\xf740,\xf74f]->\x6d6f, [\xf750,\xf77e]->\x6e21, [\xf7a1,\xf7cf]->\x6e50, [\xf7d0,\xf7fe]->\x6f21, [\xf840,\xf86e]->\x6f50, [\xf86f,\xf87e]->\x7021, [\xf8a1,\xf8ee]->\x7031, [\xf8ef,\xf8fe]->\x7121, [\xf940,\xf97e]->\x7131, [\xf9a1,\xf9af]->\x7170, [\xf9b0,\xf9fe]->\x7221 +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW/Compose b/miniconda3/envs/ladir/share/X11/locale/zh_TW/Compose new file mode 100644 index 0000000000000000000000000000000000000000..0b238ba5df1df470fac655b9c814adc06754c4f8 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW/Compose @@ -0,0 +1,13 @@ +# +# zh_TW Compose Sequence +# +# Sequence Definition +# +# +# This file currently has no entries. It appears that a compose file (even +# just an empty one) is required for the appropriate keysyms to work for +# this encoding. +# +# Means +# Special Character +# End of Sequence Definition diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW/XI18N_OBJS b/miniconda3/envs/ladir/share/X11/locale/zh_TW/XI18N_OBJS new file mode 100644 index 0000000000000000000000000000000000000000..0f471dd00d39c23110df8328cbd3f3d238e67ad3 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW/XI18N_OBJS @@ -0,0 +1,7 @@ +# CATEGORY(XLC|XIM|OM) SHARED_LIBRARY_NAME FUNCTION_NAME +# +# XI18N objects table for zh_TW locale +# +XLC common/xlibi18n _XlcGenericLoader # XLC_open +XIM common/ximp40 _Ximp_OpenIM # XIM_open +XOM common/xomGeneric _XomGenericOpenOM # XOM_open diff --git a/miniconda3/envs/ladir/share/X11/locale/zh_TW/XLC_LOCALE b/miniconda3/envs/ladir/share/X11/locale/zh_TW/XLC_LOCALE new file mode 100644 index 0000000000000000000000000000000000000000..3a73ec43e0d89fdccb3812725932669e355f7043 --- /dev/null +++ b/miniconda3/envs/ladir/share/X11/locale/zh_TW/XLC_LOCALE @@ -0,0 +1,129 @@ +# XLocale Database Sample for zh_TW +# +# Note: In lib/X11/lcCT.c, charset names for CNS11643 coded character +# sets are defined as CNS11643.1986-1 and -2. In the ECMA Registry, +# CNS coded character sets 1-7 are registered as CNS 11643-1992. +# CJK.INF Version 1.7 (August 15, 1995) written by Ken Lunde says +# plane 14 of CNS 11643-1983 now became plane 3 of CNS 11643-1992. +# I do not know how Taiwanese EUC is organized currently, so I left the +# X11R6 organization of fsN/csN as it is and only changed "CNS11643-*" +# to "CNS11643.1986-*". +# 1995-10-24 T. Numata (numa@rp.open.cs.fujitsu.co.jp) +# +# XLC_FONTSET category +# +XLC_FONTSET +# fs0 class (7 bit ASCII) +fs0 { + charset { + name ISO8859-1:GL + } + font { + primary ISO8859-1:GL + vertical_rotate all + } +} +# fs1 class +fs1 { + charset { + name CNS11643.1986-1:GL + } + font { + primary CNS11643.1986-1:GL + } +} +# fs2 class +fs2 { + charset { + name CNS11643.1986-2:GL + } + font { + primary CNS11643.1986-2:GL + } +} +# fs3 class +fs3 { + charset { + name CNS11643.1986-14:GL + } + font { + primary CNS11643.1986-14:GL + } +} +# fs4 class +fs4 { + charset { + name CNS11643.1986-15:GL + } + font { + primary CNS11643.1986-15:GL + } +} +# fs5 class +fs5 { + charset { + name CNS11643.1986-16:GL + } + font { + primary CNS11643.1986-16:GL + } +} +END XLC_FONTSET +# +# XLC_XLOCALE category +# +XLC_XLOCALE +encoding_name zh_TW.euc +mb_cur_max 4 +state_depend_encoding False +wc_encoding_mask \x3fffc000 +wc_shift_bits 7 +use_stdc_env True +force_convert_to_mb True +# cs0 class +cs0 { + side GL:Default + length 1 + wc_encoding \x00000000 + ct_encoding ISO8859-1:GL; CNS11643.1986-0:GL +} +# cs1 class +cs1 { + side GR:Default + length 2 + wc_encoding \x30000000 + ct_encoding CNS11643.1986-1:GR +} +# cs2 class # plane 2 +cs2 { + side GR + length 2 + mb_encoding \x8e\xa2 + wc_encoding \x10088000 + ct_encoding CNS11643.1986-2:GR +} +# cs3 class # plane 14 +cs3 { + side GR + length 2 + mb_encoding \x8e\xae + wc_encoding \x100b8000 + ct_encoding CNS11643.1986-14:GR +} +# cs4 class # plane 15 +cs4 { + side GR + length 2 + mb_encoding \x8e\xaf + wc_encoding \x100bc000 + ct_encoding CNS11643.1986-15:GR +} +# cs5 class # plane 16 +cs5 { + side GR + length 2 + mb_encoding \x8e\xb0 + wc_encoding \x100c0000 + ct_encoding CNS11643.1986-16:GR +} +END XLC_XLOCALE diff --git a/miniconda3/envs/ladir/share/doc/bigreqsproto/bigreq.xml b/miniconda3/envs/ladir/share/doc/bigreqsproto/bigreq.xml new file mode 100644 index 0000000000000000000000000000000000000000..1d1d84d0045c6149d5953cc1aa38b47bedd9d796 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/bigreqsproto/bigreq.xml @@ -0,0 +1,332 @@ + + %defs; +]> + + + + + + Big Requests Extension + X Consortium Standard + X Version 11, Release &fullrelvers; + Version 2.0 + + + BobScheifler + X Consortium + + + 19931994X Consortium + + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +Except as contained in this notice, the name of the X Consortium shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the X Consortium. + +X Window System is a trademark of The Open Group. + + + + + +Overview + +This extension enables the use of protocol requests that exceed 262140 bytes in length. + +The core protocol restricts the maximum length of a protocol request to 262140 bytes, in that it uses a 16-bit length field specifying the number of 4-byte units in the request. This is a problem in the core protocol when joining large numbers of lines (PolyLine) or arcs (PolyArc), since these requests cannot be broken up into smaller requests without disturbing the rendering of the join points. It is also much more of a problem for protocol extensions, such as the PEX extension for 3D graphics and the XIE extension for imaging, that need to send long data lists in output commands. + +This extension defines a mechanism for extending the length field beyond 16 bits. If the normal 16-bit length field of the protocol request is zero, then an additional 32-bit field containing the actual length (in 4-byte units) is inserted into the request, immediately following the 16-bit length field. + +For example, a normal PolyLine encoding is: + + + + + + + + + + + PolyLine + + + + + 1 + 65 + + opcode + + + 1 + + + coordinate-mode + + + + 0 + Origin + + + + + 1 + Previous + + + + 2 + 3+n + + + + + 4 + DRAWABLE + + drawable + + + 4 + GCONTEXT + + gc + + + 4n + LISTofPOINT + + points + + + + + +An extended-length PolyLine encoding is: + + + + + + + + + + + PolyLine + + + + + 1 + 65 + + opcode + + + 1 + + + coordinate-mode + + + + 0 + Origin + + + + + 1 + Previous + + + + 2 + 0 + + extended length flag + + + 4 + 4+n + + request length + + + 4 + DRAWABLE + + drawable + + + 4 + GCONTEXT + + gc + + + 4n + LISTofPOINT + + points + + + + + +Extended-length protocol encodings, once enabled, can be used on all protocol requests, including all extensions. + + + +Requests + +BigReqEnable + + => + +maximum-request-length: CARD32 + +This request enables extended-length protocol requests for the requesting client. It also returns the maximum length of a request, in 4-byte units, that can be used in extended-length protocol requests. This value will always be greater than the maximum-request-length returned in the connection setup information. + + + +Events and Errors + +No new events or errors are defined by this extension. + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this document uses conventions established there. + +The name of this extension is “BIG-REQUESTS”. + + + + + + + + + + BigReqEnable + + + + + 1 + Card8 + opcode + + + 1 + 0 + bigreq opcode + + + 2 + 1 + request length + + + + + + + + + + => + + + + + 1 + 1 + Reply + + + 1 + + unused + + + 2 + CARD16 + sequence number + + + 4 + 0 + length + + + 4 + CARD32 + maximum-request-length + + + 20 + + unused + + + + + + + + +C language binding + +It is desirable for core Xlib, and other extensions, to use this extension internally when necessary. It is also desirable to make the use of this extension as transparent as possible to the X client. For example, if enabling of the extension were delayed until the first time it was needed, an application that used +XNextRequest +to determine the sequence number of a request would no longer get the correct sequence number. As such, +XOpenDisplay +will determine if the extension is supported by the server and, if it is, enable extended-length encodings. + +The core Xlib functions +XDrawLines, +XDrawArcs, +XFillPolygon, +XChangeProperty, +XSetClipRectangles, and +XSetRegion. +are required to use extended-length encodings when necessary, if supported by the server. Use of extended-length encodings in other core Xlib functions +(XDrawPoints, +XDrawRectangles, +XDrawSegments. +XFillArcs, +XFillRectangles, +XPutImage +is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead. + +To permit clients to know what the maximum-request-length for extended-length encodings is, the following function is added to Xlib: + + + + long XExtendedMaxRequestSize + Display *display + + + +Returns zero (0) if the specified display does not support this extension, otherwise returns the maximum-request-length (in 4-byte units) supported by the server through the extended-length encoding. + + + +Acknowledgements + +Clive Feather (IXI) originated the extended-length encoding used in this extension proposal. + + diff --git a/miniconda3/envs/ladir/share/doc/expat/AUTHORS b/miniconda3/envs/ladir/share/doc/expat/AUTHORS new file mode 100644 index 0000000000000000000000000000000000000000..99475bb1b2efae732a3d5da2ad6fe53f81434989 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/expat/AUTHORS @@ -0,0 +1,10 @@ +Expat is brought to you by: + +Clark Cooper +Fred L. Drake, Jr. +Greg Stein +James Clark +Karl Waclawek +Rhodri James +Sebastian Pipping +Steven Solie diff --git a/miniconda3/envs/ladir/share/doc/expat/changelog b/miniconda3/envs/ladir/share/doc/expat/changelog new file mode 100644 index 0000000000000000000000000000000000000000..cafb1921eb0aee13c09518f70fcbcaf71fbdc502 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/expat/changelog @@ -0,0 +1,1885 @@ + __ __ _ + ___\ \/ /_ __ __ _| |_ + / _ \\ /| '_ \ / _` | __| + | __// \| |_) | (_| | |_ + \___/_/\_\ .__/ \__,_|\__| + |_| XML parser + +!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +!! Expat is UNDERSTAFFED and WITHOUT FUNDING. !! +!! ~~~~~~~~~~~~ !! +!! The following topics need *additional skilled C developers* to progress !! +!! in a timely manner or at all (loosely ordered by descending priority): !! +!! !! +!! - teaming up on researching and fixing future security reports and !! +!! ClusterFuzz findings with few-days-max response times in communication !! +!! in order to (1) have a sound fix ready before the end of a 90 days !! +!! grace period and (2) in a sustainable manner, !! +!! - helping Perl's XML::Parser Expat bindings with supporting Expat's !! +!! security API (https://github.com/cpan-authors/XML-Parser/issues/102): !! +!! - XML_SetAllocTrackerActivationThreshold !! +!! - XML_SetAllocTrackerMaximumAmplification !! +!! - XML_SetBillionLaughsAttackProtectionActivationThreshold !! +!! - XML_SetBillionLaughsAttackProtectionMaximumAmplification !! +!! - XML_SetReparseDeferralEnabled !! +!! - implementing and auto-testing XML 1.0r5 support !! +!! (needs discussion before pull requests), !! +!! - smart ideas on fixing the Autotools CMake files generation issue !! +!! without breaking CI (needs discussion before pull requests), !! +!! - pushing migration from `int` to `size_t` further !! +!! including edge-cases test coverage (needs discussion before anything). !! +!! !! +!! For details, please reach out via e-mail to sebastian@pipping.org so we !! +!! can schedule a voice call on the topic, in English or German. !! +!! !! +!! THANK YOU! Sebastian Pipping -- Berlin, 2024-03-09 !! +!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +Release 2.7.4 Sat January 31 2026 + Security fixes: + #1131 CVE-2026-24515 -- Function XML_ExternalEntityParserCreate + failed to copy the encoding handler data passed to + XML_SetUnknownEncodingHandler from the parent to the new + subparser. This can cause a NULL dereference (CWE-476) from + external entities that declare use of an unknown encoding. + The expected impact is denial of service. It takes use of + both functions XML_ExternalEntityParserCreate and + XML_SetUnknownEncodingHandler for an application to be + vulnerable. + #1075 CVE-2026-25210 -- Add missing check for integer overflow + related to buffer size determination in function doContent + + Bug fixes: + #1073 lib: Fix missing undoing of group size expansion in doProlog + failure cases + #1107 xmlwf: Fix a memory leak + #1104 WASI: Fix format specifiers for 32bit WASI SDK + + Other changes: + #1105 lib: Fix strict aliasing + #1106 lib: Leverage feature "flexible array member" of C99 + #1051 lib: Swap (size_t)(-1) for C99 equivalent SIZE_MAX + #1109 lib|xmlwf: Return NULL instead of 0 for pointers + #1068 lib|Windows: Clean up use of macro _MSC_EXTENSIONS with MSVC + #1112 lib: Remove unused import + #1110 xmlwf: Warn about XXE in --help output (and man page) + #1102 #1103 WASI: Stop using getpid + #1113 #1130 Autotools: Drop file expat.m4 that provided obsolete Autoconf + macro AM_WITH_EXPAT + #1123 Autotools: Limit -Wno-pedantic-ms-format to MinGW + #1129 #1134 .. + #1087 Autotools|macOS: Sync CMake templates with CMake 4.0 + #1139 #1140 Autotools|CMake: Introduce off-by-default symbol versioning + The related build system flags are: + - For Autotools, configure with --enable-symbol-versioning + - For CMake, configure with -DEXPAT_SYMBOL_VERSIONING=ON + Please double-check for consequences before activating + this inside distro packaging. Bug reports welcome! + #1117 Autotools|CMake: Remove libbsd support + #1105 Autotools|CMake: Stop using -fno-strict-aliasing, and use + -Wstrict-aliasing=3 instead + #1124 Autotools|CMake: Prefer command gsed (GNU sed) over sed + (e.g. for Solaris) inside fix-xmltest-log.sh + #1067 CMake: Detect and warn about unusable check_c_compiler_flag + #1137 CMake: Drop support for CMake <3.17 + #1138 CMake|Windows: Fix libexpat.def.cmake version comments + + #1086 #1110 docs: Add warning about external reference handlers and XXE + #1066 docs: Be explicit that parent parsers need to outlive + subparsers + #1089 .. + #1090 #1091 .. + #1092 #1093 .. + #1094 #1098 .. + #1115 #1116 docs: Misc non-content improvements to doc/reference.html + #1132 #1133 Version info bumped from 12:1:11 (libexpat*.so.1.11.1) + to 12:2:11 (libexpat*.so.1.11.2); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #1119 #1121 Document guidelines for contributing to Expat + #1120 Introduce a pull request template + #1074 CI: Stop using about-to-be-removed image "macos-13" + #1083 #1088 CI: Mitigate random Wine crashes + #1104 CI: Cover compilation with WASI SDK + #1116 CI: Enforce clean doc XML formatting + #1124 .. + #1135 #1136 CI: Cover Solaris 11.4 + #1125 CI: Extend CI coverage of FreeBSD + #1139 #1140 CI: Cover symbol versioning + #1114 xmlwf: Reformat helpgen code (using Black 25.12.0) + #1071 .gitignore: Add files CPackConfig.cmake and + CPackSourceConfig.cmake + + Special thanks to: + Alfonso Gregory + Bénédikt Tran + Gordon Messmer + Hanno Böck + Jakub Kulík + Matthew Fernandez + Neil Pang + Rosen Penev + and + Artiphishell Inc. + +Release 2.7.3 Wed September 24 2025 + Security fixes: + #1046 #1048 Fix alignment of internal allocations for some non-amd64 + architectures (e.g. sparc32); fixes up on the fix to + CVE-2025-59375 from #1034 (of Expat 2.7.2 and related + backports) + #1059 Fix a class of false positives where input should have been + rejected with error XML_ERROR_ASYNC_ENTITY; regression from + CVE-2024-8176 fix pull request #973 (of Expat 2.7.0 and + related backports). Please check the added unit tests for + example documents. + + Other changes: + #1043 Prove and regression-proof absence of integer overflow + from function expat_realloc + #1062 Remove "harmless" cast that truncated a size_t to unsigned + #1049 Autotools: Remove "ln -s" discovery + #1054 docs: Be consistent with use of floating point around + XML_SetAllocTrackerMaximumAmplification + #1056 docs: Make it explicit that XML_GetCurrentColumnNumber + starts at 0 + #1057 docs: Better integrate the effect of the activation + thresholds + #1058 docs: Fix an in-comment typo in expat.h + #1045 docs: Fix a typo in README.md + #1041 docs: Improve change log of release 2.7.2 + #1053 xmlwf: Resolve use of functions XML_GetErrorLineNumber + and XML_GetErrorColumnNumber + #1032 Windows: Normalize .bat files to CRLF line endings + #1060 #1061 Version info bumped from 12:0:11 (libexpat*.so.1.11.0) + to 12:1:11 (libexpat*.so.1.11.1); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #1047 #1050 CI: Cleanup UndefinedBehaviorSanitizer fatality + #1044 CI|Linux: Stop aborting at first job failure + #1052 CI|FreeBSD: Upgrade to FreeBSD 15.0 + #1039 CI|FreeBSD: Do not install CMake meta-package + + Special thanks to: + Bénédikt Tran + Berkay Eren Ürün + Daniel Engberg + Hanno Böck + Matthew Fernandez + Rolf Eike Beer + Sam James + Tim Bray + and + Clang/GCC UndefinedBehaviorSanitizer + OSS-Fuzz / ClusterFuzz + Z3 Theorem Prover + +Release 2.7.2 Tue September 16 2025 + Security fixes: + #1018 #1034 CVE-2025-59375 -- Disallow use of disproportional amounts of + dynamic memory from within an Expat parser (e.g. previously + a ~250 KiB sized document was able to cause allocation of + ~800 MiB from the heap, i.e. an "amplification" of factor + ~3,300); once a threshold (that defaults to 64 MiB) is + reached, a maximum amplification factor (that defaults to + 100.0) is enforced, and violating documents are rejected + with an out-of-memory error. + There are two new API functions to fine-tune this new + behavior: + - XML_SetAllocTrackerActivationThreshold + - XML_SetAllocTrackerMaximumAmplification . + If you ever need to increase these defaults for non-attack + XML payload, please file a bug report with libexpat. + There is also a new environment variable + EXPAT_MALLOC_DEBUG=(0|1|2) to control the verbosity + of allocations debugging at runtime, disabled by default. + Known impact is (reliable and easy) denial of service: + CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H/E:H/RL:O/RC:C + (Base Score: 7.5, Temporal Score: 7.2) + Please note that a layer of compression around XML can + significantly reduce the minimum attack payload size. + Distributors intending to backport (or cherry-pick) the + fix need to copy 99% of the related pull request, not just + the "lib: Implement tracking of dynamic memory allocations" + commit, to not end up with a state that literally does both + too much and too little at the same time. Appending ".diff" + to the pull request URL could be of help. + + Other changes: + #1008 #1017 Autotools|macOS: Sync CMake templates with CMake 3.31 + #1007 CMake: Drop support for CMake <3.15 + #1004 CMake: Fix off_t detection for -Werror + #1007 CMake|Windows: Fix -DEXPAT_MSVC_STATIC_CRT=ON + #1013 Windows: Drop support for Visual Studio <=16.0/2019 + #1026 xmlwf: Mention supported environment variables in + --help output + #1024 xmlwf: Fix (internal) help generator + #1034 docs: Promote the contract to call function + XML_FreeContentModel when registering a custom + element declaration handler (via a call to function + XML_SetElementDeclHandler) + #1027 docs: Add missing

..

wrap + #994 docs: Drop AppVeyor badge + #1000 tests: Fix portable_strndup + #1036 Drop casts around malloc/free/realloc that C99 does not need + #1010 Replace empty for loops with while loops + #1011 Add const with internal XmlInitUnknownEncodingNS + #14 #1037 Drop an OpenVMS support leftover + #999 #1001 Address more clang-tidy warnings + #1030 #1038 Version info bumped from 11:2:10 (libexpat*.so.1.10.2) + to 12:0:11 (libexpat*.so.1.11.0); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #1003 CI: Cover compilation on FreeBSD + #1009 #1035 CI: Upgrade Clang from 19 to 21 + #1031 CI: Make calling Cppcheck without --suppress=objectIndex + and --suppress=unknownMacro possible + #1013 CI|Windows: Get off of deprecated image "windows-2019" + #1008 #1017 .. + #1023 #1025 CI: Adapt to breaking changes in GitHub Actions + + Special thanks to: + Alexander Bluhm + Neil Pang + Theo Buehler + and + GNU Time + OSS-Fuzz / ClusterFuzz + Perl XML::Parser + +Release 2.7.1 Thu March 27 2025 + Bug fixes: + #980 #989 Restore event pointer behavior from Expat 2.6.4 + (that the fix to CVE-2024-8176 changed in 2.7.0); + affected API functions are: + - XML_GetCurrentByteCount + - XML_GetCurrentByteIndex + - XML_GetCurrentColumnNumber + - XML_GetCurrentLineNumber + - XML_GetInputContext + + Other changes: + #976 #977 Autotools: Integrate files "fuzz/xml_lpm_fuzzer.{cpp,proto}" + with Automake that were missing from 2.7.0 release tarballs + #983 #984 Fix printf format specifiers for 32bit Emscripten + #992 docs: Promote OpenSSF Best Practices self-certification + #978 tests/benchmark: Resolve mistaken double close + #986 Address Frama-C warnings + #990 #993 Version info bumped from 11:1:10 (libexpat*.so.1.10.1) + to 11:2:10 (libexpat*.so.1.10.2); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #982 CI: Start running Perl XML::Parser integration tests + #987 CI: Enforce Clang Static Analyzer clean code + #991 CI: Re-enable warning clang-analyzer-valist.Uninitialized + for clang-tidy + #981 CI: Cover compilation with musl + #983 #984 CI: Cover compilation with 32bit Emscripten + #976 #977 CI: Protect against fuzzer files missing from future + release archives + + Special thanks to: + Berkay Eren Ürün + Matthew Fernandez + and + Perl XML::Parser + +Release 2.7.0 Thu March 13 2025 + Security fixes: + #893 #973 CVE-2024-8176 -- Fix crash from chaining a large number + of entities caused by stack overflow by resolving use of + recursion, for all three uses of entities: + - general entities in character data ("&g1;") + - general entities in attribute values ("") + - parameter entities ("%p1;") + Known impact is (reliable and easy) denial of service: + CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H/E:H/RL:O/RC:C + (Base Score: 7.5, Temporal Score: 7.2) + Please note that a layer of compression around XML can + significantly reduce the minimum attack payload size. + + Other changes: + #935 #937 Autotools: Make generated CMake files look for + libexpat.@SO_MAJOR@.dylib on macOS + #925 Autotools: Sync CMake templates with CMake 3.29 + #945 #962 #966 CMake: Drop support for CMake <3.13 + #942 CMake: Small fuzzing related improvements + #921 docs: Add missing documentation of error code + XML_ERROR_NOT_STARTED that was introduced with 2.6.4 + #941 docs: Document need for C++11 compiler for use from C++ + #959 tests/benchmark: Fix a (harmless) TOCTTOU + #944 Windows: Fix installer target location of file xmlwf.xml + for CMake + #953 Windows: Address warning -Wunknown-warning-option + about -Wno-pedantic-ms-format from LLVM MinGW + #971 Address Cppcheck warnings + #969 #970 Mass-migrate links from http:// to https:// + #947 #958 .. + #974 #975 Document changes since the previous release + #974 #975 Version info bumped from 11:0:10 (libexpat*.so.1.10.0) + to 11:1:10 (libexpat*.so.1.10.1); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #926 tests: Increase robustness + #927 #932 .. + #930 #933 tests: Increase test coverage + #617 #950 .. + #951 #952 .. + #954 #955 .. Fuzzing: Add new fuzzer "xml_lpm_fuzzer" based on + #961 Google's libprotobuf-mutator ("LPM") + #957 Fuzzing|CI: Start producing fuzzing code coverage reports + #936 CI: Pass -q -q for LCOV >=2.1 in coverage.sh + #942 CI: Small fuzzing related improvements + #139 #203 .. + #791 #946 CI: Make GitHub Actions build using MSVC on Windows and + produce 32bit and 64bit Windows binaries + #956 CI: Get off of about-to-be-removed Ubuntu 20.04 + #960 #964 CI: Start uploading to Coverity Scan for static analysis + #972 CI: Stop loading DTD from the internet to address flaky CI + #971 CI: Adapt to breaking changes in Cppcheck + + Special thanks to: + Alexander Gieringer + Berkay Eren Ürün + Hanno Böck + Jann Horn + Mark Brand + Sebastian Andrzej Siewior + Snild Dolkow + Thomas Pröll + Tomas Korbar + valord577 + and + Google Project Zero + Linutronix + Red Hat + Siemens + +Release 2.6.4 Wed November 6 2024 + Security fixes: + #915 CVE-2024-50602 -- Fix crash within function XML_ResumeParser + from a NULL pointer dereference by disallowing function + XML_StopParser to (stop or) suspend an unstarted parser. + A new error code XML_ERROR_NOT_STARTED was introduced to + properly communicate this situation. // CWE-476 CWE-754 + + Other changes: + #903 CMake: Add alias target "expat::expat" + #905 docs: Document use via CMake >=3.18 with FetchContent + and SOURCE_SUBDIR and its consequences + #902 tests: Reduce use of global parser instance + #904 tests: Resolve duplicate handler + #317 #918 tests: Improve tests on doctype closing (ex CVE-2019-15903) + #914 Fix signedness of format strings + #915 For use from C++, expat.h started requiring C++11 due to + use of C99 features + #919 #920 Version info bumped from 10:3:9 (libexpat*.so.1.9.3) + to 11:0:10 (libexpat*.so.1.10.0); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #907 CI: Upgrade Clang from 18 to 19 + #913 CI: Drop macos-12 and add macos-15 + #910 CI: Adapt to breaking changes in GitHub Actions + #898 Add missing entries to .gitignore + + Special thanks to: + Hanno Böck + José Eduardo Gutiérrez Conejo + José Ricardo Cardona Quesada + +Release 2.6.3 Wed September 4 2024 + Security fixes: + #887 #890 CVE-2024-45490 -- Calling function XML_ParseBuffer with + len < 0 without noticing and then calling XML_GetBuffer + will have XML_ParseBuffer fail to recognize the problem + and XML_GetBuffer corrupt memory. + With the fix, XML_ParseBuffer now complains with error + XML_ERROR_INVALID_ARGUMENT just like sibling XML_Parse + has been doing since Expat 2.2.1, and now documented. + Impact is denial of service to potentially artitrary code + execution. + #888 #891 CVE-2024-45491 -- Internal function dtdCopy can have an + integer overflow for nDefaultAtts on 32-bit platforms + (where UINT_MAX equals SIZE_MAX). + Impact is denial of service to potentially artitrary code + execution. + #889 #892 CVE-2024-45492 -- Internal function nextScaffoldPart can + have an integer overflow for m_groupSize on 32-bit + platforms (where UINT_MAX equals SIZE_MAX). + Impact is denial of service to potentially artitrary code + execution. + + Other changes: + #851 #879 Autotools: Sync CMake templates with CMake 3.28 + #853 Autotools: Always provide path to find(1) for portability + #861 Autotools: Ensure that the m4 directory always exists. + #870 Autotools: Simplify handling of SIZEOF_VOID_P + #869 Autotools: Support non-GNU sed + #856 Autotools|CMake: Fix main() to main(void) + #865 Autotools|CMake: Fix compile tests for HAVE_SYSCALL_GETRANDOM + #863 Autotools|CMake: Stop requiring dos2unix + #854 #855 CMake: Fix check for symbols size_t and off_t + #864 docs|tests: Convert README to Markdown and update + #741 Windows: Drop support for Visual Studio <=15.0/2017 + #886 Drop needless XML_DTD guards around is_param access + #885 Fix typo in a code comment + #894 #896 Version info bumped from 10:2:9 (libexpat*.so.1.9.2) + to 10:3:9 (libexpat*.so.1.9.3); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #880 Readme: Promote the call for help + #868 CI: Fix various issues + #849 CI: Allow triggering GitHub Actions workflows manually + #851 #872 .. + #873 #879 CI: Adapt to breaking changes in GitHub Actions + + Special thanks to: + Alexander Bluhm + Berkay Eren Ürün + Dag-Erling Smørgrav + Ferenc Géczi + TaiYou + +Release 2.6.2 Wed March 13 2024 + Security fixes: + #839 #842 CVE-2024-28757 -- Prevent billion laughs attacks with + isolated use of external parsers. Please see the commit + message of commit 1d50b80cf31de87750103656f6eb693746854aa8 + for details. + + Bug fixes: + #839 #841 Reject direct parameter entity recursion + and avoid the related undefined behavior + + Other changes: + #847 Autotools: Fix build for DOCBOOK_TO_MAN containing spaces + #837 Add missing #821 and #824 to 2.6.1 change log + #838 #843 Version info bumped from 10:1:9 (libexpat*.so.1.9.1) + to 10:2:9 (libexpat*.so.1.9.2); see https://verbump.de/ + for what these numbers do + + Special thanks to: + Philippe Antoine + Tomas Korbar + and + Clang UndefinedBehaviorSanitizer + OSS-Fuzz / ClusterFuzz + +Release 2.6.1 Thu February 29 2024 + Bug fixes: + #817 Make tests independent of CPU speed, and thus more robust + #828 #836 Expose billion laughs API with XML_DTD defined and + XML_GE undefined, regression from 2.6.0 + + Other changes: + #829 Hide test-only code behind new internal macro + #833 Autotools: Reject expat_config.h.in defining SIZEOF_VOID_P + #821 #824 Autotools: Fix "make clean" for case: + ./configure --without-docbook && make clean all + #819 Address compiler warnings + #832 #834 Version info bumped from 10:0:9 (libexpat*.so.1.9.0) + to 10:1:9 (libexpat*.so.1.9.1); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #818 CI: Adapt to breaking changes in clang-format + + Special thanks to: + David Hall + Snild Dolkow + +Release 2.6.0 Tue February 6 2024 + Security fixes: + #789 #814 CVE-2023-52425 -- Fix quadratic runtime issues with big tokens + that can cause denial of service, in partial where + dealing with compressed XML input. Applications + that parsed a document in one go -- a single call to + functions XML_Parse or XML_ParseBuffer -- were not affected. + The smaller the chunks/buffers you use for parsing + previously, the bigger the problem prior to the fix. + Backporters should be careful to no omit parts of + pull request #789 and to include earlier pull request #771, + in order to not break the fix. + #777 CVE-2023-52426 -- Fix billion laughs attacks for users + compiling *without* XML_DTD defined (which is not common). + Users with XML_DTD defined have been protected since + Expat >=2.4.0 (and that was CVE-2013-0340 back then). + + Bug fixes: + #753 Fix parse-size-dependent "invalid token" error for + external entities that start with a byte order mark + #780 Fix NULL pointer dereference in setContext via + XML_ExternalEntityParserCreate for compilation with + XML_DTD undefined + #812 #813 Protect against closing entities out of order + + Other changes: + #723 Improve support for arc4random/arc4random_buf + #771 #788 Improve buffer growth in XML_GetBuffer and XML_Parse + #761 #770 xmlwf: Support --help and --version + #759 #770 xmlwf: Support custom buffer size for XML_GetBuffer and read + #744 xmlwf: Improve language and URL clickability in help output + #673 examples: Add new example "element_declarations.c" + #764 Be stricter about macro XML_CONTEXT_BYTES at build time + #765 Make inclusion to expat_config.h consistent + #726 #727 Autotools: configure.ac: Support --disable-maintainer-mode + #678 #705 .. + #706 #733 #792 Autotools: Sync CMake templates with CMake 3.26 + #795 Autotools: Make installation of shipped man page doc/xmlwf.1 + independent of docbook2man availability + #815 Autotools|CMake: Add missing -DXML_STATIC to pkg-config file + section "Cflags.private" in order to fix compilation + against static libexpat using pkg-config on Windows + #724 #751 Autotools|CMake: Require a C99 compiler + (a de-facto requirement already since Expat 2.2.2 of 2017) + #793 Autotools|CMake: Fix PACKAGE_BUGREPORT variable + #750 #786 Autotools|CMake: Make test suite require a C++11 compiler + #749 CMake: Require CMake >=3.5.0 + #672 CMake: Lowercase off_t and size_t to help a bug in Meson + #746 CMake: Sort xmlwf sources alphabetically + #785 CMake|Windows: Fix generation of DLL file version info + #790 CMake: Build tests/benchmark/benchmark.c as well for + a build with -DEXPAT_BUILD_TESTS=ON + #745 #757 docs: Document the importance of isFinal + adjust tests + accordingly + #736 docs: Improve use of "NULL" and "null" + #713 docs: Be specific about version of XML (XML 1.0r4) + and version of C (C99); (XML 1.0r5 will need a sponsor.) + #762 docs: reference.html: Promote function XML_ParseBuffer more + #779 docs: reference.html: Add HTML anchors to XML_* macros + #760 docs: reference.html: Upgrade to OK.css 1.2.0 + #763 #739 docs: Fix typos + #696 docs|CI: Use HTTPS URLs instead of HTTP at various places + #669 #670 .. + #692 #703 .. + #733 #772 Address compiler warnings + #798 #800 Address clang-tidy warnings + #775 #776 Version info bumped from 9:10:8 (libexpat*.so.1.8.10) + to 10:0:9 (libexpat*.so.1.9.0); see https://verbump.de/ + for what these numbers do + + Infrastructure: + #700 #701 docs: Document security policy in file SECURITY.md + #766 docs: Improve parse buffer variables in-code documentation + #674 #738 .. + #740 #747 .. + #748 #781 #782 Refactor coverage and conformance tests + #714 #716 Refactor debug level variables to unsigned long + #671 Improve handling of empty environment variable value + in function getDebugLevel (without visible user effect) + #755 #774 .. + #758 #783 .. + #784 #787 tests: Improve test coverage with regard to parse chunk size + #660 #797 #801 Fuzzing: Improve fuzzing coverage + #367 #799 Fuzzing|CI: Start running OSS-Fuzz fuzzing regression tests + #698 #721 CI: Resolve some Travis CI leftovers + #669 CI: Be robust towards absence of Git tags + #693 #694 CI: Set permissions to "contents: read" for security + #709 CI: Pin all GitHub Actions to specific commits for security + #739 CI: Reject spelling errors using codespell + #798 CI: Enforce clang-tidy clean code + #773 #808 .. + #809 #810 CI: Upgrade Clang from 15 to 18 + #796 CI: Start using Clang's Control Flow Integrity sanitizer + #675 #720 #722 CI: Adapt to breaking changes in GitHub Actions Ubuntu images + #689 CI: Adapt to breaking changes in Clang/LLVM Debian packaging + #763 CI: Adapt to breaking changes in codespell + #803 CI: Adapt to breaking changes in Cppcheck + + Special thanks to: + Ivan Galkin + Joyce Brum + Philippe Antoine + Rhodri James + Snild Dolkow + spookyahell + Steven Garske + and + Clang AddressSanitizer + Clang UndefinedBehaviorSanitizer + codespell + GCC Farm Project + OSS-Fuzz + Sony Mobile + +Release 2.5.0 Tue October 25 2022 + Security fixes: + #616 #649 #650 CVE-2022-43680 -- Fix heap use-after-free after overeager + destruction of a shared DTD in function + XML_ExternalEntityParserCreate in out-of-memory situations. + Expected impact is denial of service or potentially + arbitrary code execution. + + Bug fixes: + #612 #645 Fix corruption from undefined entities + #613 #654 Fix case when parsing was suspended while processing nested + entities + #616 #652 #653 Stop leaking opening tag bindings after a closing tag + mismatch error where a parser is reset through + XML_ParserReset and then reused to parse + #656 CMake: Fix generation of pkg-config file + #658 MinGW|CMake: Fix static library name + + Other changes: + #663 Protect header expat_config.h from multiple inclusion + #666 examples: Make use of XML_GetBuffer and be more + consistent across examples + #648 Address compiler warnings + #667 #668 Version info bumped from 9:9:8 to 9:10:8; + see https://verbump.de/ for what these numbers do + + Special thanks to: + Jann Horn + Mark Brand + Osyotr + Rhodri James + and + Google Project Zero + +Release 2.4.9 Tue September 20 2022 + Security fixes: + #629 #640 CVE-2022-40674 -- Heap use-after-free vulnerability in + function doContent. Expected impact is denial of service + or potentially arbitrary code execution. + + Bug fixes: + #634 MinGW: Fix mis-compilation for -D__USE_MINGW_ANSI_STDIO=0 + #614 docs: Fix documentation on effect of switch XML_DTD on + symbol visibility in doc/reference.html + + Other changes: + #638 MinGW: Make fix-xmltest-log.sh drop more Wine bug output + #596 #625 Autotools: Sync CMake templates with CMake 3.22 + #608 CMake: Migrate from use of CMAKE_*_POSTFIX to + dedicated variables EXPAT_*_POSTFIX to stop affecting + other projects + #597 #599 Windows|CMake: Add missing -DXML_STATIC to test runners + and fuzzers + #512 #621 Windows|CMake: Render .def file from a template to fix + linking with -DEXPAT_DTD=OFF and/or -DEXPAT_ATTR_INFO=ON + #611 #621 MinGW|CMake: Apply MSVC .def file when linking + #622 #624 MinGW|CMake: Sync library name with GNU Autotools, + i.e. produce libexpat-1.dll rather than libexpat.dll + by default. Filename libexpat.dll.a is unaffected. + #632 MinGW|CMake: Set missing variable CMAKE_RC_COMPILER in + toolchain file "cmake/mingw-toolchain.cmake" to avoid + error "windres: Command not found" on e.g. Ubuntu 20.04 + #597 #627 CMake: Unify inconsistent use of set() and option() in + context of public build time options to take need for + set(.. FORCE) in projects using Expat by means of + add_subdirectory(..) off Expat's users' shoulders + #626 #641 Stop exporting API symbols when building a static library + #644 Resolve use of deprecated "fgrep" by "grep -F" + #620 CMake: Make documentation on variables a bit more consistent + #636 CMake: Drop leading whitespace from a #cmakedefine line in + file expat_config.h.cmake + #594 xmlwf: Fix harmless variable mix-up in function nsattcmp + #592 #593 #610 Address Cppcheck warnings + #643 Address Clang 15 compiler warnings + #642 #644 Version info bumped from 9:8:8 to 9:9:8; + see https://verbump.de/ for what these numbers do + + Infrastructure: + #597 #598 CI: Windows: Start covering MSVC 2022 + #619 CI: macOS: Migrate off deprecated macOS 10.15 + #632 CI: Linux: Make migration off deprecated Ubuntu 18.04 work + #643 CI: Upgrade Clang from 14 to 15 + #637 apply-clang-format.sh: Add support for BSD find + #633 coverage.sh: Exclude MinGW headers + #635 coverage.sh: Fix name collision for -funsigned-char + + Special thanks to: + David Faure + Felix Wilhelm + Frank Bergmann + Rhodri James + Rosen Penev + Thijs Schreijer + Vincent Torri + and + Google Project Zero + +Release 2.4.8 Mon March 28 2022 + Other changes: + #587 pkg-config: Move "-lm" to section "Libs.private" + #587 CMake|MSVC: Fix pkg-config section "Libs" + #55 #582 CMake|macOS: Start using linker arguments + "-compatibility_version " and + "-current_version " in a way compatible with + GNU Libtool + #590 #591 Version info bumped from 9:7:8 to 9:8:8; + see https://verbump.de/ for what these numbers do + + Infrastructure: + #589 CI: Upgrade Clang from 13 to 14 + + Special thanks to: + evpobr + Kai Pastor + Sam James + +Release 2.4.7 Fri March 4 2022 + Bug fixes: + #572 #577 Relax fix to CVE-2022-25236 (introduced with release 2.4.5) + with regard to all valid URI characters (RFC 3986), + i.e. the following set (excluding whitespace): + ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz + 0123456789 % -._~ :/?#[]@ !$&'()*+,;= + + Other changes: + #555 #570 #581 CMake|Windows: Store Expat version in the DLL + #577 Document consequences of namespace separator choices not just + in doc/reference.html but also in header + #577 Document Expat's lack of validation of namespace URIs against + RFC 3986, and that the XML 1.0r4 specification doesn't + require Expat to validate namespace URIs, and that Expat + may do more in that regard in future releases. + If you find need for strict RFC 3986 URI validation on + application level today, https://uriparser.github.io/ may + be of interest. + #579 Fix documentation of XML_EndDoctypeDeclHandler in + #575 Document that a call to XML_FreeContentModel can be done at + a later time from outside the element declaration handler + #574 Make hardcoded namespace URIs easier to find in code + #573 Update documentation on use of XML_POOR_ENTOPY on Solaris + #569 #571 tests: Resolve use of macros NAN and INFINITY for GNU G++ + 4.8.2 on Solaris. + #578 #580 Version info bumped from 9:6:8 to 9:7:8; + see https://verbump.de/ for what these numbers do + + Special thanks to: + Jeffrey Walton + Johnny Jazeix + Thijs Schreijer + +Release 2.4.6 Sun February 20 2022 + Bug fixes: + #566 Fix a regression introduced by the fix for CVE-2022-25313 + in release 2.4.5 that affects applications that (1) + call function XML_SetElementDeclHandler and (2) are + parsing XML that contains nested element declarations + (e.g. ""). + + Other changes: + #567 #568 Version info bumped from 9:5:8 to 9:6:8; + see https://verbump.de/ for what these numbers do + + Special thanks to: + Matt Sergeant + Samanta Navarro + Sergei Trofimovich + and + NixOS + Perl XML::Parser + +Release 2.4.5 Fri February 18 2022 + Security fixes: + #562 CVE-2022-25235 -- Passing malformed 2- and 3-byte UTF-8 + sequences (e.g. from start tag names) to the XML + processing application on top of Expat can cause + arbitrary damage (e.g. code execution) depending + on how invalid UTF-8 is handled inside the XML + processor; validation was not their job but Expat's. + Exploits with code execution are known to exist. + #561 CVE-2022-25236 -- Passing (one or more) namespace separator + characters in "xmlns[:prefix]" attribute values + made Expat send malformed tag names to the XML + processor on top of Expat which can cause + arbitrary damage (e.g. code execution) depending + on such unexpectable cases are handled inside the XML + processor; validation was not their job but Expat's. + Exploits with code execution are known to exist. + #558 CVE-2022-25313 -- Fix stack exhaustion in doctype parsing + that could be triggered by e.g. a 2 megabytes + file with a large number of opening braces. + Expected impact is denial of service or potentially + arbitrary code execution. + #560 CVE-2022-25314 -- Fix integer overflow in function copyString; + only affects the encoding name parameter at parser creation + time which is often hardcoded (rather than user input), + takes a value in the gigabytes to trigger, and a 64-bit + machine. Expected impact is denial of service. + #559 CVE-2022-25315 -- Fix integer overflow in function storeRawNames; + needs input in the gigabytes and a 64-bit machine. + Expected impact is denial of service or potentially + arbitrary code execution. + + Other changes: + #557 #564 Version info bumped from 9:4:8 to 9:5:8; + see https://verbump.de/ for what these numbers do + + Special thanks to: + Ivan Fratric + Samanta Navarro + and + Google Project Zero + JetBrains + +Release 2.4.4 Sun January 30 2022 + Security fixes: + #550 CVE-2022-23852 -- Fix signed integer overflow + (undefined behavior) in function XML_GetBuffer + (that is also called by function XML_Parse internally) + for when XML_CONTEXT_BYTES is defined to >0 (which is both + common and default). + Impact is denial of service or more. + #551 CVE-2022-23990 -- Fix unsigned integer overflow in function + doProlog triggered by large content in element type + declarations when there is an element declaration handler + present (from a prior call to XML_SetElementDeclHandler). + Impact is denial of service or more. + + Bug fixes: + #544 #545 xmlwf: Fix a memory leak on output file opening error + + Other changes: + #546 Autotools: Fix broken CMake support under Cygwin + #554 Windows: Add missing files to the installer to fix + compilation with CMake from installed sources + #552 #554 Version info bumped from 9:3:8 to 9:4:8; + see https://verbump.de/ for what these numbers do + + Special thanks to: + Carlo Bramini + hwt0415 + Roland Illig + Samanta Navarro + and + Clang LeakSan and the Clang team + +Release 2.4.3 Sun January 16 2022 + Security fixes: + #531 #534 CVE-2021-45960 -- Fix issues with left shifts by >=29 places + resulting in + a) realloc acting as free + b) realloc allocating too few bytes + c) undefined behavior + depending on architecture and precise value + for XML documents with >=2^27+1 prefixed attributes + on a single XML tag a la + "" + where XML_ParserCreateNS is used to create the parser + (which needs argument "-n" when running xmlwf). + Impact is denial of service, or more. + #532 #538 CVE-2021-46143 (ZDI-CAN-16157) -- Fix integer overflow + on variable m_groupSize in function doProlog leading + to realloc acting as free. + Impact is denial of service or more. + #539 CVE-2022-22822 to CVE-2022-22827 -- Prevent integer overflows + near memory allocation at multiple places. Mitre assigned + a dedicated CVE for each involved internal C function: + - CVE-2022-22822 for function addBinding + - CVE-2022-22823 for function build_model + - CVE-2022-22824 for function defineAttribute + - CVE-2022-22825 for function lookup + - CVE-2022-22826 for function nextScaffoldPart + - CVE-2022-22827 for function storeAtts + Impact is denial of service or more. + + Other changes: + #535 CMake: Make call to file(GENERATE [..]) work for CMake <3.19 + #541 Autotools|CMake: MinGW: Make run.sh(.in) work for Cygwin + and MSYS2 by not going through Wine on these platforms + #527 #528 Address compiler warnings + #533 #543 Version info bumped from 9:2:8 to 9:3:8; + see https://verbump.de/ for what these numbers do + + Infrastructure: + #536 CI: Check for realistic minimum CMake version + #529 #539 CI: Cover compilation with -m32 + #529 CI: Store coverage reports as artifacts for download + #528 CI: Upgrade Clang from 11 to 13 + + Special thanks to: + An anonymous whitehat + Christopher Degawa + J. Peter Mugaas + Tyson Smith + and + GCC Farm Project + Trend Micro Zero Day Initiative + +Release 2.4.2 Sun December 19 2021 + Other changes: + #509 #510 Link againgst libm for function "isnan" + #513 #514 Include expat_config.h as early as possible + #498 Autotools: Include files with release archives: + - buildconf.sh + - fuzz/*.c + #507 #519 Autotools: Sync CMake templates with CMake 3.20 + #495 #524 CMake: MinGW: Fix pkg-config section "Libs" for + - non-release build types (e.g. -DCMAKE_BUILD_TYPE=Debug) + - multi-config CMake generators (e.g. Ninja Multi-Config) + #502 #503 docs: Document that function XML_GetBuffer may return NULL + when asking for a buffer of 0 (zero) bytes size + #522 #523 docs: Fix return value docs for both + XML_SetBillionLaughsAttackProtection* functions + #525 #526 Version info bumped from 9:1:8 to 9:2:8; + see https://verbump.de/ for what these numbers do + + Special thanks to: + Donghee Na + Joergen Ibsen + Kai Pastor + +Release 2.4.1 Sun May 23 2021 + Bug fixes: + #488 #490 Autotools: Fix installed header expat_config.h for multilib + systems; regression introduced in 2.4.0 by pull request #486 + + Other changes: + #491 #492 Version info bumped from 9:0:8 to 9:1:8; + see https://verbump.de/ for what these numbers do + + Special thanks to: + Gentoo's QA check "multilib_check_headers" + +Release 2.4.0 Sun May 23 2021 + Security fixes: + #34 #466 #484 CVE-2013-0340/CWE-776 -- Protect against billion laughs attacks + (denial-of-service; flavors targeting CPU time or RAM or both, + leveraging general entities or parameter entities or both) + by tracking and limiting the input amplification factor + ( := ( + ) / ). + By conservative default, amplification up to a factor of 100.0 + is tolerated and rejection only starts after 8 MiB of output bytes + (= + ) have been processed. + The fix adds the following to the API: + - A new error code XML_ERROR_AMPLIFICATION_LIMIT_BREACH to + signals this specific condition. + - Two new API functions .. + - XML_SetBillionLaughsAttackProtectionMaximumAmplification and + - XML_SetBillionLaughsAttackProtectionActivationThreshold + .. to further tighten billion laughs protection parameters + when desired. Please see file "doc/reference.html" for details. + If you ever need to increase the defaults for non-attack XML + payload, please file a bug report with libexpat. + - Two new XML_FEATURE_* constants .. + - that can be queried using the XML_GetFeatureList function, and + - that are shown in "xmlwf -v" output. + - Two new environment variable switches .. + - EXPAT_ACCOUNTING_DEBUG=(0|1|2|3) and + - EXPAT_ENTITY_DEBUG=(0|1) + .. for runtime debugging of accounting and entity processing. + Specific behavior of these values may change in the future. + - Two new command line arguments "-a FACTOR" and "-b BYTES" + for xmlwf to further tighten billion laughs protection + parameters when desired. + If you ever need to increase the defaults for non-attack XML + payload, please file a bug report with libexpat. + + Bug fixes: + #332 #470 For (non-default) compilation with -DEXPAT_MIN_SIZE=ON (CMake) + or CPPFLAGS=-DXML_MIN_SIZE (GNU Autotools): Fix segfault + for UTF-16 payloads containing CDATA sections. + #485 #486 Autotools: Fix generated CMake files for non-64bit and + non-Linux platforms (e.g. macOS and MinGW in particular) + that were introduced with release 2.3.0 + + Other changes: + #468 #469 xmlwf: Improve help output and the xmlwf man page + #463 xmlwf: Improve maintainability through some refactoring + #477 xmlwf: Fix man page DocBook validity + #456 Autotools: Sync CMake templates with CMake 3.18 + #458 #459 CMake: Support absolute paths for both CMAKE_INSTALL_LIBDIR + and CMAKE_INSTALL_INCLUDEDIR + #471 #481 CMake: Add support for standard variable BUILD_SHARED_LIBS + #457 Unexpose symbol _INTERNAL_trim_to_complete_utf8_characters + #467 Resolve macro HAVE_EXPAT_CONFIG_H + #472 Delete unused legacy helper file "conftools/PrintPath" + #473 #483 Improve attribution + #464 #465 #477 doc/reference.html: Fix XHTML validity + #475 #478 doc/reference.html: Replace the 90s look by OK.css + #479 Version info bumped from 8:0:7 to 9:0:8 + due to addition of new symbols and error codes; + see https://verbump.de/ for what these numbers do + + Infrastructure: + #456 CI: Enable periodic runs + #457 CI: Start covering the list of exported symbols + #474 CI: Isolate coverage task + #476 #482 CI: Adapt to breaking changes in image "ubuntu-18.04" + #477 CI: Cover well-formedness and DocBook/XHTML validity + of doc/reference.html and doc/xmlwf.xml + + Special thanks to: + Dimitry Andric + Eero Helenius + Nick Wellnhofer + Rhodri James + Tomas Korbar + Yury Gribov + and + Clang LeakSan + JetBrains + OSS-Fuzz + +Release 2.3.0 Thu March 25 2021 + Bug fixes: + #438 When calling XML_ParseBuffer without a prior successful call to + XML_GetBuffer as a user, no longer trigger undefined behavior + (by adding an integer to a NULL pointer) but rather return + XML_STATUS_ERROR and set the error code to (new) code + XML_ERROR_NO_BUFFER. Found by UBSan (UndefinedBehaviorSanitizer) + of Clang 11 (but not Clang 9). + #444 xmlwf: Exit status 2 was used for both: + - malformed input files (documented) and + - invalid command-line arguments (undocumented). + The case of invalid command-line arguments now + has its own exit status 4, resolving the ambiguity. + + Other changes: + #439 xmlwf: Add argument -k to allow continuing after + non-fatal errors + #439 xmlwf: Add section about exit status to the -h help output + #422 #426 #447 Windows: Drop support for Visual Studio <=14.0/2015 + #434 Windows: CMake: Detect unsupported Visual Studio at + configure time (rather than at compile time) + #382 #428 testrunner: Make verbose mode (argument "-v") report + about passed tests, and make default mode report about + failures, as well. + #442 CMake: Call "enable_language(CXX)" prior to tinkering + with CMAKE_CXX_* variables + #448 Document use of libexpat from a CMake-based project + #451 Autotools: Install CMake files as generated by CMake 3.19.6 + so that users with "find_package(expat [..] CONFIG [..])" + are served on distributions that are *not* using the CMake + build system inside for libexpat packaging + #436 #437 Autotools: Drop obsolescent macro AC_HEADER_STDC + #450 #452 Autotools: Resolve use of obsolete macro AC_CONFIG_HEADER + #441 Address compiler warnings + #443 Version info bumped from 7:12:6 to 8:0:7 + due to addition of error code XML_ERROR_NO_BUFFER + (see https://verbump.de/ for what these numbers do) + + Infrastructure: + #435 #446 Replace Travis CI by GitHub Actions + + Special thanks to: + Alexander Richardson + Oleksandr Popovych + Thomas Beutlich + Tim Bray + and + Clang LeakSan, Clang 11 UBSan and the Clang team + +Release 2.2.10 Sat October 3 2020 + Bug fixes: + #390 #395 #398 Fix undefined behavior during parsing caused by + pointer arithmetic with NULL pointers + #404 #405 Fix reading uninitialized variable during parsing + #406 xmlwf: Add missing check for malloc NULL return + + Other changes: + #396 Windows: Drop support for Visual Studio <=8.0/2005 + #409 Windows: Add missing file "Changes" to the installer + to fix compilation with CMake from installed sources + #403 xmlwf: Document exit codes in xmlwf manpage and + exit with code 3 (rather than code 1) for output errors + when used with "-d DIRECTORY" + #356 #359 MinGW: Provide declaration of rand_s for mingwrt <5.3.0 + #383 #392 Autotools: Use -Werror while configure tests the compiler + for supported compile flags to avoid false positives + #383 #393 #394 Autotools: Improve handling of user (C|CPP|CXX|LD)FLAGS, + e.g. ensure that they have the last word over flags added + while running ./configure + #360 CMake: Create libexpatw.{dll,so} and expatw.pc (with emphasis + on suffix "w") with -DEXPAT_CHAR_TYPE=(ushort|wchar_t) + #360 CMake: Detect and deny unsupported build combinations + involving -DEXPAT_CHAR_TYPE=(ushort|wchar_t) + #360 CMake: Install pre-compiled shipped xmlwf.1 manpage in case + of -DEXPAT_BUILD_DOCS=OFF + #375 #380 #419 CMake: Fix use of Expat by means of add_subdirectory + #407 #408 CMake: Keep expat target name constant at "expat" + (i.e. refrain from using the target name to control + build artifact filenames) + #385 CMake: Fix compilation with -DEXPAT_SHARED_LIBS=OFF for + Windows + CMake: Expose man page compilation as target "xmlwf-manpage" + #413 #414 CMake: Introduce option EXPAT_BUILD_PKGCONFIG + to control generation of pkg-config file "expat.pc" + #424 CMake: Add minimalistic support for building binary packages + with CMake target "package"; based on CPack + #366 CMake: Add option -DEXPAT_OSSFUZZ_BUILD=(ON|OFF) with + default OFF to build fuzzer code against OSS-Fuzz and + related environment variable LIB_FUZZING_ENGINE + #354 Fix testsuite for -DEXPAT_DTD=OFF and -DEXPAT_NS=OFF, each + #354 #355 .. + #356 #412 Address compiler warnings + #368 #369 Address pngcheck warnings with doc/*.png images + #425 Version info bumped from 7:11:6 to 7:12:6 + + Special thanks to: + asavah + Ben Wagner + Bhargava Shastry + Frank Landgraf + Jeffrey Walton + Joe Orton + Kleber Tarcísio + Ma Lin + Maciej Sroczyński + Mohammed Khajapasha + Vadim Zeitlin + and + Cppcheck 2.0 and the Cppcheck team + +Release 2.2.9 Wed September 25 2019 + Other changes: + examples: Drop executable bits from elements.c + #349 Windows: Change the name of the Windows DLLs from expat*.dll + to libexpat*.dll once more (regression from 2.2.8, first + fixed in 1.95.3, issue #61 on SourceForge today, + was issue #432456 back then); needs a fix due + case-insensitive file systems on Windows and the fact that + Perl's XML::Parser::Expat compiles into Expat.dll. + #347 Windows: Only define _CRT_RAND_S if not defined + Version info bumped from 7:10:6 to 7:11:6 + + Special thanks to: + Ben Wagner + +Release 2.2.8 Fri September 13 2019 + Security fixes: + #317 #318 CVE-2019-15903 -- Fix heap overflow triggered by + XML_GetCurrentLineNumber (or XML_GetCurrentColumnNumber), + and deny internal entities closing the doctype; + fixed in commit c20b758c332d9a13afbbb276d30db1d183a85d43 + + Bug fixes: + #240 Fix cases where XML_StopParser did not have any effect + when called from inside of an end element handler + #341 xmlwf: Fix exit code for operation without "-d DIRECTORY"; + previously, only "-d DIRECTORY" would give you a proper + exit code: + # xmlwf -d . <<<'' 2>/dev/null ; echo $? + 2 + # xmlwf <<<'' 2>/dev/null ; echo $? + 0 + Now both cases return exit code 2. + + Other changes: + #299 #302 Windows: Replace LoadLibrary hack to access + unofficial API function SystemFunction036 (RtlGenRandom) + by using official API function rand_s (needs WinXP+) + #325 Windows: Drop support for Visual Studio <=7.1/2003 + and document supported compilers in README.md + #286 Windows: Remove COM code from xmlwf; in case it turns + out needed later, there will be a dedicated repository + below https://github.com/libexpat/ for that code + #322 Windows: Remove explicit MSVC solution and project files. + You can generate Visual Studio solution files through + CMake, e.g.: cmake -G"Visual Studio 15 2017" . + #338 xmlwf: Make "xmlwf -h" help output more friendly + #339 examples: Improve elements.c + #244 #264 Autotools: Add argument --enable-xml-attr-info + #239 #301 Autotools: Add arguments + --with-getrandom + --without-getrandom + --with-sys-getrandom + --without-sys-getrandom + #312 #343 Autotools: Fix linking issues with "./configure LD=clang" + Autotools: Fix "make run-xmltest" for out-of-source builds + #329 #336 CMake: Pull all options from Expat <=2.2.7 into namespace + prefix EXPAT_ with the exception of DOCBOOK_TO_MAN: + - BUILD_doc -> EXPAT_BUILD_DOCS (plural) + - BUILD_examples -> EXPAT_BUILD_EXAMPLES + - BUILD_shared -> EXPAT_SHARED_LIBS + - BUILD_tests -> EXPAT_BUILD_TESTS + - BUILD_tools -> EXPAT_BUILD_TOOLS + - DOCBOOK_TO_MAN -> DOCBOOK_TO_MAN (unchanged) + - INSTALL -> EXPAT_ENABLE_INSTALL + - MSVC_USE_STATIC_CRT -> EXPAT_MSVC_STATIC_CRT + - USE_libbsd -> EXPAT_WITH_LIBBSD + - WARNINGS_AS_ERRORS -> EXPAT_WARNINGS_AS_ERRORS + - XML_CONTEXT_BYTES -> EXPAT_CONTEXT_BYTES + - XML_DEV_URANDOM -> EXPAT_DEV_URANDOM + - XML_DTD -> EXPAT_DTD + - XML_NS -> EXPAT_NS + - XML_UNICODE -> EXPAT_CHAR_TYPE=ushort (!) + - XML_UNICODE_WCHAR_T -> EXPAT_CHAR_TYPE=wchar_t (!) + #244 #264 CMake: Add argument -DEXPAT_ATTR_INFO=(ON|OFF), + default OFF + #326 CMake: Add argument -DEXPAT_LARGE_SIZE=(ON|OFF), + default OFF + #328 CMake: Add argument -DEXPAT_MIN_SIZE=(ON|OFF), + default OFF + #239 #277 CMake: Add arguments + -DEXPAT_WITH_GETRANDOM=(ON|OFF|AUTO), default AUTO + -DEXPAT_WITH_SYS_GETRANDOM=(ON|OFF|AUTO), default AUTO + #326 CMake: Install expat_config.h to include directory + #326 CMake: Generate and install configuration files for + future find_package(expat [..] CONFIG [..]) + CMake: Now produces a summary of applied configuration + CMake: Require C++ compiler only when tests are enabled + #330 CMake: Fix compilation for 16bit character types, + i.e. ex -DXML_UNICODE=ON (and ex -DXML_UNICODE_WCHAR_T=ON) + #265 CMake: Fix linking with MinGW + #330 CMake: Add full support for MinGW; to enable, use + -DCMAKE_TOOLCHAIN_FILE=[expat]/cmake/mingw-toolchain.cmake + #330 CMake: Port "make run-xmltest" from GNU Autotools to CMake + #316 CMake: Windows: Make binary postfix match MSVC + Old: expat[d].lib + New: expat[w][d][MD|MT].lib + CMake: Migrate files from Windows to Unix line endings + #308 CMake: Integrate OSS-Fuzz fuzzers, option + -DEXPAT_BUILD_FUZZERS=(ON|OFF), default OFF + #14 Drop an OpenVMS support leftover + #235 #268 .. + #270 #310 .. + #313 #331 #333 Address compiler warnings + #282 #283 .. + #284 #285 Address cppcheck warnings + #294 #295 Address Clang Static Analyzer warnings + #24 #293 Mass-apply clang-format 9 (and ensure conformance during CI) + Version info bumped from 7:9:6 to 7:10:6 + + Special thanks to: + David Loffredo + Joonun Jang + Kishore Kunche + Marco Maggi + Mitch Phillips + Mohammed Khajapasha + Rolf Ade + xantares + Zhongyuan Zhou + +Release 2.2.7 Wed June 19 2019 + Security fixes: + #186 #262 CVE-2018-20843 -- Fix extraction of namespace prefixes from + XML names; XML names with multiple colons could end up in + the wrong namespace, and take a high amount of RAM and CPU + resources while processing, opening the door to + use for denial-of-service attacks + + Other changes: + #195 #197 Autotools/CMake: Utilize -fvisibility=hidden to stop + exporting non-API symbols + #227 Autotools: Add --without-examples and --without-tests + #228 Autotools: Modernize configure.ac + #245 #246 Autotools: Fix check for -fvisibility=hidden for Clang + #247 #248 Autotools: Fix compilation for lack of docbook2x-man + #236 #258 Autotools: Produce .tar.{gz,lz,xz} release archives + #212 CMake: Make libdir of pkgconfig expat.pc support multilib + #158 #263 CMake: Build man page in PROJECT_BINARY_DIR not _SOURCE_DIR + #219 Remove fallback to bcopy, assume that memmove(3) exists + #257 Use portable "/usr/bin/env bash" shebang (e.g. for OpenBSD) + #243 Windows: Fix syntax of .def module definition files + Version info bumped from 7:8:6 to 7:9:6 + + Special thanks to: + Benjamin Peterson + Caolán McNamara + Hanno Böck + KangLin + Kishore Kunche + Marco Maggi + Rhodri James + Sebastian Dröge + userwithuid + Yury Gribov + +Release 2.2.6 Sun August 12 2018 + Bug fixes: + #170 #206 Avoid doing arithmetic with NULL pointers in XML_GetBuffer + #204 #205 Fix 2.2.5 regression with suspend-resume while parsing + a document like '' + + Other changes: + #165 #168 Autotools: Fix docbook-related configure syntax error + #166 Autotools: Avoid grep option `-q` for Solaris + #167 Autotools: Support + ./configure DOCBOOK_TO_MAN="xmlto man --skip-validation" + #159 #167 Autotools: Support DOCBOOK_TO_MAN command which produces + xmlwf.1 rather than XMLWF.1; also covers case insensitive + file systems + #181 Autotools: Drop -rpath option passed to libtool + #188 Autotools: Detect and deny SGML docbook2man as ours is XML + #188 Autotools/CMake: Support command db2x_docbook2man as well + #174 CMake: Introduce option WARNINGS_AS_ERRORS, defaults to OFF + #184 #185 CMake: Introduce option MSVC_USE_STATIC_CRT, defaults to OFF + #207 #208 CMake: Introduce option XML_UNICODE and XML_UNICODE_WCHAR_T, + both defaulting to OFF + #175 CMake: Prefer check_symbol_exists over check_function_exists + #176 CMake: Create the same pkg-config file as with GNU Autotools + #178 #179 CMake: Use GNUInstallDirs module to set proper defaults for + install directories + #208 CMake: Utilize expat_config.h.cmake for XML_DEV_URANDOM + #180 Windows: Fix compilation of test suite for Visual Studio 2008 + #131 #173 #202 Address compiler warnings + #187 #190 #200 Fix miscellaneous typos + Version info bumped from 7:7:6 to 7:8:6 + + Special thanks to: + Anton Maklakov + Benjamin Peterson + Brad King + Franek Korta + Frank Rast + Joe Orton + luzpaz + Pedro Vicente + Rainer Jung + Rhodri James + Rolf Ade + Rolf Eike Beer + Thomas Beutlich + Tomasz Kłoczko + +Release 2.2.5 Tue October 31 2017 + Bug fixes: + #8 If the parser runs out of memory, make sure its internal + state reflects the memory it actually has, not the memory + it wanted to have. + #11 The default handler wasn't being called when it should for + a SYSTEM or PUBLIC doctype if an entity declaration handler + was registered. + #137 #138 Fix a case of mistakenly reported parsing success where + XML_StopParser was called from an element handler + #162 Function XML_ErrorString was returning NULL rather than + a message for code XML_ERROR_INVALID_ARGUMENT + introduced with release 2.2.1 + + Other changes: + #106 xmlwf: Add argument -N adding notation declarations + #75 #106 Test suite: Resolve expected failure cases where xmlwf + output was incomplete + #127 Windows: Fix test suite compilation + #126 #127 Windows: Fix compilation for Visual Studio 2012 + Windows: Upgrade shipped project files to Visual Studio 2017 + #33 #132 tests: Mass-fix compilation for XML_UNICODE_WCHAR_T + #129 examples: Fix compilation for XML_UNICODE_WCHAR_T + #130 benchmark: Fix compilation for XML_UNICODE_WCHAR_T + #144 xmlwf: Fix compilation for XML_UNICODE_WCHAR_T; still needs + Windows or MinGW for 2-byte wchar_t + #9 Address two Clang Static Analyzer false positives + #59 Resolve troublesome macros hiding parser struct membership + and dereferencing that pointer + #6 Resolve superfluous internal malloc/realloc switch + #153 #155 Improve docbook2x-man detection + #160 Undefine NDEBUG in the test suite (rather than rejecting it) + #161 Address compiler warnings + Version info bumped from 7:6:6 to 7:7:6 + + Special thanks to: + Benbuck Nason + Hans Wennborg + José Gutiérrez de la Concha + Pedro Monreal Gonzalez + Rhodri James + Rolf Ade + Stephen Groat + and + Core Infrastructure Initiative + +Release 2.2.4 Sat August 19 2017 + Bug fixes: + #115 Fix copying of partial characters for UTF-8 input + + Other changes: + #109 Fix "make check" for non-x86 architectures that default + to unsigned type char (-128..127 rather than 0..255) + #109 coverage.sh: Cover -funsigned-char + Autotools: Introduce --without-xmlwf argument + #65 Autotools: Replace handwritten Makefile with GNU Automake + #43 CMake: Auto-detect high quality entropy extractors, add new + option USE_libbsd=ON to use arc4random_buf of libbsd + #74 CMake: Add -fno-strict-aliasing only where supported + #114 CMake: Always honor manually set BUILD_* options + #114 CMake: Compile man page if docbook2x-man is available, only + #117 Include file tests/xmltest.log.expected in source tarball + (required for "make run-xmltest") + #117 Include (existing) Visual Studio 2013 files in source tarball + Improve test suite error output + #111 Fix some typos in documentation + Version info bumped from 7:5:6 to 7:6:6 + + Special thanks to: + Jakub Wilk + Joe Orton + Lin Tian + Rolf Eike Beer + +Release 2.2.3 Wed August 2 2017 + Security fixes: + #82 CVE-2017-11742 -- Windows: Fix DLL hijacking vulnerability + using Steve Holme's LoadLibrary wrapper for/of cURL + + Bug fixes: + #85 Fix a dangling pointer issue related to realloc + + Other changes: + Increase code coverage + #91 Linux: Allow getrandom to fail if nonblocking pool has not + yet been initialized and read /dev/urandom then, instead. + This is in line with what recent Python does. + #81 Pre-10.7/Lion macOS: Support entropy from arc4random + #86 Check that a UTF-16 encoding in an XML declaration has the + right endianness + #4 #5 #7 Recover correctly when some reallocations fail + Repair "./configure && make" for systems without any + provider of high quality entropy + and try reading /dev/urandom on those + Ensure that user-defined character encodings have converter + functions when they are needed + Fix mis-leading description of argument -c in xmlwf.1 + Rely on macro HAVE_ARC4RANDOM_BUF (rather than __CloudABI__) + for CloudABI + #100 Fix use of SIPHASH_MAIN in siphash.h + #23 Test suite: Fix memory leaks + Version info bumped from 7:4:6 to 7:5:6 + + Special thanks to: + Chanho Park + Joe Orton + Pascal Cuoq + Rhodri James + Simon McVittie + Vadim Zeitlin + Viktor Szakats + and + Core Infrastructure Initiative + +Release 2.2.2 Wed July 12 2017 + Security fixes: + #43 Protect against compilation without any source of high + quality entropy enabled, e.g. with CMake build system; + commit ff0207e6076e9828e536b8d9cd45c9c92069b895 + #60 Windows with _UNICODE: + Unintended use of LoadLibraryW with a non-wide string + resulted in failure to load advapi32.dll and degradation + in quality of used entropy when compiled with _UNICODE for + Windows; you can launch existing binaries with + EXPAT_ENTROPY_DEBUG=1 in the environment to inspect the + quality of entropy used during runtime; commits + * 95b95032f907ef1cd17ee7a9a1768010a825d61d + * 73a5a2e9c081f49f2d775cf7ced864158b68dc80 + [MOX-006] Fix non-NULL parser parameter validation in XML_Parse; + resulted in NULL dereference, previously; + commit ac256dafdffc9622ab0dc2c62fcecb0dfcfa71fe + + Bug fixes: + #69 Fix improper use of unsigned long long integer literals + + Other changes: + #73 Start requiring a C99 compiler + #49 Fix "==" Bashism in configure script + #50 Fix too eager getrandom detection for Debian GNU/kFreeBSD + #52 and macOS + #51 Address lack of stdint.h in Visual Studio 2003 to 2008 + #58 Address compile warnings + #68 Fix "./buildconf.sh && ./configure" for some versions + of Dash for /bin/sh + #72 CMake: Ease use of Expat in context of a parent project + with multiple CMakeLists.txt files + #72 CMake: Resolve mistaken executable permissions + #76 Address compile warning with -DNDEBUG (not recommended!) + #77 Address compile warning about macro redefinition + + Special thanks to: + Alexander Bluhm + Ben Boeckel + Cătălin Răceanu + Kerin Millar + László Böszörményi + S. P. Zeidler + Segev Finer + Václav Slavík + Victor Stinner + Viktor Szakats + and + Radically Open Security + +Release 2.2.1 Sat June 17 2017 + Security fixes: + CVE-2017-9233 -- External entity infinite loop DoS + Details: https://libexpat.github.io/doc/cve-2017-9233/ + Commit c4bf96bb51dd2a1b0e185374362ee136fe2c9d7f + [MOX-002] CVE-2016-9063 -- Detect integer overflow; commit + d4f735b88d9932bd5039df2335eefdd0723dbe20 + (Fixed version of existing downstream patches!) + (SF.net) #539 Fix regression from fix to CVE-2016-0718 cutting off + longer tag names; commits + * 896b6c1fd3b842f377d1b62135dccf0a579cf65d + * af507cef2c93cb8d40062a0abe43a4f4e9158fb2 + #16 * 0dbbf43fdb20f593ddf4fa1ff67288000dd4a7fd + #25 More integer overflow detection (function poolGrow); commits + * 810b74e4703dcfdd8f404e3cb177d44684775143 + * 44178553f3539ce69d34abee77a05e879a7982ac + [MOX-002] Detect overflow from len=INT_MAX call to XML_Parse; commits + * 4be2cb5afcc018d996f34bbbce6374b7befad47f + * 7e5b71b748491b6e459e5c9a1d090820f94544d8 + [MOX-005] #30 Use high quality entropy for hash initialization: + * arc4random_buf on BSD, systems with libbsd + (when configured with --with-libbsd), CloudABI + * RtlGenRandom on Windows XP / Server 2003 and later + * getrandom on Linux 3.17+ + In a way, that's still part of CVE-2016-5300. + https://github.com/libexpat/libexpat/pull/30/commits + [MOX-005] For the low quality entropy extraction fallback code, + the parser instance address can no longer leak, commit + 04ad658bd3079dd15cb60fc67087900f0ff4b083 + [MOX-003] Prevent use of uninitialised variable; commit + [MOX-004] a4dc944f37b664a3ca7199c624a98ee37babdb4b + Add missing parameter validation to public API functions + and dedicated error code XML_ERROR_INVALID_ARGUMENT: + [MOX-006] * NULL checks; commits + * d37f74b2b7149a3a95a680c4c4cd2a451a51d60a (merge/many) + * 9ed727064b675b7180c98cb3d4f75efba6966681 + * 6a747c837c50114dfa413994e07c0ba477be4534 + * Negative length (XML_Parse); commit + [MOX-002] 70db8d2538a10f4c022655d6895e4c3e78692e7f + [MOX-001] #35 Change hash algorithm to William Ahern's version of SipHash + to go further with fixing CVE-2012-0876. + https://github.com/libexpat/libexpat/pull/39/commits + + Bug fixes: + #32 Fix sharing of hash salt across parsers; + relevant where XML_ExternalEntityParserCreate is called + prior to XML_Parse, in particular (e.g. FBReader) + #28 xmlwf: Auto-disable use of memory-mapping (and parsing + as a single chunk) for files larger than ~1 GB (2^30 bytes) + rather than failing with error "out of memory" + #3 Fix double free after malloc failure in DTD code; commit + 7ae9c3d3af433cd4defe95234eae7dc8ed15637f + #17 Fix memory leak on parser error for unbound XML attribute + prefix with new namespaces defined in the same tag; + found by Google's OSS-Fuzz; commits + * 16f87daae5a16132e479e4f71862128c7a915c73 + * b47dbc9745932c160893d433220e462bd605f8cd + xmlwf on Windows: Add missing calls to CloseHandle + + New features: + #30 Introduced environment switch EXPAT_ENTROPY_DEBUG=1 + for runtime debugging of entropy extraction + + Other changes: + Increase code coverage + #33 Reject use of XML_UNICODE_WCHAR_T with sizeof(wchar_t) != 2; + XML_UNICODE_WCHAR_T was never meant to be used outside + of Windows; 4-byte wchar_t is common on Linux + (SF.net) #538 Start using -fno-strict-aliasing + (SF.net) #540 Support compilation against cloudlibc of CloudABI + Allow MinGW cross-compilation + (SF.net) #534 CMake: Introduce option "BUILD_doc" (enabled by default) + to bypass compilation of the xmlwf.1 man page + (SF.net) pr2 CMake: Introduce option "INSTALL" (enabled by default) + to bypass installation of expat files + CMake: Fix ninja support + Autotools: Add parameters --enable-xml-context [COUNT] + and --disable-xml-context; default of context of 1024 + bytes enabled unchanged + #14 Drop AmigaOS 4.x code and includes + #14 Drop ancient build systems: + * Borland C++ Builder + * OpenVMS + * Open Watcom + * Visual Studio 6.0 + * Pre-X Mac OS (MPW Makefile) + If you happen to rely on some of these, please get in + touch for joining with maintenance. + #10 Move from WIN32 to _WIN32 + #13 Fix "make run-xmltest" order instability + Address compile warnings + Bump version info from 7:2:6 to 7:3:6 + Add AUTHORS file + + Infrastructure: + #1 Migrate from SourceForge to GitHub (except downloads): + https://github.com/libexpat/ + #1 Re-create http://libexpat.org/ project website + Start utilizing Travis CI + + Special thanks to: + Andy Wang + Don Lewis + Ed Schouten + Karl Waclawek + Pascal Cuoq + Rhodri James + Sergei Nikulov + Tobias Taschner + Viktor Szakats + and + Core Infrastructure Initiative + Mozilla Foundation (MOSS Track 3: Secure Open Source) + Radically Open Security + +Release 2.2.0 Tue June 21 2016 + Security fixes: + #537 CVE-2016-0718 -- Fix crash on malformed input + CVE-2016-4472 -- Improve insufficient fix to CVE-2015-1283 / + CVE-2015-2716 introduced with Expat 2.1.1 + #499 CVE-2016-5300 -- Use more entropy for hash initialization + than the original fix to CVE-2012-0876 + #519 CVE-2012-6702 -- Resolve troublesome internal call to srand + that was introduced with Expat 2.1.0 + when addressing CVE-2012-0876 (issue #496) + + Bug fixes: + Fix uninitialized reads of size 1 + (e.g. in little2_updatePosition) + Fix detection of UTF-8 character boundaries + + Other changes: + #532 Fix compilation for Visual Studio 2010 (keyword "C99") + Autotools: Resolve use of "$<" to better support bmake + Autotools: Add QA script "qa.sh" (and make target "qa") + Autotools: Respect CXXFLAGS if given + Autotools: Fix "make run-xmltest" + Autotools: Have "make run-xmltest" check for expected output + p90 CMake: Fix static build (BUILD_shared=OFF) on Windows + #536 CMake: Add soversion, support -DNO_SONAME=yes to bypass + #323 CMake: Add suffix "d" to differentiate debug from release + CMake: Define WIN32 with CMake on Windows + Annotate memory allocators for GCC + Address all currently known compile warnings + Make sure that API symbols remain visible despite + -fvisibility=hidden + Remove executable flag from source files + Resolve COMPILED_FROM_DSP in favor of WIN32 + + Special thanks to: + Björn Lindahl + Christian Heimes + Cristian Rodríguez + Daniel Krügler + Gustavo Grieco + Karl Waclawek + László Böszörményi + Marco Grassi + Pascal Cuoq + Sergei Nikulov + Thomas Beutlich + Warren Young + Yann Droneaud + +Release 2.1.1 Sat March 12 2016 + Security fixes: + #582: CVE-2015-1283 - Multiple integer overflows in XML_GetBuffer + + Bug fixes: + #502: Fix potential null pointer dereference + #520: Symbol XML_SetHashSalt was not exported + Output of "xmlwf -h" was incomplete + + Other changes: + #503: Document behavior of calling XML_SetHashSalt with salt 0 + Minor improvements to man page xmlwf(1) + Improvements to the experimental CMake build system + libtool now invoked with --verbose + +Release 2.1.0 Sat March 24 2012 + - Security fixes: + #2958794: CVE-2012-1148 - Memory leak in poolGrow. + #2895533: CVE-2012-1147 - Resource leak in readfilemap.c. + #3496608: CVE-2012-0876 - Hash DOS attack. + #2894085: CVE-2009-3560 - Buffer over-read and crash in big2_toUtf8(). + #1990430: CVE-2009-3720 - Parser crash with special UTF-8 sequences. + - Bug Fixes: + #1742315: Harmful XML_ParserCreateNS suggestion. + #1785430: Expat build fails on linux-amd64 with gcc version>=4.1 -O3. + #1983953, 2517952, 2517962, 2649838: + Build modifications using autoreconf instead of buildconf.sh. + #2815947, #2884086: OBJEXT and EXEEXT support while building. + #2517938: xmlwf should return non-zero exit status if not well-formed. + #2517946: Wrong statement about XMLDecl in xmlwf.1 and xmlwf.sgml. + #2855609: Dangling positionPtr after error. + #2990652: CMake support. + #3010819: UNEXPECTED_STATE with a trailing "%" in entity value. + #3206497: Uninitialized memory returned from XML_Parse. + #3287849: make check fails on mingw-w64. + - Patches: + #1749198: pkg-config support. + #3010222: Fix for bug #3010819. + #3312568: CMake support. + #3446384: Report byte offsets for attr names and values. + - New Features / API changes: + Added new API member XML_SetHashSalt() that allows setting an initial + value (salt) for hash calculations. This is part of the fix for + bug #3496608 to randomize hash parameters. + When compiled with XML_ATTR_INFO defined, adds new API member + XML_GetAttributeInfo() that allows retrieving the byte + offsets for attribute names and values (patch #3446384). + Added CMake build system. + See bug #2990652 and patch #3312568. + Added run-benchmark target to Makefile.in - relies on testdata module + present in the same relative location as in the repository. + +Release 2.0.1 Tue June 5 2007 + - Fixed bugs #1515266, #1515600: The character data handler's calling + of XML_StopParser() was not handled properly; if the parser was + stopped and the handler set to NULL, the parser would segfault. + - Fixed bug #1690883: Expat failed on EBCDIC systems as it assumed + some character constants to be ASCII encoded. + - Minor cleanups of the test harness. + - Fixed xmlwf bug #1513566: "out of memory" error on file size zero. + - Fixed outline.c bug #1543233: missing a final XML_ParserFree() call. + - Fixes and improvements for Windows platform: + bugs #1409451, #1476160, #1548182, #1602769, #1717322. + - Build fixes for various platforms: + HP-UX, Tru64, Solaris 9: patch #1437840, bug #1196180. + All Unix: #1554618 (refreshed config.sub/config.guess). + #1490371, #1613457: support both, DESTDIR and INSTALL_ROOT, + without relying on GNU-Make specific features. + #1647805: Patched configure.in to work better with Intel compiler. + - Fixes to Makefile.in to have make check work correctly: + bugs #1408143, #1535603, #1536684. + - Added Open Watcom support: patch #1523242. + +Release 2.0.0 Wed Jan 11 2006 + - We no longer use the "check" library for C unit testing; we + always use the (partial) internal implementation of the API. + - Report XML_NS setting via XML_GetFeatureList(). + - Fixed headers for use from C++. + - XML_GetCurrentLineNumber() and XML_GetCurrentColumnNumber() + now return unsigned integers. + - Added XML_LARGE_SIZE switch to enable 64-bit integers for + byte indexes and line/column numbers. + - Updated to use libtool 1.5.22 (the most recent). + - Added support for AmigaOS. + - Some mostly minor bug fixes. SF issues include: #1006708, + #1021776, #1023646, #1114960, #1156398, #1221160, #1271642. + +Release 1.95.8 Fri Jul 23 2004 + - Major new feature: suspend/resume. Handlers can now request + that a parse be suspended for later resumption or aborted + altogether. See "Temporarily Stopping Parsing" in the + documentation for more details. + - Some mostly minor bug fixes, but compilation should no + longer generate warnings on most platforms. SF issues + include: #827319, #840173, #846309, #888329, #896188, #923913, + #928113, #961698, #985192. + +Release 1.95.7 Mon Oct 20 2003 + - Fixed enum XML_Status issue (reported on SourceForge many + times), so compilers that are properly picky will be happy. + - Introduced an XMLCALL macro to control the calling + convention used by the Expat API; this macro should be used + to annotate prototypes and definitions of callback + implementations in code compiled with a calling convention + other than the default convention for the host platform. + - Improved ability to build without the configure-generated + expat_config.h header. This is useful for applications + which embed Expat rather than linking in the library. + - Fixed a variety of bugs: see SF issues #458907, #609603, + #676844, #679754, #692878, #692964, #695401, #699323, #699487, + #820946. + - Improved hash table lookups. + - Added more regression tests and improved documentation. + +Release 1.95.6 Tue Jan 28 2003 + - Added XML_FreeContentModel(). + - Added XML_MemMalloc(), XML_MemRealloc(), XML_MemFree(). + - Fixed a variety of bugs: see SF issues #615606, #616863, + #618199, #653180, #673791. + - Enhanced the regression test suite. + - Man page improvements: includes SF issue #632146. + +Release 1.95.5 Fri Sep 6 2002 + - Added XML_UseForeignDTD() for improved SAX2 support. + - Added XML_GetFeatureList(). + - Defined XML_Bool type and the values XML_TRUE and XML_FALSE. + - Use an incomplete struct instead of a void* for the parser + (may not retain). + - Fixed UTF-8 decoding bug that caused legal UTF-8 to be rejected. + - Finally fixed bug where default handler would report DTD + events that were already handled by another handler. + Initial patch contributed by Darryl Miles. + - Removed unnecessary DllMain() function that caused static + linking into a DLL to be difficult. + - Added VC++ projects for building static libraries. + - Reduced line-length for all source code and headers to be + no longer than 80 characters, to help with AS/400 support. + - Reduced memory copying during parsing (SF patch #600964). + - Fixed a variety of bugs: see SF issues #580793, #434664, + #483514, #580503, #581069, #584041, #584183, #584832, #585537, + #596555, #596678, #598352, #598944, #599715, #600479, #600971. + +Release 1.95.4 Fri Jul 12 2002 + - Added support for VMS, contributed by Craig Berry. See + vms/README.vms for more information. + - Added Mac OS (classic) support, with a makefile for MPW, + contributed by Thomas Wegner and Daryle Walker. + - Added Borland C++ Builder 5 / BCC 5.5 support, contributed + by Patrick McConnell (SF patch #538032). + - Fixed a variety of bugs: see SF issues #441449, #563184, + #564342, #566334, #566901, #569461, #570263, #575168, #579196. + - Made skippedEntityHandler conform to SAX2 (see source comment) + - Re-implemented WFC: Entity Declared from XML 1.0 spec and + added a new error "entity declared in parameter entity": + see SF bug report #569461 and SF patch #578161 + - Re-implemented section 5.1 from XML 1.0 spec: + see SF bug report #570263 and SF patch #578161 + +Release 1.95.3 Mon Jun 3 2002 + - Added a project to the MSVC workspace to create a wchar_t + version of the library; the DLLs are named libexpatw.dll. + - Changed the name of the Windows DLLs from expat.dll to + libexpat.dll; this fixes SF bug #432456. + - Added the XML_ParserReset() API function. + - Fixed XML_SetReturnNSTriplet() to work for element names. + - Made the XML_UNICODE builds usable (thanks, Karl!). + - Allow xmlwf to read from standard input. + - Install a man page for xmlwf on Unix systems. + - Fixed many bugs; see SF bug reports #231864, #461380, #464837, + #466885, #469226, #477667, #484419, #487840, #494749, #496505, + #547350. Other bugs which we can't test as easily may also + have been fixed, especially in the area of build support. + +Release 1.95.2 Fri Jul 27 2001 + - More changes to make MSVC happy with the build; add a single + workspace to support both the library and xmlwf application. + - Added a Windows installer for Windows users; includes + xmlwf.exe. + - Added compile-time constants that can be used to determine the + Expat version + - Removed a lot of GNU-specific dependencies to aide portability + among the various Unix flavors. + - Fix the UTF-8 BOM bug. + - Cleaned up warning messages for several compilers. + - Added the -Wall, -Wstrict-prototypes options for GCC. + +Release 1.95.1 Sun Oct 22 15:11:36 EDT 2000 + - Changes to get expat to build under Microsoft compiler + - Removed all aborts and instead return an UNEXPECTED_STATE error. + - Fixed a bug where a stray '%' in an entity value would cause an + abort. + - Defined XML_SetEndNamespaceDeclHandler. Thanks to Darryl Miles for + finding this oversight. + - Changed default patterns in lib/Makefile.in to fit non-GNU makes + Thanks to robin@unrated.net for reporting and providing an + account to test on. + - The reference had the wrong label for XML_SetStartNamespaceDecl. + Reported by an anonymous user. + +Release 1.95.0 Fri Sep 29 2000 + - XML_ParserCreate_MM + Allows you to set a memory management suite to replace the + standard malloc,realloc, and free. + - XML_SetReturnNSTriplet + If you turn this feature on when namespace processing is in + effect, then qualified, prefixed element and attribute names + are returned as "uri|name|prefix" where '|' is whatever + separator character is used in namespace processing. + - Merged in features from perl-expat + o XML_SetElementDeclHandler + o XML_SetAttlistDeclHandler + o XML_SetXmlDeclHandler + o XML_SetEntityDeclHandler + o StartDoctypeDeclHandler takes 3 additional parameters: + sysid, pubid, has_internal_subset + o Many paired handler setters (like XML_SetElementHandler) + now have corresponding individual handler setters + o XML_GetInputContext for getting the input context of + the current parse position. + - Added reference material + - Packaged into a distribution that builds a sharable library diff --git a/miniconda3/envs/ladir/share/doc/fontsproto/fsproto.xml b/miniconda3/envs/ladir/share/doc/fontsproto/fsproto.xml new file mode 100644 index 0000000000000000000000000000000000000000..74f24286186e42435a6a0571e687609c4b7c21d0 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/fontsproto/fsproto.xml @@ -0,0 +1,4417 @@ + + %defs; +]> + + + + + + The X Font Service Protocol + X Consortium Standard + X Version 11, Release &fullrelvers; + Version 2.0 + + + JimFulton + Network Computing Devices, Inc. + + + Revised May 2, 1994 + 1991Network Computing Devices, Inc. + + + +Permission to use, copy, modify, distribute, and sell this +documentation for any purpose is hereby granted without fee, +provided that the above copyright notice and this permission +notice appear in all copies. Network Computing Devices, Inc. +makes no representations about the suitability for any purpose +of the information in this document. This documentation is +provided “as is” without express or implied warranty. + + + + +Copyright © 1994 X Consortium + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the “Software”), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the name of the X Consortium shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the X Consortium. + + + + + +Introduction + +The management of fonts in large, heterogeneous environments is one of the +hardest aspects of using the X Window System + +X Window System +is a trademark of The Open Group. + +. Multiple formats and the lack of +a consistent mechanism for exporting font data to all displays on a network +prevent the transparent use of applications across different display platforms. +The X Font Service protocol is designed to address this and other issues, with +specific emphasis on the needs of the core X protocol. Upward-compatible +changes (typically in the form of new requests) are expected as consensus is +reached on new features (particularly outline font support). + + +Currently, most X displays use network file protocols such as +NFS and TFTP to +obtain raw font data which they parse directly. Since a common binary format +for this data doesn't exist, displays must be able to interpret a variety of +formats if they are to be used with different application hosts. This leads to +wasted code and data space and a loss of interoperability as displays are used +in unforeseen environments. + + +By moving the interpretation of font data out of the X server into a separate +service on the network, these problems can be greatly reduced. In addition, +new technologies, such as dynamically generating bitmaps from scaled or outline +fonts, can be provided to all displays transparently. For horizontal text, +caching techniques and increased processor power can potentially make +rasterization more efficient on large, centralized hosts than on individual +displays. + + +Each font server provides sets of fonts that may be listed and queried for +header, property, glyph extents, and bitmap information. This data is +transmitted over the network using a binary format (with variations to support +different bit- and byte-orders) designed to minimize the amount of processing +required by the display. Since the font server, rather than the display, is +responsible for parsing the raw font data, new formats can be used by all +displays by modifying a single font server. + + +From the user's point of view, font servers are simply a new type of name in +the X font path. Network name services allow descriptive names (such as +DEPARTMENT-FONTS or APPLICATION-FONTS) to be translated into proper network +addresses. X displays send requests to and read replies from the font server +rather than reading directly from files. Since the X Font Service protocol is +designed to allow subsets of the font data to be requested, displays may easily +implement a variety of strategies for fine-grained demand-loading of glyphs. + + + + +Architectural Model + + + + +In this document, the words client and +server refer to the consumer and +provider of a font, respectively, unless otherwise indicated. It is important +to note that in this context, the X server is also a font client. + + +The X Font Service protocol does not require any changes to the core X protocol +or to any applications. To the user, font servers are simply additional types +of font path elements. As such, X servers may connect to multiple font +servers, as shown in Figure 2.1. Although the font protocol is geared towards +the X Window System, it may be also used by other consumers of font data (such +as printer drivers). + + +
Connecting to a Font Server + + ┌────────┐ ┌───────────────┐ + │ X1 ├──────────────┤ │ + │ Server │ │ Font Server │ + └────────┘ ┌───────┤ 1 │ + │ └───────────────┘ + ┌────────┐ │ + │ X2 ├──────┘ ┌───────────────┐ + │ Server ├──────────────┤ │ + └────────┘ │ Font Server │ + ┌───────┤ 2 │ +┌─────────┐ │ └───────────────┘ +│ other │ │ +│ clients ├──────┘ +└─────────┘ + +
+ + +Clients communicate with the font server using the request/reply/event model +over any mutually-understood virtual stream connection (such as +TCP/IP, DECnet, + +DECnet is a trademark +of Digital Equipment Corporation. + +etc.). Font servers are responsible for providing data in the bit and byte +orders requested by the client. The set of requests and events provided in the +first version of the X Font Service protocol is limited to supporting the needs +of the bitmap-oriented core X Window System protocol. Extensions are expected +as new needs evolve. + + +A font server reads raw font data from a variety of sources (possibly +including other font servers) and converts it into a common format that is +transmitted to the client using the protocol described in +Section 4. New font +formats are handled by adding new converters to a font server, as shown in +Figure 2.2. + + +
Where Font Data Comes From + + ┌────────────┐ + │ client │ + │ (X server) │ + └─────┬──────┘ + │ + network + │ +┌─────────────────────┴──────────────────────┐ +│ │ +│ font server 1 │ +│ │ +├─────┬─────┬─────┬─────┬────┬─────┬───┬─────┤ +│ bdf │ snf │ pcf │ atm │ f3 │ dwf │ │ │ ... │ +└─────┴─────┴─────┴─────┴────┴─────┴─│─┴─────┘ + │ + network + │ + ┌─────┴────┐ + │ font │ + │ server 2 │ + └──────────┘ + +
+ + +The server may choose to provide named sets of fonts called +catalogues. +Clients may specify which of the sets should be used in listing or opening a +font. + + + +An event mechanism similar to that used in the X protocol is provided for +asynchronous notification of clients by the server. + + + +Clients may provide authorization data for the server to be used in determining +(according to the server's licensing policy) whether or not access should be +granted to particular fonts. This is particularly useful for clients whose +authorization changes over time (such as an X server that can verify the +identity of the user). + + +Implementations that wish to provide additional requests or events may use the +extension mechanism. Adding to the core font service protocol (with the +accompanying change in the major or minor version numbers) is reserved to the X +Consortium. + + + + +Font Server Naming + + + + +Font clients that expose font server names to the user are encouraged to +provide ways of naming font servers symbolically (e.g. DEPARTMENT-FONTS). +However, for environments that lack appropriate name services +transport-specific names are necessary. Since these names do occur in the +protocol, clients and servers should support at least the applicable formats +described below. Formats for additional transports may be registered with the +X Consortium. + + +
+TCP/IP Names + + + + +The following syntax should be used for TCP/IP names: + + + TCP name ::= tcp/ hostname : ipportnumber / cataloguelist + + +where hostname is either symbolic (such as +expo.lcs.mit.edu) or numeric +decimal (such as 18.30.0.212). +The ipportnumber is the port on which the +font server is listening for connections. +The cataloguelist string at +the end is optional and specifies a plus-separated list of catalogues +that may be requested. For example: + + tcp/expo.lcs.mit.edu:8012/available+special + tcp/18.30.0.212:7890 + + +
+ +
+DECnet Names + + + + +The following syntax should be used for DECnet names: + + + DECnet name ::= decnet/ nodename ::font$ objname / cataloguelist + + +where nodename is either symbolic (such as +SRVNOD) or the +numeric decimal form of the DECnet address (such as +44.70). +The objname is normal, case-insensitive DECnet +object name. The cataloguelist string +at the end is +optional and specifies a plus-separated list of catalogues that may be +requested. For example: + + + DECNET/SRVNOD::FONT$DEFAULT/AVAILABLE + decnet/44.70::font$other + + +
+ + + +Protocol + + + + +The protocol described below uses the request/reply/error model and is +specified using the same conventions outlined in +Section 2 +of the core X Window System protocol +: + + + + + +Data type names are spelled in upper case with no word separators, +as in: FONTID + + + + + +Alternate values are capitalized with no word separators, +as in: MaxWidth + + + + + +Structure element declarations are in lower case with hyphens +as word separators, as in: byte-order-msb + + + +Structure element names are referred to in +upper case (e.g. BYTE-ORDER-MSB) when used in +descriptions to set them off from the surrounding +text. When this document is typeset they will be +printed in lower case in a distinct font. + + + + + +Type declarations have the form name: type, +as in: CARD8: 8-bit byte + + + + +Comma-separated lists of alternate values are enclosed in +braces, as in: { Min, MaxWidth, +Max } + + + + +Comma-separated lists of structure elements are enclosed in +brackets, as in: [ byte1: CARD8, +byte2: CARD8 ] + + + + + +A type with a prefix LISTof represents a counted list of +elements of that type, as in: LISTofCARD8 + + +
+Data Types + + + + +The following data types are used in the core X Font Server protocol: + + +
+ <type>ACCESSCONTEXT</type> + ACCESSCONTEXT + + + + + + + + ACCESSCONTEXT:ID + + + + +This value is specified in the CreateAC request as the identifier +to be used when referring to a particular AccessContext resource +within the server. These resources are used by the server to +store client-specified authorization information. This +information may be used by the server to determine whether or not +the client should be granted access to particular font data. + + +In order to preserve the integrity of font licensing being performed by +the font server, care must be taken by a client to properly represent the +identity of the true user of the font. Some font clients will in fact +be servers (for example, X servers) requesting fonts for their own clients. +Other font clients may be doing work on behalf of a number of different +users over time (for example, print spoolers). + + +AccessContexts +must be created (with +CreateAC) +and switched among (with +SetAuthorization) +to represent all of these font users properly. + +
+ +
+ <type>ALTERNATESERVER</type> + ALTERNATESERVER + + + + + + + + ALTERNATESERVER: + [ name: STRING8, +  subset: BOOL ] + + + + + +This structure specifies the NAME, +encoded in ISO 8859-1 according +to Section 3, +of another font server that may be useful as a +substitute for this font server. +The SUBSET field indicates +whether or not the alternate server is likely to only contain a +subset of the fonts available from this font server. This +information is returned during the initial connection setup and +may be used by the client to find a backup server in case of +failure. + +
+ +
+ <type>AUTH</type> + AUTH + + + + + + + + AUTH:[ name:STRING8, +  data:LISTofBYTE ] + + + + + +This structure specifies the name of an authorization protocol and +initial data for that protocol. It is used in the authorization +negotiation in the initial connection setup and in the CreateAC +request. + +
+ +
+ <type>BITMAPFORMAT</type> + BITMAPFORMAT + + + + + + + + BITMAPFORMAT:CARD32 + + + + + + CARD32 containing the following fields defined by the + sets of values given further below + + + + + + + + + [ +  byte-order-msb: 1 bit, +  bit-order-msb: 1 bit, +  image-rect: 2 bits{ Min, + MaxWidth, + Max }, +  zero-pad: 4 bits, +  scanline-pad: 2 bits{ ScanlinePad8, + ScanlinePad16, + ScanlinePad32, + ScanlinePad64 }, +  zero-pad: 2 bits, +  scanline-unit: 2 bits{ ScanlineUnit8, + ScanlineUnit16, + ScanlineUnit32, + ScanlineUnit64 }, +  zero-pad: 2 bits, +  zero-pad: 16 bits, + ] + + + + + +This structure specifies how glyph images are transmitted in +response to +QueryXBitmaps8 +and +QueryXBitmaps16 +requests. + + +If the BYTE-ORDER-MSB bit +(1 << 0) is set, the Most Significant +Byte of each scanline unit is returned first. Otherwise, the +Least Significant Byte is returned first. + + +If the BIT-ORDER-MSB bit +(1 << 1) is set, the left-most bit in +each glyph scanline unit is stored in the Most Significant Bit of +each transmitted scanline unit. Otherwise, the left-most bit is +stored in the Least Significant Bit. + + +The IMAGE-RECT field specifies a rectangle of +pixels within the +glyph image. It contains one of the following alternate values: + + + + + + + + ImageRectMin(0 << 2) + ImageRectMaxWidth(1 << 2) + ImageRectMax(2 << 2) + + + + + +For a glyph with extents XCHARINFO in a font with header +information XFONTINFO, the IMAGE-RECT +values have the following meanings: + + + ImageRectMin + + ImageRectMin + +This refers to the minimal bounding rectangle +surrounding the inked pixels in the glyph. This is the +most compact representation. The edges of the rectangle +are: + + left: XCHARINFO.LBEARING + right: XCHARINFO.RBEARING + top: XCHARINFO.ASCENT + bottom: XCHARINFO.DESCENT + + + + + + ImageRectMaxWidth + + ImageRectMaxWidth + +This refers to the scanlines between the +glyph's ascent and descent, padded on the left to the minimum +left-bearing (or 0, whichever is less) and on the right to +the maximum right-bearing (or logical-width, whichever is +greater). All glyph images share a common horizontal +origin. This is a combination of ImageRectMax in the +horizontal direction and ImageRectMin in the vertical +direction. The edges of the rectangle are: + + +left: min (XFONTINFO.MIN-BOUNDS.LBEARING, 0) +right: max (XFONTINFO.MAX-BOUNDS.RBEARING, + XFONTINFO.MAX-BOUNDS.WIDTH) +top: XCHARINFO.ASCENT +bottom: XCHARINFO.DESCENT + + + + + + ImageRectMax + + ImageRectMax + +This refers to all scanlines, from the maximum +ascent (or the font ascent, whichever is greater) to the +maximum descent (or the font descent, whichever is greater), +padded to the same horizontal extents as MaxWidth. +All glyph images have the same sized bitmap and share a +common origin. This is the least compact representation, +but may be the easiest or most efficient (particularly for +character cell fonts) for some clients to use. The edges of +the rectangle are: + + +left: min (XFONTINFO.MIN-BOUNDS.LBEARING, 0) +right: max (XFONTINFO.MAX-BOUNDS.RBEARING, + XFONTINFO.MAX-BOUNDS.WIDTH) +top: max (XFONTINFO.FONT-ASCENT, + XFONTINFO.MAX-BOUNDS.ASCENT) +bottom: max (XFONTINFO.FONT-DESCENT, + XFONTINFO.MAX-BOUNDS.DESCENT) + + + + + + + +The SCANLINE-PAD field specifies the number of +bits (8, 16, 32, +or 64) to which each glyph scanline is padded before transmitting. +It contains one of the following alternate values: + + + + + + + ScanlinePad8(0 << 8) + ScanlinePad16(1 << 8) + ScanlinePad32(2 << 8) + ScanlinePad64(3 << 8) + + + + + +The SCANLINE-UNIT field specifies the number of +bits (8, 16, 32, or 64) that should be treated as a unit for swapping. +This value must be less than or equal to the number of bits specified by the +SCANLINE-PAD. It contains one of the following +alternate values: + + + + + + + + ScanlineUnit8(0 << 12) + ScanlineUnit16(1 << 12) + ScanlineUnit32(2 << 12) + ScanlineUnit64(3 << 12) + + + + + +BITMAPFORMATs are byte-swapped as CARD32s. +All unspecified bits must be zero. + + +Use of an invalid BITMAPFORMAT causes a +Format error to be returned. + +
+ +
+ <type>BITMAPFORMATMASK</type> + BITMAPFORMATMASK + + + + + + + + BITMAPFORMATMASK: CARD32 mask + + + + +This is a mask of bits representing the fields in a BITMAPFORMAT: + + + + + + + ByteOrderMask(1 << 0) + BitOrderMask(1 << 1) + ImageRectMask(1 << 2) + ScanlinePadMask(1 << 3) + ScanlineUnitMask(1 << 4) + + + + + +Unspecified bits are required to be zero or else a +Format error is returned. + +
+ +
+ <type>BOOL</type> + BOOL + + + + + + + + BOOL: CARD8 + + + + +This is a boolean value containing one of the following alternate +values: + + + + + + + False0 + True1 + + + + +
+ +
+ <type>BYTE</type> + BYTE + + + + + + + + BYTE: 8-bit value + + + + + +This is an unsigned byte of data whose encoding +is determined by the context in which it is used. + + +
+ +
+ <type>CARD8</type>, <type>CARD16</type>, <type>CARD32</type> + CARD8 + CARD16 + CARD32 + + + + + + + + CARD8: 8-bit unsigned integer + CARD16: 16-bit unsigned integer + CARD32: 32-bit unsigned integer + + + + + +These are unsigned numbers. The latter two are byte-swapped when +the server and client have different byte orders. + + +
+ +
+ <type>CHAR2B</type> + CHAR2B + + + + + + + + CHAR2B:[ byte1, byte2:CARD8 ] + + + + +This structure specifies an individual character code within +either a 2-dimensional matrix (using BYTE1 +and BYTE2 as the row and column indices, +respectively) or a vector (using BYTE1 and +BYTE2 as most- and least-significant bytes, +respectively). This data type is treated as a pair of 8-bit values and +is never byte-swapped. Therefore, the client should always transmit +BYTE1 first. + + +
+ +
+ <type>EVENTMASK</type> + EVENTMASK + + + + + + + + EVENTMASK: CARD32 mask + + + + + +This is a mask of bits indicating which of an extension's (or the +core's) maskable events the client would like to receive. Each +bit indicates one or more events, and a bit value of one indicates +interest in a corresponding set of events. The following bits are +defined for event masks specified for the core protocol (i.e. an +EXTENSION-OPCODE of zero in +SetEventMask +and +GetEventMask +requests): + + + + + + + + CatalogueListChangeMask(1 << 0) + FontListChangeMask(1 << 1) + + + + + + +If +CatalogueListChangeMask +is set, client is interested in +receiving +CatalogueListNotify +events. If +FontListChangeMask +is set, the client is interested in +receiving +FontListNotify +events. + + +Extensions that provide additional events may define their own +event masks. These event masks have their own scope and may use +the same bit values as the core or other extensions. + + +All unused bits must be set to zero. In +SetEventMask +requests, if +any bits are set that are not defined for the extension (or core) +for which this EVENTMASK is intended (according to the +EXTENSION-OPCODE given in the +SetEventMask +request), an +EventMask +error is generated. + + +This value is swapped as a CARD32. + + +
+ +
+ <type>FONTID</type> + FONTID + + + + + + + + FONTID: ID + + + + + +This is specified by the client in the request +OpenBitmapFont +as the identifier to be used when referring to a particular open +font. + + +
+ +
+ <type>ID</type> + ID + + + + + + + + ID: CARD32 + + + + + +This is a 32-bit value in which the top 3 bits must be clear, and +at least 1 other bit must be set (yielding a range of 1 through +229-1). +It is specified by the client to represent objects in +the server. Identifiers are scoped according to their type are +private to the client; thus, the same identifier may be used for +both a FONTID and an ACCESSCONTEXT +as well as by multiple clients. + + +An ID of zero is referred to as None. + +
+ +
+ <type>INT8</type>, <type>INT16</type>, <type>INT32</type> + INT8 + INT16 + INT32 + + + + + + + + INT8: 8-bit signed integer + INT16: 16-bit signed integer + INT32: 32-bit signed integer + + + + + +These are signed numbers. The latter two are byte-swapped when +the client and server have different byte orders. + +
+ +
+ <type>OFFSET32</type> + OFFSET32 + + + + + + + + OFFSET32: + [ position:CARD32, +  length:CARD32 ] + + + + +This structure indicates a position and length within a block of +data. + +
+ +
+ <type>PROPINFO</type> + PROPINFO + + + + + + + + PROPINFO: + [ offsets:LISTofPROPOFFSET, +  data:LISTofBYTE ] + + + + + +This structure describes the list of properties provided by a +font. Strings for all of the properties names and values are +stored within the data block and are located using a table of +offsets and lengths. + + +This structure is padded to 32-bit alignment. + + +
+ +
+ <type>PROPOFFSET</type> + PROPOFFSET + + + + + + + + PROPOFFSET: + [ name:OFFSET32, +  value:OFFSET32, +  type:CARD8, +  zero-pad3:BYTE, BYTE, BYTE ] + + + + + +This structure specifies the position, length, and type of +of data for a property. + + +The NAME field specifies the position and length +(which must be +greater than zero) of the property name relative to the beginning +of the PROPINFO.DATA block for this font. +The interpretation of +the position and length of the VALUE field is +determined by the TYPE field, which contains +one of the following alternate values: + + + + + + + + String0 + Unsigned1 + Signed2 + + + +which have the following meanings: + + + String + + String + +This property contains a counted string of bytes. The +data is stored in the PROPINFO.DATA +block beginning at +relative byte VALUE.POSITION (beginning with zero), extending +for VALUE.LENGTH (at least zero) bytes. + + + + + Unsigned + + Unsigned + +This property contains a unsigned, 32-bit number stored +as a CARD32 in VALUE.POSITION (VALUE.LENGTH is zero). + + + + + Signed + + Signed + +This property contains a signed, 32-bit number stored as +an INT32 in VALUE.POSITION (VALUE.LENGTH is zero). + + + + +This structure is zero-padded to 32-bit alignment. + + +
+ +
+ <type>RANGE</type> + RANGE + + + + + + + + RANGE: + [ min-char, max-char:CHAR2B ] + + + + + +This structure specifies a range of character codes. A single +character is represented by MIN-CHAR equals +MAX-CHAR. If the linear interpretation of +MAX-CHAR is less than that of +MIN-CHAR, or if +MIN-CHAR is less than the font's +XFONTINFO.CHAR-RANGE.MIN-CHAR, or if +MAX-CHAR is greater than the +font's XFONTINFO.CHAR-RANGE.MAX-CHAR, +the range is invalid. + + +
+ +
+ <type>RESOLUTION</type> + RESOLUTION + + + + + + + + RESOLUTION: + [ x-resolution:CARD16, +  y-resolution:CARD16, +  decipoint-size:CARD16 ] + + + + + +This structure specifies resolution and point size to be used in +resolving partially-specified scaled font names. The +X-RESOLUTION and +Y-RESOLUTION are measured in +pixels-per-inch and must be greater than zero. +The DECIPOINT-SIZE is the preferred font +size, measured in tenths of a point, and must be greater than zero. + + +
+ +
+ <type>STRING8</type> + STRING8 + + + + + + + + STRING8: LISTofCARD8 + + + + + +This is a counted list of 1-byte character codes, typically +encoded in ISO 8859-1. A character code +c is equivalent to a +CHAR2B structure whose BYTE1 +is zero and whose BYTE2 is +c. + + +
+ +
+ <type>TIMESTAMP</type> + TIMESTAMP + + + + + + + + TIMESTAMP: CARD32 + + + + + +This is the number of milliseconds that have passed since a +server-dependent origin. It is provided in errors and events and is +permitted to wrap. + +
+ +
+ <type>XCHARINFO</type> + XCHARINFO + + + + + + + + XCHARINFO: + [ lbearing, rbearing:INT16, +  width:INT16, +  ascent, descent:INT16, +  attributes:CARD16 ] + + + + + +This structure specifies the ink extents and horizontal escapement +(also known as the set- or logical width) of an individual +character. The first five values represent directed distances in +a coordinate system whose origin is aligned with the lower-left +edge of the left-most pixel of the glyph baseline (i.e. the +baseline falls between two pixels as shown in Figure 3-1 of the +Bitmap Distribution Format 2.1 Consortium standard +). + + +The LBEARING field specifies the +directed distance measured to the +right from the origin to the left edge of the left-most inked +pixel in the glyph. + + +The RBEARING field specifies the +directed distance (measured to +the right) from the origin to the right edge of the right-most +inked pixel in the glyph. + + +The WIDTH field specifies the +directed distance (measured to the +right) from the origin to the position where the next character +should appear (called the escapement point). This +distance includes any whitespace used for intercharacter padding and is +also referred to as the logical width or +horizontal escapement. +horizontal escapement + + +The ASCENT field specifies the +directed distance (measured up) +from the baseline to the top edge of the top-most inked pixel +in the glyph. + + +The DESCENT field specifies the +directed distance (measured +down) from the baseline to the bottom edge of the bottom-most +inked pixel. + + +The ATTRIBUTES field specifies +glyph-specific information that +is passed through the application. If this value is not being +used, it should be zero. + + +The ink bounding box of a glyph is defined to be the smallest +rectangle that encloses all of the inked pixels. This box has +a width of +RBEARING − LBEARING +pixels and a height of +ASCENT + DESCENT pixels. + +
+ +
+ <type>XFONTINFO</type> + XFONTINFO + + + + + + + + XFONTINFO: + [ flags:CARD32, +  drawing-direction:{ LeftToRight, RightToLeft } +  char-range:RANGE, +  default-char:CHAR2B, +  min-bounds:XCHARINFO, +  max-bounds:XCHARINFO, +  font-ascent:INT16, +  font-descent:INT16, +  properties:PROPINFO ] + + + + +This structure specifies attributes related to the font as a +whole. + + +The FLAGS field is a bit mask containing zero +or more of the following boolean values (unspecified bits must be zero): + + + + + + + + AllCharactersExist(1 << 0) + InkInside(1 << 1) + HorizontalOverlap(1 << 2) + + + + +which have the following meanings: + + + AllCharactersExist + + AllCharactersExist + +If this bit is set, all of the characters in the range given by +CHAR-RANGE have glyphs encoded in +the font. If this bit is clear, some of the characters +may not have encoded glyphs. + + + + + InkInside + + InkInside + +If this bit is set, the inked pixels of each glyph +fall within the rectangle described by the font's ascent, +descent, origin, and the glyph's escapement point. If +this bit is clear, there may be glyphs whose ink extends +outside this rectangle. + + + + + HorizontalOverlap + + HorizontalOverlap + +If this bit is set, the two ink bounding +boxes (smallest rectangle enclosing the inked pixels) of +some pairs of glyphs in the font may overlap when displayed +side-by-side (i.e. the second character is imaged at the +escapement point of the first) on a common baseline. If +this bit is clear, there are no pairs of glyphs whose ink +bounding boxes overlap. + + + + + + + LeftToRight + RightToLeft +The DRAWING-DIRECTION field contains a hint +indicating whether most of the character metrics have a positive (or +LeftToRight) logical width or a +negative (RightToLeft) logical width. It +contains the following alternate values: + + + + + + + LeftToRight0 + RightToLeft1 + + + + + +The CHAR-RANGE.MIN-CHAR +and CHAR-RANGE.MAX-CHAR fields specify the +first and last character codes that have glyphs encoded in this font. +All fonts must have at least one encoded glyph (in which case the +MIN-CHAR and MAX-CHAR +are equal), but are not required to have glyphs +encoded at all positions between the first and last characters. + + +The DEFAULT-CHAR field specifies +the character code of the glyph +that the client should substitute for unencoded characters. Requests +for extents or bitmaps for an unencoded character generate zero-filled +metrics and a zero-length glyph bitmap, respectively. + + +The MIN-BOUNDS and +MAX-BOUNDS fields contain the minimum and maximum +values of each of the extents field of all encoded characters in the +font (i.e. non-existent characters are ignored). + + +The FONT-ASCENT and +FONT-DESCENT fields specify the font designer's +logical height of the font, above and below the baseline, +respectively. The sum of the two values is often used as the +vertical line spacing of the font. Individual glyphs are permitted +to have ascents and descents that are greater than these values. + + +The PROPERTIES field contains the +property data associated with this font. + + +This structure is padded to 32-bit alignment. + +
+
+ +
+Requests + + + + +This section describes the requests that may be sent by the client and the +replies or errors that are generated in response. Versions of the protocol +with the same major version are required to be upward-compatible. + + +Every request on a given connection is implicitly assigned a sequence number, +starting with 1, that is used in replies, error, and events. Servers are +required to generate replies and errors in the order in which the corresponding +requests are received. Servers are permitted to add or remove fonts to the +list visible to the client between any two requests, but requests must be +processed atomically. Each request packet is at least 4 bytes long and +contains the following fields: + + + + + + + + major-opcode:CARD8 + minor-opcode:CARD8 + length:CARD16 + + + + + + +The MAJOR-OPCODE specifies which core request or +extension package this packet represents. If the +MAJOR-OPCODE corresponds to a core request, the +MINOR-OPCODE contains 8 bits of request-specific data. +Otherwise, the MINOR-OPCODE specifies which extension +request this packet represents. The LENGTH field +specifies the number of 4-byte units contained within the packet +and must be at least one. If this field contains a value greater than one it +is followed by (LENGTH - 1) * 4 bytes +of request-specific data. Unless +otherwise specified, unused bytes are not required to be zero. + + +If a request packet contains too little or too much data, the server returns +a Length error. +If the server runs out of internal +resources (such as memory) while processing a request, it returns an +Alloc error. +If a server is deficient (and therefore non-compliant) and is unable to +process a request, it may return an +Implementation error. +If a client uses an extension request without previously having issued a +QueryExtension +request for that extension, the server responds with a +Request +error. If the server encounters a request with an unknown +MAJOR-OPCODE or MINOR-OPCODE, +it responds with a +Request +error. +At most one error is generated per request. If more than one error condition +is encountered in processing a requests, the choice of which error is returned +is server-dependent. + + +Core requests have MAJOR-OPCODE values between 0 and +127, inclusive. Extension requests have MAJOR-OPCODE +values between 128 and 255, inclusive, that are assigned by by the server. +All MINOR-OPCODE values in extension requests are +between 0 and 255, inclusive. + + +Each reply is at least 8 bytes long and contains the following fields: + + + + + + + + type:CARD8value of 0 + data-or-unused:CARD8 + sequence-number:CARD16 + length:CARD32 + + + + + +The TYPE field has a value of zero. +The DATA-OR-UNUSED field may be used to +encode one byte of reply-specific data (see +Section 5.2 on request encoding). +The least-significant 16 bits of the sequence number of the request that +generated the reply are stored in the SEQUENCE-NUMBER +field. The LENGTH field specifies the number of +4-byte units in this reply packet, including the fields described above, +and must be at least two. If LENGTH is greater +than two, the fields described above are followed by +(LENGTH - 2) * 4 bytes of additional data. + + +Requests that have replies are described using the following syntax: +
+ RequestName + + + + + + + arg1:type1 + arg2:type2 + ... + argN:typeN + ▶ + result1:type1 + result2:type2 + ... + resultM:typeM + Errors:kind1, kind2 ..., kindK + + + + Description +
+ + +If a request does not generate a reply, the ▶ and result lines are +omitted. If a request may generate multiple replies, the ▶ is replaced by +a ▶+. In the authorization data exchanges in the initial connection setup +and the CreateAC request, ◀ indicates data sent by the client in response +to data sent by the server. + + +The protocol begins with the establishment of a connection over a +mutually-understood virtual stream: + + +
+ open connection + open connection + + + + + + + byte-order:BYTE + client-major-protocol-version:CARD16 + client-minor-protocol-version:CARD16 + authorization-protocols:LISTofAUTH + + + + +The initial byte of the connection specifies the +BYTE-ORDER in +which subsequent 16-bit and 32-bit numeric values are to be +transmitted. The octal value 102 +(ASCII uppercase B) +indicates that the most-significant byte is to be transmitted +first; the octal value 154 +(ASCII lowercase l) +indicates that the least-significant byte is to be transmitted first. +If any other value is encountered the server closes the +connection without any response. + + +The CLIENT-MAJOR-PROTOCOL-VERSION and +CLIENT-MINOR-PROTOCOL-VERSION specify +which version of the +font service protocol the client would like to use. If the +client can support multiple versions, the highest version +should be given. This version of the protocol has a +major version of 2 and a minor version of 0. + + +The AUTHORIZATION-PROTOCOLS +contains a list of protocol names and +optional initial data for which the client can provide +information. The server may use this to determine which +protocol to use or as part of the initial exchange of +authorization data. + + + + + + + + ▶ + status:{ Success, Continue, + Busy, Denied } + server-major-protocol-version:CARD16 + server-minor-protocol-version:CARD16 + alternate-servers-hint:LISTofALTERNATESERVER + authorization-index:CARD8 + authorization-data:LISTofBYTE + + + + +The SERVER-MAJOR-PROTOCOL-VERSION and +SERVER-MINOR-PROTOCOL-VERSION specify +the version of the font +service protocol that the server expects from the client. If +the server supports the version specified by the client, this +version number should be returned. If the client has +requested a higher version than is supported by the server, +the server's highest version should be returned. Otherwise, +if the client has requested a lower version than is supported +by the server, the server's lowest version should be returned. +It is the client's responsibility to decide whether or not it +can match this version of the protocol. + + +The ALTERNATE-SERVERS-HINT +is a list of other font servers +that may have related sets of fonts (determined by means +outside this protocol, typically by the system administrator). +Clients may choose to contact these font servers if the +connection is rejected or lost. + + +The STATUS field indicates whether the server accepted, +rejected, or would like more information about the connection. +It has one of the following alternate values: + + + + + + + Success0 + Continue1 + Busy2 + Denied3 + + + + + +If STATUS is Denied, +the server has rejected the client's authorization information. +If STATUS is Busy, the server has +simply decided that it cannot provide fonts to this client at +this time (it may be able to at a later time). In both cases, +AUTHORIZATION-INDEX is set to zero, +no authorization-data is +returned, and the server closes the connection after sending +the data described so far. + + +Otherwise the AUTHORIZATION-INDEX is set to the index +(beginning with 1) into the AUTHORIZATION-PROTOCOLS +list of the protocol that the server will use for this connection. If +the server does not want to use any of the given protocols, +this value is set to zero. The AUTHORIZATION-DATA +field is used to send back authorization protocol-dependent data to the +client (such as a challenge, authentication of the server, +etc.). + + +If STATUS is Success, +the following section of protocol is omitted. Otherwise, if +STATUS is Continue, +the server expects +more authorization data from the client (i.e. the connection +setup is not finished, so no requests or events may be sent): + + + + + + + ◀ + more-authorization-data:STRING8 + ▶ + status:{ Success, Continue, Busy, Denied } + more-authorization-data:LISTofBYTE + + + + + +The values in STATUS have the same meanings as described +above. This section of protocol is repeated until the server +either accepts (sets STATUS to +Success) or rejects (sets STATUS +to Denied or Busy) the connection. + + +Once the connection has been accepted and STATUS +is Success, +an implicit AccessContext is created for the authorization +data and the protocol continues with the following data sent +from the server: + + + + + + + ▶ + remaining-length:CARD32 + maximum-request-length:CARD16 + release-number:CARD32 + vendor:STRING8 + + + + + +The REMAINING-LENGTH specifies the length in 4-byte +units of the remaining data to be transmitted to the client. The +MAXIMUM-REQUEST-LENGTH specifies the largest request +size in 4-byte units that is accepted by the server and must have a +value of at least 4096. Requests with a length field larger +than this value are ignored and a +Length +error is returned. +The VENDOR string specifies the name of the +manufacturer of the font server. The +RELEASE-NUMBER specifies the particular +release of the server in a manufacturer-dependent manner. + +
+
+<para> +After the connection is established and the setup information has been +exchanged, the client may issue any of requests described below: +</para> +</section> +<section id="Requests:NoOp"> + <title><function>NoOp</function> + NoOp + + + + + + + Errors:Alloc + + + + +This request does nothing. It is typically used in response +to a +KeepAlive +event. + +
+ +
+ <function>ListExtensions</function> + ListExtensions + + + + + + + ▶ + names:LISTofSTRING8 + Errors:Alloc + + + + + +This request returns the names of the extension packages +that are supported by the server. Extension names are +case-sensitive and are encoded in ISO 8859-1. + + +
+ +
+ <function>QueryExtension</function> + QueryExtension + + + + + + + + name:STRING8 + ▶ + present:BOOL + major-version:CARD16 + minor-version:CARD16 + major-opcode:CARD8 + first-event:CARD8 + number-events:CARD8 + first-error:CARD8 + number-errors:CARD8 + Errors:Alloc + + + + +This request determines whether or not the extension package specified by +NAME (encoded in ISO 8859-1) is +supported by the server and that there is sufficient number of major opcode, +event, and error codes available. If so, then PRESENT +is set to True, MAJOR-VERSION +and MINOR-VERSION are set to the +respective major and minor version numbers of the protocol +that the server would prefer; MAJOR-OPCODE is set to +the value to use in extension requests; FIRST-EVENT +is set to the value of the first extension-specific event code or zero if the +extension does not have any events; NUMBER-EVENTS is +set to the number of new events that the event defines; +FIRST-ERROR +is set to the value of the first extension-specific error code +or zero if the extension does not define any new errors; and +NUMBER-ERRORS is set to the number of +new errors the extension defines. + + +Otherwise, PRESENT is set to +False and the remaining fields are +set to zero. + + +The server is free to return different values to different +clients. Therefore, clients must use this request before +issuing any of the requests in the named extension package or +using the +SetEventMask request to express interest in any of +this extension's events. Otherwise, a +Request +error is returned. + +
+ +
+ <function>ListCatalogues</function> + ListCatalogues + + + + + + + + pattern:STRING8 + max-names:CARD32 + ▶+ + replies-following-hint:CARD32 + names:LISTofSTRING8 + Errors:Alloc + + + + +This request returns a list of at most MAX-NAMES names +of collections (called catalogues) of fonts that match +the specified PATTERN. In the pattern (which is encoded +in ISO 8859-1), the +? character (octal 77) +matches any single character; the +* character (octal 52) +matches any series of zero or more characters; and alphabetic +characters match either upper- or lowercase. The +returned NAMES are encoded in +ISO 8859-1 and may contain +mixed character cases. + + +If PATTERN is of zero length or +MAX-NAMES is equal to zero, +one reply containing a zero-length list of names is returned. +This may be used to synchronize the client with the server. + + +Servers are free to add or remove catalogues to the set returned by +ListCatalogues +between any two requests. This request is not +cumulative; repeated uses are processed in isolation and do +result in an iteration through the list. + + +To reduce the amount of buffering needed by the server, the +list of names may be split across several reply packets, so +long as the names arrive in the same order that they would +have appeared had they been in a single packet. The +REPLIES-FOLLOWING-HINT field in all but the last reply +contains a positive value that specifies the number of +replies that are likely, but not required, to follow. In the +last reply, which may contain zero or more names, this field +is set to zero. + +
+ +
+ <function>SetCatalogues</function> + SetCatalogues + + + + + + + names:LISTofSTRING8 + Errors:Alloc, +Name + + + + +This request sets the list of catalogues whose fonts should be +visible to the client. The union of the fonts provided by +each of the named catalogues forms the set of fonts whose +names match patterns in +ListFonts, +ListFontsWithXInfo, +and +OpenBitmapFont +requests. The catalogue names are +case-insensitive and are encoded in ISO 8859-1. A zero-length +list resets the client's catalogue list to the +server-dependent default. + + +If any of the catalogue names are invalid, a +Name +error is returned and the request is ignored. + +
+ +
+ <function>GetCatalogues</function> + GetCatalogues + + + + + + + ▶ + names:LISTofSTRING8 + Errors:Alloc + + + + +This request returns the current list of catalogue names +(encoded in ISO 8859-1) associated with the client. These +catalogues determine the set of fonts that are visible +to +ListFonts, +ListFontsWithXInfo, +and +OpenBitmapFont. +A zero-length list indicates the server's default set of +fonts. Catalogue names are case-insensitive and may be +returned in mixed case. + +
+ +
+ <function>SetEventMask</function> + SetEventMask + + + + + + + extension-opcode:CARD8 + event-mask:EVENTMASK + Errors:EventMask, +Request + + + + +This request specifies the set of maskable events that the +extension indicated by EXTENSION-OPCODE +(or zero for the core) +should generate for the client. Event masks are limited in +scope to the extension (or core) for which they are defined, +so expressing interest in events from one or more extensions +requires multiple uses of this request. + + +The default event mask if +SetEventMask +has not been called +is zero, indicating no interest in any maskable events. +Some events are not maskable and cannot be blocked. + + +If EXTENSION-OPCODE is not a valid extension +opcode previously returned by +QueryExtension +or zero, a +Request +error is +returned. If EVENT-MASK contains any bits that do not +correspond to valid events for the specified extension (or +core), an +EventMask +error is returned and the request is +ignored. + +
+ +
+ <function>GetEventMask</function> + GetEventMask + + + + + + + extension-opcode:CARD8 + ▶ + event-mask:EVENTMASK + Errors:Request + + + + +This request returns the set of maskable core events the +extension indicated by EXTENSION-OPCODE +(or the core if zero) +should generate for the client. Non-maskable events are +always sent to the client. + + +If EXTENSION-OPCODE is not a valid extension opcode +previously returned by +QueryExtension +or zero, a +Request +error is returned. + +
+ +
+ <function>CreateAC</function> + CreateAC + + + + + + + ac:ACCESSCONTEXT + authorization-protocols:LISTofAUTH + ▶ + status:{ Success, Continue, Denied } + authorization-index:CARD8 + authorization-data:LISTofBYTE + Errors:IDChoice + + + + +This request creates a new +AccessContext +object within the +server containing the specified authorization data. When +this +AccessContext +is selected by the client using the +SetAuthorization +request, the data may be used by the server +to determine whether or not the client should be granted +access to particular font information. + + +If STATUS is Denied, the server +rejects the client's authorization information and does not associate +AC with any valid AccessContext. +In this case, AUTHORIZATION-INDEX is set +to zero, and zero bytes of AUTHORIZATION-DATA +is returned. + + +Otherwise, AUTHORIZATION-INDEX is set to the index +(beginning with 1) into the AUTHORIZATION-PROTOCOLS +list of the protocol +that the server will use for this connection. If the server +does not want to use any of the given protocols, this value is +set to zero. The AUTHORIZATION-DATA field is used +to send back authorization protocol-dependent data to the client (such +as a challenge, authentication of the server, etc.). + + +If STATUS is Continue, +the client is expected to continue +the request by sending the following protocol and receiving +the indicated response from the server. This continues +until STATUS is set to either +Success or Denied. + + + + + + + + ◀ + more-authorization-data:STRING8 + ▶ + status:{ Success, Continue, Denied } + more-authorization-data:LISTofBYTE + + + + +Once the connection has been accepted and STATUS +is Success, the request is complete. + + +If AC is not in the range +[1..229-1] or is already associated +with an access context, an IDChoice error is returned. + +
+ +
+ <function>FreeAC</function> + FreeAC + + + + + + + ac:ACCESSCONTEXT + Errors:AccessContext, +Alloc + + + + +This request indicates that the specified AC should +no longer be associated with a valid access context. +If AC is also the current +AccessContext +(as set by the +SetAuthorization +request), an implicit +SetAuthorization +of None is done to +restore the +AccessContext +established for the initial +connection setup. Operations on fonts that were opened under +AC are not affected. The client may reuse the +value of AC in a subsequent +CreateAC +request. + + +If AC isn't associated with any valid authorization +previously created by +CreateAC, an +AccessContext +error is returned. + +
+ +
+ <function>SetAuthorization</function> + SetAuthorization + + + + + + + ac:ACCESSCONTEXT + Errors:AccessContext + + + + +This request sets the +AccessContext +to be used for subsequent +requests (except for +QueryXInfo, +QueryXExtents8, +QueryXExtents16, +QueryXBitmaps8, +QueryXBitmaps16 +and +CloseFont +which are done under the +AccessContext +of the +corresponding +OpenBitmapFont +). +An AC of None restores the +AccessContext +established for the initial connection setup. + + +If AC is neither None +nor a value associated with a valid AccessContext +previously created by +CreateAC, +an +AccessContext +error is returned. + +
+ +
+ <function>SetResolution</function> + SetResolution + + + + + + + resolutions:LISTofRESOLUTION + Errors:Resolution, +Alloc + + + + +This request provides a hint as to the resolution and +preferred point size of the drawing surfaces for which the +client will be requesting fonts. The server may use this +information to set the RESOLUTION_X and RESOLUTION_Y fields +of scalable XLFD font names, to order sets of names based on +their resolutions, and to choose the server-dependent +instance that is used when a partially-specified scalable +fontname is opened. + + +If a zero-length list of RESOLUTIONs is given, the +server-dependent default value is restored. Otherwise, if +elements of all of the specified RESOLUTIONs are non-zero, the +default resolutions for this client are changed. + + +If a RESOLUTION entry contains a zero, +a Resolution error is +returned and the default resolutions are not changed. + +
+ +
+ <function>GetResolution</function> + GetResolution + + + + + + + ▶ + resolutions:LISTofRESOLUTION + Errors:Alloc + + + + +This request returns the current list of default resolutions. +If a client has not performed a +SetResolution, +a server-dependent default value is returned. + +
+ +
+ <function>ListFonts</function> + ListFonts + + + + + + + pattern:STRING8 + max-names:CARD32 + ▶+ + replies-following-hint:CARD32 + names:LISTofSTRING8 + Errors:Alloc + + + + +This request returns a list of at most MAX-NAMES +font names that match the specified PATTERN, +according to matching rules +of the X Logical +Font Description Conventions +. +In the pattern (which is encoded in ISO 8859-1) the +? character (octal 77) +matches any single character; the +* character (octal 52) +matches any series of zero or more characters; and +alphabetic characters match either upper- or lowercase. The +returned NAMES are encoded in +ISO 8859-1 and may contain mixed +character cases. Font names are not required to be in XLFD +format. + + +If PATTERN is of zero length or +MAX-NAMES is equal to zero, +one reply containing a zero-length list of names is returned. +This may be used to synchronize the client with the server. + + +Servers are free to add or remove fonts to the set returned by +ListFonts +between any two requests. This request is not +cumulative; repeated uses are processed in isolation and do +result in an iteration through the list. + + +To reduce the amount of buffering needed by the server, the +list of names may be split across several reply packets, so +long as the names arrive in the same order that they would +have appeared had they been in a single packet. The +REPLIES-FOLLOWING-HINT field in all but the last reply +contains a positive value that specifies the number of +replies that are likely, but not required, to follow. In the +last reply, which may contain zero or more names, this field +is set to zero. + +
+ +
+ <function>ListFontsWithXInfo</function> + ListFontsWithXInfo + + + + + + + pattern:STRING8 + pattern:STRING8 + pattern:STRING8 + max-names:CARD32 + ▶+ + replies-following-hint:CARD32 + info:XFONTINFO + name:STRING8 + Errors:Alloc + + + + +This request is similar to +ListFonts +except that a separate +reply containing the name, header, and property data is +generated for each matching font name. Following these +replies, if any, a final reply containing a zero-length +NAME and no INFO is sent. + + +The REPLIES-FOLLOWING-HINT field in all but the +last reply contains a positive value that specifies the number of replies +that are likely, but not required, to follow. In the last +reply, this field is set to zero. + + +If PATTERN is of zero length or if +MAX-NAMES is equal to zero, only the final reply +containing a zero-length NAME and no +INFO is returned. This may be used to synchronize the +client with the server. + +
+ +
+ <function>OpenBitmapFont</function> + OpenBitmapFont + + + + + + + fontid:FONTID + pattern:STRING8 + format-mask:BITMAPFORMATMASK + format-hint:BITMAPFORMAT + ▶ + otherid:FONTID or None + otherid-valid:BOOL + cachable:BOOL + Errors: +IDChoice, +Name, +Format, +AccessContext, +Alloc + + + + +This request looks for a server-dependent choice of the +font names that match the specified PATTERN +according to the rules described for +ListFonts. +If no matches are found, a +Name +error is returned. Otherwise, the server attempts to +open the font associated with the chosen name. + + +Permission to access the font is determined by the server +according the licensing policy used for this font. The server +may use the client's current +AccessContext +(as set by the most +recent +SetAuthorization +request or the original connection +setup) to determine any client-specific sets of permissions. +After the font has been opened, the client is allowed to +specify a new +AccessContext +with +SetAuthorization +or release +the +AccessContext +using +FreeAC +. Subsequent +QueryXInfo, +QueryXExtents8, +QueryXExtents16, +QueryXBitmaps8, +QueryXBitmaps16 +and +CloseFont +requests on this FONTID are +performed according to permissions granted at the time of the +OpenBitmapFont +request. + + +If the server is willing and able to detect that the client +has already opened the font successfully (possibly under a +different name), the OTHERID field +may be set to one of the +identifiers previously used to open the font. The +OTHERID-VALID field indicates whether or not +OTHERID is still associated with an open font: +if it is True, the client may use +OTHERID as an alternative to +FONTID. Otherwise, if +OTHERID-VALID is False, +OTHERID is no longer +open but has not been reused by a subsequent +OpenBitmapFont +request. + + +If OTHERID is set to None, +then OTHERID-VALID should be set +to False. + + +The FORMAT-MASK indicates which fields in +FORMAT-HINT +the client is likely to use in subsequent +GetXBitmaps8 +and +GetXBitmaps16 +requests. Servers may wish to use +this information to precompute certain values. + + +If CACHABLE is set to True, +the client may cache the font +(so that redundant opens of the same font may be avoided) +and use it with all +AccessContexts +during the life of the +client without violating the font's licensing policy. This +flag is typically set whenever a font is unlicensed or is +licensed on a per-display basis. If CACHABLE +is False, the +client should reopen the font for each +AccessContext. + + +The server is permitted to add to or remove from the set of +fonts returned by +ListFonts +between any two requests, though +mechanisms outside the protocol. Therefore, it is possible +for this request (which is atomic) to return a different font +than would result from separate a +ListFonts +followed by an +OpenBitmapFont +with a non-wildcarded font name. + + +If FONTID is not in the range +[1..229-1] or if it is already +associated with an open font, an +IDChoice +error is returned. +If no font is available that matches the specified +PATTERN, a +Name +error is returned. If the font is present but the client +is not permitted access, an +AccessContext +error is returned. +If FORMAT-MASK has any unspecified bits set or if any +of the fields in FORMAT-HINT indicated by +FORMAT-MASK are invalid, a +Format +error is returned. + +
+ +
+ <function>QueryXInfo</function> + QueryXInfo + + + + + + + fontid:FONTID + ▶ + info:XFONTINFO + Errors:Font, +Alloc + + + + +This request returns the font header and property information +for the open font associated with FONTID. + + +If FONTID is not associated with any open fonts, a +Font +error +is returned. + +
+ +
+ <function>QueryXExtents8</function> + QueryXExtents8 + + + + + + + fontid:FONTID + range:BOOL + chars:STRING8 + ▶ + extents:LISTofXCHARINFO + Errors:Font, +Range, +Alloc + + + + +This request is equivalent to +QueryXExtents16 +except that it +uses 1-byte character codes. + +
+ +
+ <function>QueryXExtents16</function> + QueryXExtents16 + + + + + + + fontid:FONTID + range:BOOL + chars:LISTofCHAR2B + ▶ + extents:LISTofXCHARINFO + Errors:Font, +Range, +Alloc + + + + +This request returns a list of glyph extents from the open +font associated with FONTID for the series of characters +specified by RANGE and CHARS. + + +If RANGE is True, +each succeeding pair of elements in CHARS is +treated as a range of characters for which extents should be +returned. If CHARS contains an odd number of elements, +the font's XFONTINFO.CHAR-RANGE.MAX-CHAR +is implicitly appended to +the list. If CHARS contains no elements, the list is +implicitly replaced with the font's +XFONTINFO.CHAR-RANGE. If +any of the resulting character ranges are invalid, a +Range +error is returned. Otherwise, the character ranges are +concatenated in the order given by CHARS to produce +a set of character codes for which extents are returned. + + +If RANGE is False, +then CHARS specifies the set of character +codes for which extents are returned. If CHARS is of +zero length, then a zero-length list of extents is returned. + + +The extents for each character code in the resulting set (which +may contain duplicates) are returned in the order in +which the character codes appear in the set. +At least one metric for each character shall be non-zero +unless the character is not encoded in the font, in which case +all-zero metrics are returned. +A blank, zero-width character can be encoded +with non-zero but equal left and right bearings. + + +If FONTID is not associated with any open fonts, a +Font +error is +returned. If RANGE is True +and CHARS contains any invalid ranges, a +Range +error is returned. + +
+ +
+ <function>QueryXBitmaps8</function> + QueryXBitmaps8 + + + + + + + fontid:FONTID + range:BOOL + chars:STRING8 + format:BITMAPFORMAT + ▶+ + replies-following-hint:CARD32 + offsets:LISTofOFFSET32 + bitmaps:LISTofBYTE + Errors:Font, +Range, +Format, +Alloc + + + + +This request is equivalent to +QueryXBitmaps16 +except that it +uses 1-byte character codes. + +
+ +
+ <function>QueryXBitmaps16</function> + QueryXBitmaps16 + + + + + + + fontid:FONTID + range:BOOL + chars:LISTofCHAR2B + format:BITMAPFORMAT + ▶+ + replies-following-hint:CARD32 + offsets:LISTofOFFSET32 + bitmaps:LISTofBYTE + Errors:Font, + Range, + Format, + Alloc + + + + +This request returns a list of glyph bitmaps from the open font associated +with FONTID for the series of characters +specified by RANGE and CHARS. + + +If RANGE is True, each succeeding +pair of elements in CHARS is +treated as a range of characters for which bitmaps should be +returned. If CHARS contains an odd number of elements, +the font's XFONTINFO.CHAR-RANGE.MAX-CHAR +is implicitly appended to +the list. If CHARS contains no elements, the list is +implicitly replaced with the font's +XFONTINFO.CHAR-RANGE. If +any of the resulting character ranges are invalid, a Range +error is returned. Otherwise, the character ranges are +concatenated in the order given by CHARS to produce +a set of character codes for which bitmaps are returned. + + +If RANGE is False, +then CHARS specifies the set of character +codes for which bitmaps are returned. If CHARS +is of zero length, then a single reply containing a zero-length list of +offsets and bitmaps is returned. + + +If any of the resulting character ranges are invalid, a +Range +error is returned. Otherwise, the resulting character ranges +are concatenated in the order given by CHARS +to produce a set of character codes for which bitmaps are returned. + + +The server is free to return the glyph bitmaps in multiple +replies to reduce the amount of buffering that is necessary. +In this situation, the set of characters obtained above is +partitioned into an implementation-dependent number of +ordered, non-overlapping subsets containing runs of one or +more consecutive characters. The global ordering of +characters must be maintained such that concatenating the +subsets in order that they were produced yields the original +set. A reply is generated for each subset, in the order that +it was produced. + + +For each character in a subset, an image of that character's +glyph is described by a rectangle of bits corresponding to the +pixels specified by FORMAT.IMAGE-RECT. Within the image, set +and clear bits represent inked and non-inked pixels, +respectively. + + +Each scanline of a glyph image, from top to bottom, is zero-padded +on the right to a multiple of the number of bits specified by +FORMAT.SCANLINE-PAD. The scanline is then divided from left +to right into a sequence of FORMAT.SCANLINE-UNIT bits. The +bits of each unit are then arranged such that the left-most +pixel is stored in the most- or least-significant bit, +according to FORMAT.BIT-ORDER-MSB. The bytes of each unit are +then arranged such that the most- or least-significant byte, +according to FORMAT.BYTE-ORDER-MSB, is transmitted first. +Finally, the units are arranged such that the left-most is +transmitted first and the right-most is transmitted last. + + +The individual images within a subset are then concatenated in +a server-dependent order to form the BITMAPS data +of the reply. If a glyph image is duplicated within a reply, the +server is free to return fewer (but at least one) copies of +the image. If a character is not encoded within the font, a +zero-length bitmap is substituted for this character. Each +glyph image must begin at a bit position that is a multiple of +the FORMAT.SCANLINE-UNIT. + + +The OFFSETS array in a reply contains one entry +for each character in the subset being returned, in the order that the +characters appear in the subset. Each entry specifies the +starting location in bytes and size in bytes of the +corresponding glyph image in the BITMAPS data of that +reply (i.e. an offset may not refer to data in another reply). + + +The REPLIES-FOLLOWING-HINT field in all but the +last reply contains a positive value that specifies the number of replies +that are likely, but not required, to follow. In the last +reply, which may contain data for zero or more characters, +this field is set to zero. + + +If FONTID is not associated with any open fonts, +a Font +error is returned. If RANGE is +True and CHARS contains any +invalid ranges, a +Range error +is returned. If FORMAT is invalid, a +Format error +is returned. + +
+ +
+ <function>CloseFont</function> + CloseFont + + + + + + + fontid:FONTID + Errors:Font, Alloc + + + + +This request indicates that the specified FONTID +should no longer be associated with an open font. The server is free to +release any client-specific storage or licenses allocated for +the font. The client may reuse the value of FONTID +in a subsequent +OpenBitmapFont +request. + + +If FONTID is not associated with any open fonts, a +Font +error is returned. + +
+ +
+ close connection + close connection + + +When a connection is closed, a +CloseFont +is done on all fonts +that are open on the connection. In addition, the server is +free to release any storage or licenses allocated on behalf of +the client that made the connection. + +
+
+ +
+Errors + + + + +All errors are at least 16 bytes long and contain the following fields: + + + + + + + + + type:CARD8value of 1 + error-code:CARD8 + sequence-number:CARD16 + length:CARD32 + timestamp:TIMESTAMP + major-opcode:CARD8 + minor-opcode:CARD8 + data-or-unused:CARD16 + + + + +The TYPE field has a value of one. The ERROR-CODE field specifies which error +occurred. Core errors codes are in the range 0 through 127, extension error +codes are in the range 128 through 255. The SEQUENCE-NUMBER field contains the +least significant 16 bits of the sequence number of the request that caused the +error. The LENGTH field specifies the length of the error packet in 4-byte +units and must have a value of at least 4. The TIMESTAMP specifies the server +time when the error occurred. The MAJOR-OPCODE and MINOR-OPCODE (zero for core +requests) fields specify the type of request that generated the error. The +DATA-OR-UNUSED field may be used for 16 bits of error-specific information. If +LENGTH is greater than four, these fields are followed by (LENGTH - 4) * 4 +bytes of extra data. + + +The following errors are defined for the core protocol: + + +
+ <errorname>Request</errorname> + Error CodesRequest + + + + + + + + data-or-unused:CARD16unused + + + + +This error is generated by any request that has an unknown +combination of major and minor request numbers, or by any +extension request that is issued before a +QueryExtension +of that extension. + +
+ +
+ <errorname>Format</errorname> + Error CodesFormat + + + + + + + + data-or-unused:CARD16unused + format:BITMAPFORMATbad format value + + + + +This error is generated by the use of an invalid BITMAPFORMAT +in the +OpenBitmapFont, +QueryXBitmaps8, and +QueryXBitmaps16 +requests. +The value that caused the error is included as extra data. + +
+ +
+ <errorname>Font</errorname> + Error CodesFont + + + + + + + + data-or-unused:CARD16unused + fontid:FONTIDbad font identifier + + + + +This error is generated by an invalid FONTID in the +QueryXInfo, +QueryXExtents8, +QueryXExtents16, +QueryXBitmaps8, +QueryXBitmaps16 +and +CloseFont +requests. The value that caused +the error is included as extra data. + +
+ +
+ <errorname>Range</errorname> + Error CodesRange + + + + + + + + data-or-unused:CARD16unused + range:RANGEbad range + + + + +This error is generated by an invalid RANGE in the +QueryXExtents8, +QueryXExtents16, +QueryXBitmaps8 +and +QueryXBitmaps16 +requests. The +value that caused the error is included as extra data. + +
+ +
+ <errorname>EventMask</errorname> + Error CodesEventMask + + + + + + + + data-or-unused:CARD16unused + event-mask:EVENTMASKbad event mask + + + + +This error is generated by an invalid EVENTMASK in the +SetEventMask +request. The value that caused the error is +included as extra data. + +
+ +
+ <errorname>AccessContext</errorname> + Error CodesAccessContext + + + + + + + + data-or-unused:CARD16unused + ac:ACCESSCONTEXTunaccepted AccessContext + + + + +This error is generated by an invalid ACCESSCONTEXT in the +FreeAC +or +SetAuthorization +request or by an +OpenBitmapFont +request performed without sufficient authorization. In the +first two cases, the ACCESSCONTEXT of the errant request is +returned as extra data. In the third case, the current +ACCESSCONTEXT is returned as extra data. + +
+ +
+ <errorname>IDChoice</errorname> + Error CodesIDChoice + + + + + + + + data-or-unused:CARD16unused + id:IDbad identifier + + + + +This error is generated by an invalid or already associated +ACCESSCONTEXT identifier in a +CreateAC +request or FONTID identifier +in an +OpenBitmapFont +request. The value that caused the error +is included as extra data. + +
+ +
+ <errorname>Name</errorname> + Error CodesName + + + + + + + + data-or-unused:CARD16unused + + + + +This error is generated by a font name pattern that matches +no fonts in an +OpenBitmapFont +request or no catalogue names in a +SetCatalogues +request. + +
+ +
+ <errorname>Resolution</errorname> + Error CodesResolution + + + + + + + + data-or-unused:CARD16X value of errant resolution + y-resolution:CARD16Y value of errant resolution + point-size:CARD16point size of errant resolution + + + + +This error is generated in response to an invalid RESOLUTION +structure in a +SetResolution +request. The value that caused the +error is included in the DATA-OR-UNUSED field and as extra data. + +
+ +
+ <errorname>Alloc</errorname> + Error CodesAlloc + + + + + + + + data-or-unused:CARD16unused + + + + +This error is generated by any request for which the server +lacks sufficient resources (especially memory). + +
+ +
+ <errorname>Length</errorname> + Error CodesLength + + + + + + + + data-or-unused:CARD16unused + length:CARD32bad length value + + + + +This error is generated by any request that has a length field +greater than (MAXIMUM-REQUEST-LENGTH * 4) bytes. The value that +caused the error is included as extra data. + +
+ +
+ <errorname>Implementation</errorname> + Error CodesImplementation + + + + + + + + data-or-unused:CARD16unused + + + + +This error may be generated in response to any request that +the server is unable to process because it is deficient. Use +of this error is highly discouraged and indicates lack of +conformance to the protocol. + +
+
+ Extensions + +Additional errors may be defined by extensions. + +
+
+ +
+Events + + + + +Events may be generated in response to requests or at the server's discretion +after the initial connection setup information has been exchanged. Each event +is at least 12 bytes long and contains the following fields: + + + + + + + + type:CARD8value of 2 + event-code:CARD8 + sequence-number:CARD16 + length:CARD32 + timestamp:TIMESTAMP + + + + + +The TYPE field contains the value 2. The EVENT-CODE field specifies the number +of the event and is in the range 0-127 for core events or the range 128-255 for +extensions. The SEQUENCE-NUMBER field specifies the least significant 16 bits +of the sequence number of the last request to have been processed by the +server. The LENGTH field specifies the number of 4-byte units in this event +packet and must always have a value of at least 3. The TIMESTAMP field +specifies the server time when the event occurred. If LENGTH is greater than +three, these fields are followed by (LENGTH - 3) * 4 bytes of additional data. + + +Events are described using the following syntax: +
+ EventName + + + + + + + arg1:type1 + ... + argN:typeN + + + + Description +
+ + +If an event does not provide any extra arguments, the +arg1...argN +lines are omitted from the description. + + +The core X Font Service protocol defines the following events: + + +
+ <function>KeepAlive</function> + KeepAlive + +This unsolicited, nonmaskable event may be sent by the +server to verify that the connection has not been broken +(for transports that do not provide this information). +Clients should acknowledge receipt of this request +by sending any request (such as +NoOp +). + +
+ +
+ <function>CatalogueListNotify</function> + CatalogueListNotify + + + + + + + added:BOOL + deleted:BOOL + + + + +This event is sent to clients that have included +CatalogueListChangeMask +in their core event mask +whenever the list of catalogues that are available has +changed. The ADDED field is True if new catalogues have +been added to the server, otherwise it is False. The +DELETED field is True if any existing catalogues have +been removed from the server, otherwise it is False. + +
+ +
+ <function>FontListNotify</function> + FontListNotify + + + + + + + added:BOOL + deleted:BOOL + + + + +This event is sent to clients that have included +FontListChangeMask +in their event mask whenever the +list of fonts that are provided by the currently selected +catalogues has changed. The ADDED field is True if new +fonts have been added to any of the catalogues currently +used by the client, otherwise it is False. The DELETED +field is True if any existing fonts have been removed +from any of catalogues used by the client, otherwise it +is False. + +
+
+ Extensions + +Additional events may be defined by extensions. + +
+
+ + + +Protocol Encoding + + + + +Numbers that are prefixed with #x +are in hexadecimal (base 16). All other +numbers are in decimal. Requests, replies, errors, events, and compound types +are described using the syntax: + + + + + Name + count contents name + ... + count contents name + + + + +where COUNT is the number of bytes in the data stream occupied by this +field, CONTENTS is the name of the type as given in +Section 4 or the value if +this field contains a constant, and NAME is a description of this field. + + +Objects containing counted lists use a lowercase single-letter variable (whose +scope is limited to the request, reply, event, or error in which it is found) +to represent the number of objects in the list. These variables, and any +expressions in which they are used, should be treated as unsigned integers. +Multiple copies of an object are indicated by CONTENTS prefix +LISTof. + + +Unused bytes (whose value is undefined) will have a blank CONTENTS field and a +NAME field of unused. Zeroed bytes (whose value must be zero) +will have a blank CONTENTS field and a NAME field of zero. +The expression pad(e) refers to the number of bytes +needed to round a value e up to the closed +multiple of four: + + + + + pad(e) = (4 - (e mod 4)) mod 4 + + +
+Data Types + + + + +ACCESSCONTEXT +4 CARD32 access context + + with at least one of the following bits set: + + #x1fffffff + + but none of the following bits set: + + #xe0000000 zero + + +ALTERNATESERVER +1 BOOL subset +1 n length of name +n STRING8 name +p unused, p=pad(n+2) + +AUTH +2 n length of name +2 d length of data +n STRING8 name +p unused, p=pad(n) +d STRING8 data +q unused, q=pad(d) + + +BITMAPFORMAT +4 CARD32 value, union of the following bits: + + #x00000001 ByteOrderMSB + #x00000002 BitOrderMSB + #x00000000 ImageRectMin + #x00000004 ImageRectMaxWidth + #x00000008 ImageRectMax + #x00000000 ScanlinePad8 + #x00000100 ScanlinePad16 + #x00000200 ScanlinePad32 + #x00000300 ScanlinePad64 + #x00000000 ScanlineUnit8 + #x00001000 ScanlineUnit16 + #x00002000 ScanlineUnit32 + #x00003000 ScanlineUnit64 + + except for the following bits which must be zero: + + #xffffccf0 zero + + and the following of which at most one bit may be set: + + #x0000000c at most one bit can be set + + +BITMAPFORMATMASK +4 CARD32 value, mask of the following bits: + + #x00000001 ByteOrderMask + #x00000002 BitOrderMask + #x00000004 ImageRectMask + #x00000008 ScanlinePadMask + #x00000010 ScanlineUnitMask + + except for the following bits which must be zero: + + #xffffffe0 zero + +BOOL +1 BOOL boolean, one of the following values: + 0 False + 1 True + +BYTE +1 BYTE unsigned byte of data + +CARD8 +1 CARD8 8-bit unsigned integer + +CARD16 +2 CARD16 16-bit unsigned integer + +CARD32 +4 CARD32 32-bit unsigned integer + +CHAR2B +1 CARD8 byte1 +1 CARD8 byte2 + +EVENTMASK +4 CARD32 event mask + + for core events, this is union of the following bits: + + #00000001 CatalogueListChangeMask + #00000002 FontListChangeMask + + but none of the following bits set: + + #fffffffc + + extensions define their own sets of bits + +FONTID +4 CARD32 font identifier + + with at least one of the following bits set: + + #x1fffffff + + but none of the following bits set: + + #xe0000000 zero + +INT8 +1 INT8 8-bit signed integer + +INT16 +2 INT16 16-bit signed integer + +INT32 +4 INT32 32-bit signed integer + +OFFSET32 +4 CARD32 position (or integer value) +4 CARD32 length + +PROPINFO +4 n number of PROPOFFSET components +4 m number of bytes of property data +20*n PROPOFFSET property offsets into data block +m LISTofBYTE property data block + +PROPOFFSET +8 OFFSET32 name in data block +8 OFFSET32 value in data block +1 CARD8 type, one of the following values: + 0 String + 1 Unsigned + 2 Signed + 3 zero + +RANGE +2 CHAR2B minimum character code +2 CHAR2B maximum character code + +RESOLUTION +2 CARD16 x resolution in pixels per inch +2 CARD16 y resolution in pixels per inch +2 CARD16 point size in decipoints + +STRNAME +1 n length of name +n STRING8 name + +STRING8 +n LISTofBYTE array of 8-bit character values + +TIMESTAMP +4 CARD32 milliseconds since server time origin + +XCHARINFO +2 INT16 left bearing +2 INT16 right bearing +2 INT16 width +2 INT16 ascent +2 INT16 descent +2 CARD16 attributes + +XFONTINFO +4 CARD32 flags, union of the following bits: + + #x00000001 AllCharactersExist + #x00000002 InkInside + #x00000004 HorizontalOverlap + + but none of the following bits set: + + #xfffffff8 zero + +4 RANGE range of characters in font +1 CARD8 drawing direction + 0 LeftToRight + 1 RightToLeft +1 unused +2 CHAR2B default character +12 XCHARINFO minimum bounds +12 XCHARINFO maximum bounds +2 INT16 font ascent +2 INT16 font descent +n PROPINFO property data + +
+ +
+Requests +open connection + +1 BYTE byteorder, one of the values: + #x42 MostSignificant Byte first + #x6c LeastSignificant Byte first +1 CARD8 numberof auth in auth-data +2 2 client-major-protocol-version +2 0 client-minor-protocol-version +2 a/4 lengthof auth-data +a LISTofAUTH auth-data +▶ +2 CARD16 status + 0 Success + 1 Continue + 2 Busy + 3 Denied +2 2 major version +2 0 version +1 CARD8 numberof alternate-servers-hint +1 CARD8 authorization-index +2 a/4 lengthof alternate-servers-hint +2 (d+q)/4 lengthof authorization-data +a LISTofALTERNATESERVER alternate-servers-hint +d LISTofBYTE authorization-data +q unused, q=pad(d) + + + +If STATUS is Busy or Denied, the protocol stops and the connection is +closed. If STATUS is Continue, the client is expected to respond with +additional data, to which the server responds with +a new status value and more data. This dialog continues until the status +is set to Success, or until the server sets STATUS to Busy or Denied +and closes the connection: + + + +◀ +4 1+(d+q)/4 length +d LISTofBYTE more-authorization-data +q unused, q=pad(d) +▶ +4 2+(d+q)/4 length +2 CARD16 status + 0 Success + 1 Continue + 2 Busy + 3 Denied +2 unused +d LISTofBYTE more-authorization-data +q unused, q=pad(d) + + +When STATUS is Success, the protocol resumes with the following +sent by the server: + + + +4 3+(v+w)/4 length of rest of data +2 CARD16 maximum-request-length +2 v length of vendor string +4 CARD32 release-number +v STRING8 vendor-string +w unused, w=pad(v) + + +Once the connection has been established, the client may send the +following requests: + + + +NoOp +1 0 major-opcode +1 unused +2 1 length + +ListExtensions +1 1 major-opcode +1 unused +2 1 length +▶ +1 0 type reply +1 CARD8 numberof names +2 CARD16 sequence-number +4 2+(n+p)/4 length +n LISTofSTRNAME names +p unused, p=pad(n) + +QueryExtension +1 2 major-opcode +1 n length of name +2 1+(n+p)/4 length +n STRING8 name +p unused, p=pad(n) +▶ +1 0 type reply +1 BOOL present +2 CARD16 sequence-number +4 5 length +2 CARD16 major-version +2 CARD16 minor-version +1 CARD8 major-opcode +1 CARD8 first-event +1 CARD8 number-events +1 CARD8 first-error +1 CARD8 number-errors +3 unused + +ListCatalogues +1 3 major-opcode +1 unused +2 3+(n+p)/4 length +4 CARD32 max-names +2 n length of pattern +2 unused +n STRING8 pattern +p unused, p=pad(n) +▶+ +1 0 type reply +1 unused +2 CARD16 sequence-number +4 4+(n+p)/4 length +4 CARD32 replies-following-hint +4 CARD32 numberof catalogue-names +n LISTofSTRNAME catalogue-names +p unused, p=pad(n) + +SetCatalogues +1 4 major-opcode +1 CARD8 numberof catalogue-names +2 1+(n+p)/4 length +n LISTofSTRNAME catalogue-names +p unused, p=pad(n) + +GetCatalogues +1 5 major-opcode +1 unused +2 1 length +▶ +1 0 type reply +1 CARD8 numberof catalogue-names +2 CARD16 sequence-number +4 2+(n+p)/4 length +n LISTofSTRNAME catalogue-names +p unused, p=pad(n) + +SetEventMask +1 6 major-opcode +1 CARD8 extension-opcode +2 2 length +4 EVENTMASK event-mask + +GetEventMask +1 7 major-opcode +1 CARD8 extension-opcode +2 1 length +▶ +1 0 type reply +1 unused +2 CARD16 sequence-number +4 3 length +4 EVENTMASK event-mask + +CreateAC +1 8 major-opcode +1 CARD8 numberof authorization-protocols +2 2+a/4 length +4 ACCESSCONTEXT ac +a LISTofAUTH authorization-protocols +▶ +1 0 type reply +1 CARD8 authorization-index +2 CARD16 sequence-number +4 3+(d+q)/4 length +2 CARD16 status + 0 Success + 1 Continue + 2 Busy + 3 Denied +2 unused +d LISTofBYTE authorization-data +q unused, q=pad(d) + + + +If STATUS is Continue, the client is expected to respond with additional +data, to which the server +responds with a new status value and more data. This dialog continues +until the status is set to +Success, Busy, or Denied at which point the request is finished. + + + +◀ +4 1+(d+q)/4 length +d LISTofBYTE more-authorization-data +q unused, q=pad(d) +▶ +4 2+(d+q)/4 length +2 CARD16 status + 0 Success + 1 Continue + 2 Busy + 3 Denied +2 unused +d LISTofBYTE authorization-data +q unused, q=pad(d) + +FreeAC +1 9 major-opcode +1 unused +2 2 length +4 ACCESSCONTEXT ac + +SetAuthorization +1 10 major-opcode +1 unused +2 2 length +4 ACCESSCONTEXT ac + +SetResolution +1 11 major-opcode +1 n number of resolutions +2 1+(6*n+p)/4 length +6*n LISTofRESOLUTION resolutions +p p=pad(6*n) + +GetResolution +1 12 major-opcode +1 unused +2 1 length +▶ +1 0 type reply +1 n number of resolutions +2 CARD16 sequence-number +4 2+(6*n+p)/4 length +6*n LISTofRESOLUTION resolutions +p p=pad(6*n) + +ListFonts +1 13 major-opcode +1 unused +2 3+(n+p)/4 length +4 CARD32 max-names +2 n length of pattern +2 unused +n STRING8 pattern +p unused, p=pad(n) +▶+ +1 0 type reply +1 unused +2 CARD16 sequence-number +4 4+(n+p)/4 length +4 CARD32 replies-following-hint +4 CARD32 numberof font-names +n LISTofSTRNAME font-names +p unused, p=pad(n) + +ListFontsWithXInfo +1 14 major-opcode +1 unused +2 3+(n+p)/4 length +4 CARD32 max-names +2 n length of pattern +2 unused +n STRING8 pattern +p unused, p=pad(n) +▶+ (except for last in series) +1 0 type reply +1 n length of name +2 CARD16 sequence-number +4 3+(n+p+f)/4 length +4 CARD32 replies-hint +f XFONTINFO fontinfo +n STRING8 name +p unused, p=pad(n) +▶ (last in series) +1 0 type reply +1 0 last-reply indicator +2 CARD16 sequence-number +4 2 reply length + +OpenBitmapFont +1 15 major-opcode +1 unused +2 4+(n+p)/4 length +4 FONTID fontid +4 BITMAPFORMATMASK format-mask +4 BITMAPFORMAT format +n STRNAME pattern +p unused, p=pad(n) +▶ +1 0 type reply +1 BOOL otherid-valid +2 CARD16 sequence-number +4 4 length +4 FONTID otherid +1 BOOL cachable +3 unused + +QueryXInfo +1 16 major-opcode +1 unused +2 2 length +4 FONTID fontid +▶ +1 0 type reply +1 unused +2 CARD16 sequence-number +4 2+f/4 length +f XFONTINFO fontinfo +p unused, p=pad(f) + +QueryXExtents8 +1 17 major-opcode +1 BOOL range +2 3+(n+p)/4 length +4 FONTID fontid +4 n number chars entries +n STRING8 chars +p unused, p=pad(n) +▶ +1 0 type reply +1 unused +2 CARD16 sequence-number +4 3+3*n length +4 n number of extents +12*n LISTofXCHARINFO extents + +QueryXExtents16 +1 18 major-opcode +1 BOOL range +2 3+(2*n+p)/4 length +4 FONTID fontid +4 n number chars entries +2*n LISTofCHAR2B chars +p unused, p=pad(2*n) +▶ +1 0 type reply +1 unused +2 CARD16 sequence-number +4 3+3*n length +4 n number of extents +12*n LISTofXCHARINFO extents + +QueryXBitmaps8 +1 19 major-opcode +1 BOOL range +2 4+(n+p)/4 length +4 FONTID fontid +4 BITMAPFORMAT format +4 n number of chars entries +n STRING8 chars +p unused, p=pad(n) +▶+ +1 0 type reply +1 unused +2 CARD16 sequence-number +4 5+2*n+(m+p)/4 length +4 CARD32 replies-following-hint +4 n number of offsets +4 m number of bytes of glyph images +8*n LISTofOFFSET32 offsets +m LISTofBYTE glyphimages +p unused, p=pad(m) + +QueryXBitmaps16 +1 20 major-opcode +1 BOOL range +2 4+(2*n+p)/4 length +4 FONTID fontid +4 BITMAPFORMAT format +4 n number of chars entries +2*n LISTofCHAR2B chars +p unused, p=pad(2*n) +▶ +1 0 type reply +1 unused +2 CARD16 sequence-number +4 5+2*n+(m+p)/4 length +4 CARD32 replies-following-hint +4 n number of offsets +4 m number of bytes of glyph images +8*n LISTofOFFSET32 offsets +m LISTofBYTE glyphimages +p unused, p=pad(m) + +CloseFont +1 21 major-opcode +1 unused +2 2 length +4 FONTID fontid + +
+ +
+Errors + + +Request +1 1 type error +1 0 Request +2 CARD16 sequence-number +4 4 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused + +Format +1 1 type error +1 1 Format +2 CARD16 sequence-number +4 5 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused +4 BITMAPFORMAT bad-format + +Font +1 1 type error +1 2 Font +2 CARD16 sequence-number +4 5 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused +4 FONTID bad-fontid + +Range +1 1 type error +1 3 Range +2 CARD16 sequence-number +4 5 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused +4 RANGE bad-range + +EventMask +1 1 type error +1 4 EventMask +2 CARD16 sequence-number +4 5 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused +4 EVENTMASK event-mask + +AccessContext +1 1 type error +1 5 AccessContext +2 CARD16 sequence-number +4 5 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused +4 ACCESSCONTEXT access context + +IDChoice +1 1 type error +1 6 IDChoice +2 CARD16 sequence-number +4 5 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused +4 FONTID bad-fontid + +Name +1 1 type error +1 7 Name +2 CARD16 sequence-number +4 4 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused + +Resolution +1 1 type error +1 8 Resolution +2 CARD16 sequence-number +4 5 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +6 RESOLUTION resolution + +Alloc +1 1 type error +1 9 Alloc +2 CARD16 sequence-number +4 4 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused + +Length +1 1 type error +1 10 Length +2 CARD16 sequence-number +4 5 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused +4 CARD32 bad-length + +Implementation +1 1 type error +1 11 Implementation +2 CARD16 sequence-number +4 4 length +4 TIMESTAMP timestamp +1 CARD8 major-opcode +1 CARD8 minor-opcode +2 unused + + +
+ +
+Events + +KeepAlive +1 2 type event +1 0 event KeepAlive +2 CARD16 sequence-number +4 3 length +4 TIMESTAMP timestamp + +CatalogueListNotify +1 2 type event +1 1 event CatalogueListNotify +2 CARD16 sequence-number +4 4 length +4 TIMESTAMP timestamp +1 BOOL added +1 BOOL deleted +2 unused + +FontListNotify +1 2 type event +1 2 event FontListNotify +2 CARD16 sequence-number +4 4 length +4 TIMESTAMP timestamp +1 BOOL added +1 BOOL deleted +2 unused + + +
+ + + +Acknowledgements + + + + +This document represents the culmination of several years of debate and +experiments done under the auspices of the +MIT X Consortium font working group. +Although this was a group effort, the author remains responsible for any errors +or omissions. The protocol presented here was primarily designed by +JimFulton, +KeithPackard, +and +BobScheifler. +Special thanks goes to +NedBatchelder, +JimFlowers, +and +AxelDeininger +for their invigorating comments +which never failed to make this a better document. +StephenGildea +edited version 2 of this document. Finally, +DavidLemke +deserves great credit for designing and coding the sample implementation. + + + + +References + +All of the following documents are X Consortium standards available from +the X Consortium. + + + 1 + <olink targetdoc='x11protocol' targetptr='x11protocol'>X Window System Protocol Version 11</olink> + Robert W.Scheifler + + + + 2 + Adobe Systems + Bitmap Distribution Format 2.1 + + + + 3 + X Consortium + <olink targetdoc='xlfd' targetptr='xlfd'>X Logical Font + Description Conventions, Version 1.5</olink> + + + + + +Suggested Licensing Policies + +The authorization data passed by the client in the initial connection +setup information may be used by the font server to implement restrictions +on which fonts may be accessed. Furthermore, the font server is free to +refuse new connections at any time. + + +Configuration or management of the license restrictions is outside the scope of +the font service protocol and is done in a server-dependent manner. Possible +policies might include, but are not limited to, combinations of the following: + + + + + No restrictions + + +anyone may access any fonts. The server neither refuses any connections +nor generates AccessContext errors on any +fonts. For environments without specially-licensed fonts, this is +sufficient. + + + + + Per-machine + + +only those clients connecting from a known set of +machines are permitted access. The server could get the address +of the connection and look in a list of allowed machines. + + + + + Per-user + + +only a known set of users may access the fonts. The +server can use the authorization data (such as a Kerberos ticket +or a Secure RPC credential) to verify the identity of the user +and then look in a list of allowed users. + + + + + Simultaneous Use + + +only a certain number of clients may use a given font at any one time. +Additional clients would receive AccessContext +errors if they attempt to open the font. This is only effective if +the initial clients keep the font open for the entire time that it +is being used (even if all of the data has been transmitted and is +being cached). + + + + + Postage Meter + + +a particular font may only be accessed a limited +number of times before its license must be renewed. Each time +the font is opened, the server decrements a counter. When the +counter reaches zero, all further attempts to open the font +return an AccessContext error. + + + + + + + +It should be noted that chaining of font servers (obtaining font data from +other font servers) may conflict with certain license policies. + + + + +Implementation Suggestions + +Font server implementations will probably wish to use techniques such as the +following to avoid limits on the number of simultaneous connections: + + + + +The initial connection information returned by the font +server contains the names of other font servers that +may be used as substitutes. A font server may refuse to +accept a connection, indicating that the client should +try one of the alternatives instead. + + + + +On operating systems that support processing forking, font +servers might choose to fork so that the child can continue +processing the existing connections and the parent can accept +new connections. Such implementations are encouraged to use +shared memory so that in-memory font databases can be shared. + + + + +On operating systems that support passing stream file descriptors +between processes, cooperating font servers could collect +connections in a single process when there are few connections +and spread them among several processes as the load increases. + + + + +If a font client is unable to connect to a server (as opposed +to having the connection terminated), it should retry for an +implementation-dependent length of time (see Xlib's +handling of ECONNREFUSED in XConnDis.c). + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-1.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-1.svg new file mode 100644 index 0000000000000000000000000000000000000000..1f8ba5b75902388d6ac1afe32ee3f27ebd5ff8b7 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-1.svg @@ -0,0 +1,1177 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-10.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-10.svg new file mode 100644 index 0000000000000000000000000000000000000000..76600793e391515b9a1657e4b5b38c9b99bf185f --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-10.svg @@ -0,0 +1,142 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-11.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-11.svg new file mode 100644 index 0000000000000000000000000000000000000000..fa334dea183012ccf3f9b530d5eaf402fb413087 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-11.svg @@ -0,0 +1,2730 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + <ESC> + <FK01> + <FK02> + <FK03> + <FK04> + <FK05> + <FK06> + <FK07> + <FK08> + + + + + <AE12> + + + <TAB> + + + <CAPS> + + + <LFSH> + + + <AE01> + + + <AD01> + + + <AC01> + + + <AB01> + + + <TLDE> + + + <AE02> + + + <AD02> + + + <AC02> + + + <AB02> + + + <INS> + + + <AE03> + + + <AD03> + + + <AC03> + + + <AB03> + + + <LEFT> + + + <AE04> + + + <AD04> + + + <AC04> + + + <AB04> + + + <RGHT> + + + <AE05> + + + <AD05> + + + <AC05> + + + <AB05> + + + + + + + + + + + + <FK09> + <FK10> + <FK11> + <FK12> + <PRSC> + <SCLK> + <PAUS> + <FK16> + <FK17> + + + + + + + + <AE06> + + + <AD06> + + + <AC06> + + + <AB06> + + + <NMLK> + <AE07> + + + <KP7> + <AD07> + + + <KP4> + <AC07> + + + <KP1> + <AB07> + + + <UP> + + + <KPEQ> + <AE08> + + + <KP8> + <AD08> + + + <KP5> + <AC08> + + + <KP2> + <AB08> + + + <DOWN> + + + <KPSL> + <AE09> + + + <KP9> + <AD09> + + + <KP6> + <AC09> + + + <KP3> + <AB09> + + + <AD11> + + + <KPMU> + <AE10> + + + <KPSU> + <AD10> + + + <KPAD> + <AC10> + + + <KPEN> + <AB10> + + + <AD12> + <KPEN> + <AE11> + + + <BKSL> + + + <AC11> + + + <RTSH> + + + + + + + + + <RALT> + + + + + + + <PGUP> + + + + + + + <PGDN> + + + + + + <RCTL> + + + + + <RTRN> + + + + + + <KP0> + <SPCE> + + + + + + + + <LALT> + + + + + <HOME> + + + + + <END> + + + + + <LCTL> + + + + + <DELE> + + + + + <BKSP> + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-2.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-2.svg new file mode 100644 index 0000000000000000000000000000000000000000..495be15370218fb53cd5a056dd5f9df4ba8722c0 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-2.svg @@ -0,0 +1,544 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-3.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-3.svg new file mode 100644 index 0000000000000000000000000000000000000000..30744c590315ce9e7785c4df773f5c5b772c5a25 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-3.svg @@ -0,0 +1,461 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-4.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-4.svg new file mode 100644 index 0000000000000000000000000000000000000000..f5578d33229d22809b5c20329bf88afd8958b5f3 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-4.svg @@ -0,0 +1,463 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-5.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-5.svg new file mode 100644 index 0000000000000000000000000000000000000000..0deeacc189a5c20229ee1aa2cfbc4d7695085d66 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-5.svg @@ -0,0 +1,468 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-6.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-6.svg new file mode 100644 index 0000000000000000000000000000000000000000..a274f2b07d9c2e95f1f335562f80f4d0681633ef --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-6.svg @@ -0,0 +1,558 @@ + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + Core Symbols + + + + + + + A + a + + + + L1 + L2 + L1 + L2 + G1 + G2 + + + + Xkb Symbols + + + + + + + A + a + + + L1 + L2 + G1 + G2 + + + Symbols + a + G1L1 = + A + G1L2 = + + + + G2L1 = + + + + G2L2 = + + + + + Physical Key + Shift Level + Group + + + + + + + a + A + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-7.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-7.svg new file mode 100644 index 0000000000000000000000000000000000000000..82b80a6505a33adf672b9a2575b508213fe4a4b5 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-7.svg @@ -0,0 +1,474 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + Key: + Keycode: + 13 + + NumLock + 15 + + Enter + 12 + + 1 + End + 9 + + è + ö + 8 + + Q + q + @ + 10 + + A + a + + + + æ + 11 + + ? + \ + ? + ϐ + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-8.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-8.svg new file mode 100644 index 0000000000000000000000000000000000000000..8baa3e36ab2105821a130ce9f4cdeff2661ec2c0 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-8.svg @@ -0,0 +1,138 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-9.svg b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-9.svg new file mode 100644 index 0000000000000000000000000000000000000000..8baa3e36ab2105821a130ce9f4cdeff2661ec2c0 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/XKBproto-9.svg @@ -0,0 +1,138 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/acknowledgements.xml b/miniconda3/envs/ladir/share/doc/kbproto/acknowledgements.xml new file mode 100644 index 0000000000000000000000000000000000000000..95b9521e0d3d85699a44988fac94e4db2908a99e --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/acknowledgements.xml @@ -0,0 +1,41 @@ + +Acknowledgments + + +I am grateful for all of the comments and suggestions I have received over the years. I could not possibly list everyone who has helped, but a few people have gone well above and beyond the call of duty and simply must be listed here. + + + +My managers here at SGI, Tom Paquin (now at Netscape) and Gianni Mariani were wonderful. Rather than insisting on some relatively quick, specialized proprietary solution to the keyboard problems we were having, both Tom and Gianni understood the importance of solving them in a general way and for the community as a whole. That was a difficult position to take and it was even harder to maintain when the scope of the project expanded beyond anything we imagined was possible. Gianni and Tom were unflagging in their support and their desire to “do the right thing” despite the schedule and budget pressure that intervened from time to time. + + + +Will Walker, at Digital Equipment Corporation, has been a longtime supporter of XKB. His help and input was essential to ensure that the extension as a whole fits and works together well. His focus was AccessX but the entire extension has benefited from his input and hard work. Without his unflagging good cheer and willingness to lend a hand, XKB would not be where it is today. + + + +Matt Landau, at the X Consortium, stood behind XKB during some tough spots in the release and standardization process. Without Matt’s support, XKB would likely not be a standard for a long time to come. When it became clear that we had too much to do for the amount of time we had remaining, Matt did a fantastic job of finding people to help finish the work needed for standardization. + + + +One of those people was George Sachs, at Hewlett-Packard, who jumped in to help out. His help was essential in getting the extension into this release. Another was Donna Converse, who helped figure out how to explain all of this stuff to someone who hadn’t had their head buried in it for years. + + + +Amber Benson and Gary Aitken were simply phenomenal. They jumped into a huge and complicated project with good cheer and unbelievable energy. They were “up to speed” and contributing within days. I stand in awe of the amount that they managed to achieve in such a short time. Thanks to Gary and Amber, the XKB library specification is a work of art and a thousand times easier to use and more useful than it would otherwise be. + + + +I truly cannot express my gratitude to all of you, without whom this would not have been possible. + + + +Erik Fortune + + +Silicon Graphics, Inc. + + +5 February 1996 + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/appA.xml b/miniconda3/envs/ladir/share/doc/kbproto/appA.xml new file mode 100644 index 0000000000000000000000000000000000000000..fd26bac22106bfa4f1cabd77168f3f58d8649883 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/appA.xml @@ -0,0 +1,916 @@ + +Default Symbol Transformations + + +Interpreting the Control Modifier + + +If the +Control + modifier is not consumed by the symbol lookup process, routines that determine +the symbol and string that correspond to an event should convert the symbol to +a string as defined in the table below. Only the string to be returned is +affected by the +Control + modifier; the symbol is not changed. + + + + +This table lists the decimal value of the standard control characters that +correspond to some keysyms for ASCII characters. Control characters for symbols +not listed in this table are application-specific. + + + + + + + + + + + + + + + + Keysyms + Value + Keysyms + Value + Keysyms + Value + Keysyms + Value + + + + + atsign + 0 + h, H + 8 + p, P + 16 + x, X + 24 + + + a, A + 1 + i, I + 9 + q, Q + 17 + y, Y + 25 + + + b, B + 2 + j, J + 10 + r, R + 18 + z, Z + 26 + + + c, C + 3 + k, K + 11 + s, S + 19 + left_bracket + 27 + + + d, D + 4 + l, L + 12 + t, T + 20 + backslash + 28 + + + e, E + 5 + m, M + 13 + u, U + 21 + right_bracket + 29 + + + f, F + 6 + n, N + 14 + v, V + 22 + asciicircum + 30 + + + g, G + 8 + o, O + 15 + w, W + 23 + underbar + 31 + + + + + + + +Interpreting the Lock Modifier + + +If the +Lock + modifier is not consumed by the symbol lookup process, routines that determine +the symbol and string that correspond to an event should capitalize the result. +Unlike the transformation for +Control +, the capitalization transformation changes both the symbol and the string +returned by the event. + + + +Locale-Sensitive Capitalization + + +If +Lock + is set in an event and not consumed, applications should capitalize the string +and symbols that result from an event according to the capitalization rules in +effect for the system on which the application is running, taking the current +state of the user environment (e.g. locale) into account. + + + + + +Locale-Insensitive Capitalization + + +XKB recommends but does not require locale-sensitive capitalization. In cases +where the locale is unknown or where locale-sensitive capitalization is +prohibitively expensive, applications can capitalize according to the rules +defined in this extension. + + + + +The following tables list all of the keysyms for which XKB defines +capitalization behavior. Any keysyms not explicitly listed in these tables are +not capitalized by XKB when locale-insensitive capitalization is in effect and +are not automatically assigned the +ALPHABETIC + type as described in the Alphabetic Key Type. + + + + +Capitalization Rules for Latin-1 Keysyms + + +This table lists the Latin-11 keysyms for which XKB defines upper and lower +case: + + + + + + + + + + + + + + + + Lower Case + Upper Case + Lower Case + Upper Case + Lower Case + Upper Case + Lower Case + Upper Case + + + + + a + A + o + O + acircumflex + Acircumflex + eth + ETH + + + b + B + p + P + adiaeresis + Adiaeresis + ntilde + Ntilde + + + c + C + q + Q + atilde + Atilde + ograve + Ograve + + + d + D + r + R + aring + Aring + oacute + Oacute + + + e + E + s + S + ae + AE + ocircumflex + Ocircumflex + + + f + F + t + T + ccedilla + Ccedilla + otilde + Otilde + + + g + G + u + U + egrave + Egrave + odiaeresis + Odiaeresis + + + h + H + v + V + eacute + Eacute + oslash + Ooblique + + + i + I + w + W + ecircumflex + Ecircumflex + ugrave + Ugrave + + + j + J + x + X + ediaeresis + Ediaeresis + uacute + Uacute + + + k + K + y + Y + igrave + Igrave + ucircumflex + Ucircumflex + + + l + L + z + Z + iacute + Iacute + udiaeresis + Udiaeresis + + + m + M + agrave + Agrave + icircumflex + Icircumflex + yacute + Yacute + + + n + N + aacute + Aacute + idiaeresis + Idiaeresis + thorn + THORN + + + + + + + +Capitalization Rules for Latin-2 Keysyms + + +This table lists the Latin-2 keysyms for which XKB defines upper and lower case: + + + + + + + + + + + + + + Lower Case + Upper Case + Lower Case + Upper Case + Lower Case + Upper Case + + + + + aogonek + Aogonek + zabovedot + Zabovedot + dstroke + Dstroke + + + lstroke + Lstroke + racute + Racute + nacute + Nacute + + + lcaron + Lcaron + abreve + Abreve + ncaron + Ncaron + + + sacute + Sacute + lacute + Lacute + odoubleacute + Odoubleacute + + + scaron + Scaron + cacute + Cacute + rcaron + Rcaron + + + scedilla + Scedilla + ccaron + Ccaron + uabovering + Uabovering + + + tcaron + Tcaron + eogonek + Eogonek + udoubleacute + Udoubleacute + + + zacute + Zacute + ecaron + Ecaron + tcedilla + Tcedilla + + + zcaron + Zcaron + dcaron + Dcaron + + + + + + + + + +Capitalization Rules for Latin-3 Keysyms + + +This table lists the Latin-3 keysyms for which XKB defines upper and lower case: + + + + + + + + + + + + + + Lower Case + Upper Case + Lower Case + Upper Case + Lower Case + Upper Case + + + + + hstroke + Hstroke + jcircumflex + Jcircumflex + gcircumflex + Gcircumflex + + + hcircumflex + Hcircumflex + cabovedot + Cabovedot + ubreve + Ubreve + + + idotless + Iabovedot + ccircumflex + Ccircumflex + scircumflex + Scircumflex + + + gbreve + Gbreve + gabovedot + Gabovedot + + + + + + + + + +Capitalization Rules for Latin-4 Keysyms + + +This table lists the Latin-4 keysyms for which XKB defines upper and lower case: + + + + + + + + + + + + + + Lower Case + Upper Case + Lower Case + Upper Case + Lower Case + Upper Case + + + + + rcedilla + Rcedilla + eng + ENG + omacron + Omacron + + + itilde + Itilde + amacron + Amacron + kcedilla + Kcedilla + + + lcedilla + Lcedilla + iogonek + Iogonek + uogonek + Uogonek + + + emacron + Emacron + eabovedot + eabovedot + utilde + Utilde + + + gcedilla + Gcedilla + imacron + Imacron + umacron + Umacron + + + tslash + Tslash + ncedilla + Ncedilla + + + + + + + + + +Capitalization Rules for Cyrillic Keysyms + + +This table lists the Cyrillic keysyms for which XKB defines upper and lower +case: + + + + + + + + + + + + Lower Case + Upper Case + Lower Case + Upper Case + + + + + Serbian_dje + Serbian_DJE + Cyrillic_i + Cyrillic_I + + + Macedonia_gje + Macedonia_GJE + Cyrillic_shorti + Cyrillic_SHORTI + + + Cyrillic_io + Cyrillic_IO + Cyrillic_ka + Cyrillic_KA + + + Ukrainian_ie + Ukrainian_IE + Cyrillic_el + Cyrillic_EL + + + Macedonia_dse + Macedonia_DSE + Cyrillic_em + Cyrillic_EM + + + Ukrainian_i + Ukrainian_I + Cyrillic_en + Cyrillic_EN + + + Ukrainian_yi + Ukrainian_YI + Cyrillic_o + Cyrillic_O + + + Cyrillic_je + Cyrillic_JE + Cyrillic_pe + Cyrillic_PE + + + Cyrillic_lje + Cyrillic_LJE + Cyrillic_ya + Cyrillic_YA + + + Cyrillic_nje + Cyrillic_NJE + Cyrillic_er + Cyrillic_ER + + + Serbian_tshe + Serbian_TSHE + Cyrillic_es + Cyrillic_ES + + + Macedonia_kje + Macedonia_KJE + Cyrillic_te + Cyrillic_TE + + + Byelorussian_shortu + Byelorussian_SHORTU + Cyrillic_u + Cyrillic_U + + + Cyrillic_dzhe + Cyrillic_DZHE + Cyrillic_zhe + Cyrillic_ZHE + + + Cyrillic_yu + Cyrillic_YU + Cyrillic_ve + Cyrillic_VE + + + Cyrillic_a + Cyrillic_A + Cyrillic_softsign + Cyrillic_SOFTSIGN + + + Cyrillic_be + Cyrillic_BE + Cyrillic_yeru + Cyrillic_YERU + + + Cyrillic_tse + Cyrillic_TSE + Cyrillic_ze + Cyrillic_ZE + + + Cyrillic_de + Cyrillic_DE + Cyrillic_sha + Cyrillic_SHA + + + Cyrillic_ie + Cyrillic_IE + Cyrillic_e + Cyrillic_E + + + Cyrillic_ef + Cyrillic_EF + Cyrillic_shcha + Cyrillic_SHCHA + + + Cyrillic_ghe + Cyrillic_GHE + Cyrillic_che + Cyrillic_CHE + + + Cyrillic_ha + Cyrillic_HA + Cyrillic_hardsign + Cyrillic_HARDSIGN + + + + + + + +Capitalization Rules for Greek Keysyms + + +This table lists the Greek keysyms for which XKB defines upper and lower case: + + + + + + + + + + + + Lower Case + Upper Case + Lower Case + Upper Case + + + + + Greek_omegaaccent + Greek_OMEGAACCENT + Greek_iota + Greek_IOTA + + + Greek_alphaaccent + Greek_ALPHAACCENT + Greek_kappa + Greek_KAPPA + + + Greek_epsilonaccent + Greek_EPSILONACCENT + Greek_lamda + Greek_LAMDA + + + Greek_etaaccent + Greek_ETAACCENT + Greek_lambda + Greek_LAMBDA + + + Greek_iotaaccent + Greek_IOTAACCENT + Greek_mu + Greek_MU + + + Greek_iotadieresis + Greek_IOTADIERESIS + Greek_nu + Greek_NU + + + Greek_omicronaccent + Greek_OMICRONACCENT + Greek_xi + Greek_XI + + + Greek_upsilonaccent + Greek_UPSILONACCENT + Greek_omicron + Greek_OMICRON + + + Greek_upsilondieresis + Greek_UPSILONDIERESIS + Greek_pi + Greek_PI + + + Greek_alpha + Greek_ALPHA + Greek_rho + Greek_RHO + + + Greek_beta + Greek_BETA + Greek_sigma + Greek_SIGMA + + + Greek_gamma + Greek_GAMMA + Greek_tau + Greek_TAU + + + Greek_delta + Greek_DELTA + Greek_upsilon + Greek_UPSILON + + + Greek_epsilon + Greek_EPSILON + Greek_phi + Greek_PHI + + + Greek_zeta + Greek_ZETA + Greek_chi + Greek_CHI + + + Greek_eta + Greek_ETA + Greek_psi + Greek_PSI + + + Greek_theta + Greek_THETA + Greek_omega + Greek_OMEGA + + + + + + + +Capitalization Rules for Other Keysyms + + +XKB defines no capitalization rules for symbols in any other set of keysyms +provided by the consortium. Applications are free to apply additional rules for +private keysyms or for other keysyms not covered by XKB. + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/appB.xml b/miniconda3/envs/ladir/share/doc/kbproto/appB.xml new file mode 100644 index 0000000000000000000000000000000000000000..85137cff4372b9eb9b4e274fcb5faafefd7f1e9e --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/appB.xml @@ -0,0 +1,129 @@ + +Canonical Key Types + + +Canonical Key Types + +The ONE_LEVEL Key Type + + +The +ONE_LEVEL + key type describes groups that have only one symbol. The default +ONE_LEVEL + type has no map entries and does not pay attention to any modifiers. + + + + +The TWO_LEVEL Key Type + + +The +TWO_LEVEL + key type describes groups that have two symbols but are neither alphabetic nor +numeric keypad keys. The default +TWO_LEVEL + type uses only the +Shift + modifier. It returns level two if +Shift + is set, level one if it is not. + + + + + +The ALPHABETIC Key Type + + +The +ALPHABETIC + key type describes groups that consist of two symbols — the lowercase form +of a symbol followed by the uppercase form of the same symbol. The default + +ALPHABETIC + type implements locale-sensitive "shift cancels caps lock" behavior using both +the +Shift + and +Lock + modifiers as follows: + + + + + If +Shift + and +Lock + are both set, the default +ALPHABETIC + type yields level one. + + + + If +Shift + alone is set, it yields level two. + + + + If +Lock + alone is set, it yields level one but preserves the +Lock + modifier. + + + + If neither +Shift + nor +Lock + are set, it yields level one. + + + + + + +The KEYPAD Key Type + + +The +KEYPAD + key type describes that consist of two symbols, at least one of which is a +numeric keypad symbol. The default +KEYPAD + type implements "shift cancels numeric lock" behavior using the +Shift + modifier and the real modifier bound to the virtual modifier named "NumLock" +(the "NumLock" modifier) as follows: + + + + + If +Shift + and the "NumLock" modifier are both set, the default +KEYPAD +type yields level one. + + + + If either +Shift + or the "NumLock" modifier alone are set, it yields level two. + + + + If neither +Shift + nor the "NumLock" modifier are set, it yields level one. + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/appC.xml b/miniconda3/envs/ladir/share/doc/kbproto/appC.xml new file mode 100644 index 0000000000000000000000000000000000000000..6e47caea95e07c3efdd5d1461d68f0d302402b6d --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/appC.xml @@ -0,0 +1,715 @@ + +New KeySyms + + +New KeySyms + +KeySyms Used by the ISO9995 Standard + + + + + + + + + + Byte 3 + Byte 4 + Character + Name + + + + + 254 + 1 + + ISO LOCK + + + 254 + 2 + + ISO LATCHING LEVEL TWO SHIFT + + + 254 + 3 + + ISO LEVEL THREE SHIFT + + + 254 + 4 + + ISO LATCHING LEVEL THREE SHIFT + + + 254 + 5 + + ISO LEVEL THREE SHIFT LOCK + + + 254 + 6 + + ISO LATCHING GROUP SHIFT + + + 254 + 7 + + ISO GROUP SHIFT LOCK + + + 254 + 8 + + ISO NEXT GROUP + + + 254 + 9 + + ISO LOCK NEXT GROUP + + + 254 + 10 + + ISO PREVIOUS GROUP + + + 254 + 11 + + ISO LOCK PREVIOUS GROUP + + + 254 + 12 + + ISO FIRST GROUP + + + 254 + 13 + + ISO LOCK FIRST GROUP + + + 254 + 14 + + ISO LAST GROUP + + + 254 + 15 + + ISO LOCK LAST GROUP + + + 254 + 32 + + LEFT TAB + + + 254 + 33 + + MOVE LINE UP + + + 254 + 34 + + MOVE LINE DOWN + + + 254 + 35 + + PARTIAL LINE UP + + + 254 + 36 + + PARTIAL LINE DOWN + + + 254 + 37 + + PARTIAL SPACE LEFT + + + 254 + 38 + + PARTIAL SPACE RIGHT + + + 254 + 39 + + SET MARGIN LEFT + + + 254 + 40 + + SET MARGIN RIGHT + + + 254 + 41 + + RELEASE MARGIN LEFT + + + 254 + 42 + + RELEASE MARGIN RIGHT + + + 254 + 43 + + RELEASE MARGIN LEFT AND RIGHT + + + 254 + 44 + + FAST CURSOR LEFT + + + 254 + 45 + + FAST CURSOR RIGHT + + + 254 + 46 + + FAST CURSOR UP + + + 254 + 47 + + FAST CURSOR DOWN + + + 254 + 48 + + CONTINUOUS UNDERLINE + + + 254 + 49 + + DISCONTINUOUS UNDERLINE + + + 254 + 50 + + EMPHASIZE + + + 254 + 51 + + CENTER OBJECT + + + 254 + 52 + + ISO_ENTER + + + + + + + +KeySyms Used to Control The Core Pointer + + + + + + + + + + Byte 3 + Byte 4 + Character + Name + + + + + 254 + 224 + + POINTER LEFT + + + 254 + 225 + + POINTER RIGHT + + + 254 + 226 + + POINTER UP + + + 254 + 227 + + POINTER DOWN + + + 254 + 228 + + POINTER UP AND LEFT + + + 254 + 229 + + POINTER UP AND RIGHT + + + 254 + 230 + + POINTER DOWN AND LEFT + + + 254 + 231 + + POINTER DOWN AND RIGHT + + + 254 + 232 + + DEFAULT POINTER BUTTON + + + 254 + 233 + + POINTER BUTTON ONE + + + 254 + 234 + + POINTER BUTTON TWO + + + 254 + 235 + + POINTER BUTTON THREE + + + 254 + 236 + + POINTER BUTTON FOUR + + + 254 + 237 + + POINTER BUTTON FIVE + + + 254 + 238 + + DEFAULT POINTER BUTTON DOUBLE CLICK + + + 254 + 239 + + POINTER BUTTON ONE DOUBLE CLICK + + + 254 + 240 + + POINTER BUTTON TWO DOUBLE CLICK + + + 254 + 241 + + POINTER BUTTON THREE DOUBLE CLICK + + + 254 + 242 + + POINTER BUTTON FOUR DOUBLE CLICK + + + 254 + 243 + + POINTER BUTTON FIVE DOUBLE CLICK + + + 254 + 244 + + DRAG DEFAULT POINTER BUTTON + + + 254 + 245 + + DRAG POINTER BUTTON ONE + + + 254 + 246 + + DRAG POINTER BUTTON TWO + + + 254 + 247 + + DRAG POINTER BUTTON THREE + + + 254 + 248 + + DRAG POINTER BUTTON FOUR + + + 254 + 249 + + ENABLE POINTER FROM KEYBOARD + + + 254 + 250 + + ENABLE KEYBOARD POINTER ACCEL + + + 254 + 251 + + SET DEFAULT POINTER BUTTON NEXT + + + 254 + 252 + + SET DEFAULT POINTER BUTTON PREVIOUS + + + 254 + 253 + + DRAG POINTER BUTTON FIVE + + + + + + + +KeySyms Used to Change Keyboard Controls + + + + + + + + + + Byte 3 + Byte 4 + Character + Name + + + + + 254 + 112 + + ENABLE ACCESSX KEYS + + + 254 + 113 + + ENABLE ACCESSX FEEDBACK + + + 254 + 114 + + TOGGLE REPEAT KEYS + + + 254 + 115 + + TOGGLE SLOW KEYS + + + 254 + 116 + + ENABLE BOUNCE KEYS + + + 254 + 117 + + ENABLE STICKY KEYS + + + 254 + 118 + + ENABLE MOUSE KEYS + + + 254 + 119 + + ENABLE MOUSE KEYS ACCELERATION + + + 254 + 120 + + ENABLE OVERLAY1 + + + 254 + 121 + + ENABLE OVERLAY2 + + + 254 + 122 + + ENABLE AUDIBLE BELL + + + + + + + +KeySyms Used To Control The Server + + + + + + + + + + Byte + Byte + Character + Name + + + + + 254 + 208 + + FIRST SCREEN + + + 254 + 209 + + PREVIOUS SCREEN + + + 254 + 210 + + NEXT SCREEN + + + 254 + 211 + + LAST SCREEN + + + 254 + 212 + + TERMINATE SERVER + + + + + + + +KeySyms for Non-Spacing Diacritical Keys + + + + + + + + + + Byte + Byte + Character + Name + + + + + 254 + 80 + + DEAD GRAVE ACCENT + + + 254 + 81 + + DEAD ACUTE ACCENT + + + 254 + 82 + + DEAD CIRCUMFLEX + + + 254 + 83 + + DEAD TILDE + + + 254 + 84 + + DEAD MACRON + + + 254 + 85 + + DEAD BREVE + + + 254 + 86 + + DEAD DOT ABOVE + + + 254 + 87 + + DEAD DIAERESIS + + + 254 + 88 + + DEAD RING ABOVE + + + 254 + 89 + + DEAD DOUBLE ACUTE ACCENT + + + 254 + 90 + + DEAD CARON + + + 254 + 91 + + DEAD CEDILLA + + + 254 + 92 + + DEAD OGONEK + + + 254 + 93 + + DEAD IOTA + + + 254 + 94 + + DEAD VOICED SOUND + + + 254 + 95 + + DEAD SEMI VOICED SOUND + + + 254 + 96 + + DEAD DOT BELOW + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/appD.xml b/miniconda3/envs/ladir/share/doc/kbproto/appD.xml new file mode 100644 index 0000000000000000000000000000000000000000..147373b23e4e968c4602698cc72cf3893344a065 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/appD.xml @@ -0,0 +1,2096 @@ + +Protocol Encoding + + +Syntactic Conventions + + +This document uses the same syntactic conventions as the encoding of the core X +protocol, with the following additions: + + + +A LISTofITEMs contains zero or more items of variable type and size. The encode +form for a LISTofITEMs is: + + + +v LISTofITEMs NAME + + TYPE MASK-EXPRESSION + value1 corresponding field(s) + ... + valuen corresponding field(s) + + + +The MASK-EXPRESSION is an expression using C-style boolean operators and fields +of the request which specifies the bitmask used to determine whether or not a +member of the LISTofITEMs is present. If present, TYPE specifies the +interpretation of the resulting bitmask and the values are listed using the +symbolic names of the members of the set. If TYPE is blank, the values are +numeric constants. + + + + +It is possible for a single bit in the MASK-EXPRESSION to control more than one +ITEM — if the bit is set, all listed ITEMs are present. It is also possible +for multiple bits in the MASK-EXPRESSION to control a single ITEM — if any of +the bits associated with an ITEM are set, it is present in the LISTofITEMs. + + + + +The size of a LISTofITEMS is derived from the items that are present in the +list, so it is always given as a variable in the request description, and the +request is followed by a section of the form: + + + +ITEMs +encode-form +... +encode-form + + + +listing an encode-form for each ITEM. The NAME in each encode-form keys to the +fields listed as corresponding to each bit in the MASK-EXPRESSION. Items are +not necessarily the same size, and the size specified in the encoding form is +the size that the item occupies if it is present. + + + + +Some types are of variable size. The encode-form for a list of items of a +single type but variable size is: + + + +S0+..Ss LISTofTYPE name + + + +Which indicates that the list has +s + elements of variable size and that the size of the list is the sum of the +sizes of all of the elements that make up the list. The notation Sn refers to +the size of the +n +th element of the list and the notation S* refers to the size of the list as a +whole. + + + + +The definition of a type of variable size includes an expression which +specifies the size. The size is specified as a constant plus a variable +expression; the constant specifies the size of the fields that are always +present and the variables which make up the variable expression are defined in +the constant portion of the structure. For example, the following definition +specifies a counted string with a two-byte length field preceding the string: + + + + +TYPE 2+n+p +2 n length +n STRING8 string +p unused,p=pad(n) + + + +Some fields are optional. The size of an optional field has the form: +"[ +expr +]" where expr specifies the size of the field if it is present. An explanation +of the conditions under which the field is present follows the name in the +encode form: + + + +1 BOOL more +3 unused +[4] CARD32 optData, if more==TRUE + + + +This portion of the structure is four bytes long if more is FALSE or eight +bytes long if more is TRUE. This notation can also be used in size expressions; +for example, the size of the previous structure is written as "4+[4]" bytes. + + + + + +Common Types + +SETofKB_EVENTTYPE + #x0001 XkbNewKeyboardNotify + #x0002 XkbMapNotify + #x0004 XkbStateNotify + #x0008 XkbControlsNotify + #x0010 XkbIndicatorStateNotify + #x0020 XkbIndicatorMapNotify + #x0040 XkbNamesNotify + #x0080 XkbCompatMapNotify + #x0100 XkbBellNotify + #x0200 XkbActionMessage + #x0400 XkbAccessXNotify + #x0800 XkbExtensionDeviceNotify + + +SETofKB_NKNDETAIL + #x01 XkbNKN_Keycodes + #x02 XkbNKN_Geometry + #x04 XkbNKN_DeviceID + + +SETofKB_AXNDETAIL + #x01 XkbAXN_SKPress + #x02 XkbAXN_SKAccept + #x04 XkbAXN_SKReject + #x08 XkbAXN_SKRelease + #x10 XkbAXN_BKAccept + #x20 XkbAXN_BKReject + #x40 XkbAXN_AXKWarning + + +SETofKB_MAPPART + #x0001 XkbKeyTypes + #x0002 XkbKeySyms + #x0004 XkbModifierMap + #x0008 XkbExplicitComponents + #x0010 XkbKeyActions + #x0020 XkbKeyBehaviors + #x0040 XkbVirtualMods + #x0080 XkbVirtualModMap + + +SETofKB_STATEPART + #x0001 XkbModifierState + #x0002 XkbModifierBase + #x0004 XkbModifierLatch + #x0008 XkbModifierLock + #x0010 XkbGroupState + #x0020 XkbGroupBase + #x0040 XkbGroupLatch + #x0080 XkbGroupLock + #x0100 XkbCompatState + #x0200 XkbGrabMods + #x0400 XkbCompatGrabMods + #x0800 XkbLookupMods + #x1000 XkbCompatLookupMods + #x2000 XkbPointerButtons + + +SETofKB_BOOLCTRL + #x00000001 XkbRepeatKeys + #x00000002 XkbSlowKeys + #x00000004 XkbBounceKeys + #x00000008 XkbStickyKeys + #x00000010 XkbMouseKeys + #x00000020 XkbMouseKeysAccel + #x00000040 XkbAccessXKeys + #x00000080 XkbAccessXTimeoutMask + #x00000100 XkbAccessXFeedbackMask + #x00000200 XkbAudibleBellMask + #x00000400 XkbOverlay1Mask + #x00000800 XkbOverlay2Mask + #x00001000 XkbIgnoreGroupLockMask + + +SETofKB_CONTROL + Encodings are the same as for SETofKB_BOOLCTRL, with the addition of: + #x080000000 XkbGroupsWrap + #x100000000 XkbInternalMods + #x200000000 XkbIgnoreLockMods + #x400000000 XkbPerKeyRepeat + #x800000000 XkbControlsEnabled + + +SETofKB_AXFBOPT + #x0001 XkbAX_SKPressFB + #x0002 XkbAX_SKAcceptFB + #x0004 XkbAX_FeatureFB + #x0008 XkbAX_SlowWarnFB + #x0010 XkbAX_IndicatorFB + #x0020 XkbAX_StickyKeysFB + #x0100 XkbAX_SKReleaseFB + #x0200 XkbAX_SKRejectFB + #x0400 XkbAX_BKRejectFB + #x0800 XkbAX_DumbBell + + +SETofKB_AXSKOPT + #x0040 XkbAX_TwoKeys + #x0080 XkbAX_LatchToLock + + +SETofKB_AXOPTION + Encoding same as the bitwise union of : + SETofKB_AXFBOPT + SETofKB_AXSKOPT + + +KB_DEVICESPEC + 0..255 input extension device id + #x100 XkbUseCoreKbd + #x200 XkbUseCorePtr + + +KB_LEDCLASSRESULT + 0 KbdFeedbackClass + 4 LedFeedbackClass + + +KB_LEDCLASSSPEC + Encoding same as KB_LEDCLASSRESULT, with the addition of: + #x0300 XkbDfltXIClass + #x0500 XkbAllXIClasses + + +KB_BELLCLASSRESULT + 0 KbdFeedbackClass + 5 BellFeedbackClass + + +KB_BELLCLASSSPEC + Encoding same as KB_BELLCLASSRESULT, with the addition of: + #x0300 XkbDfltXIClass + + +KB_IDSPEC + 0..255 input extension feedback id + #x0400 XkbDfltXIId + + +KB_IDRESULT + Encoding same as KB_IDSPEC, with the addition of: + #xff00 XkbXINone + + +KB_MULTIIDSPEC + encodings same as KB_IDSPEC, with the addition of: + #x0500 XkbAllXIIds + + +KB_GROUP + 0 XkbGroup1 + 1 XkbGroup2 + 2 XkbGroup3 + 3 XkbGroup4 + + +KB_GROUPS + Encoding same as KB_GROUP, with the addition of: + 254 XkbAnyGroup + 255 XkbAllGroups + + +SETofKB_GROUP + #x01 XkbGroup1 + #x02 XkbGroup2 + #x04 XkbGroup3 + #x08 XkbGroup4 + + +SETofKB_GROUPS + Encoding same as SETofKB_GROUP, with the addition of: + #x80 XkbAnyGroup + + +KB_GROUPSWRAP + #x00 XkbWrapIntoRange + #x40 XkbClampIntoRange + #x80 XkbRedirectIntoRange + + +SETofKB_VMODSHIGH + #x80 virtual modifier 15 + #x40 virtual modifier 14 + #x20 virtual modifier 13 + #x10 virtual modifier 12 + #x08 virtual modifier 11 + #x04 virtual modifier 10 + #x02 virtual modifier 9 + #x01 virtual modifier 8 + + +SETofKB_VMODSLOW + #x80 virtual modifier 7 + #x40 virtual modifier 6 + #x20 virtual modifier 5 + #x10 virtual modifier 4 + #x08 virtual modifier 3 + #x04 virtual modifier 2 + #x02 virtual modifier 1 + #x01 virtual modifier 0 + + +SETofKB_VMOD + #x8000 virtual modifier 15 + #x4000 virtual modifier 14 + #x2000 virtual modifier 13 + #x1000 virtual modifier 12 + #x0800 virtual modifier 11 + #x0400 virtual modifier 10 + #x0200 virtual modifier 9 + #x0100 virtual modifier 8 + #x0080 virtual modifier 7 + #x0040 virtual modifier 6 + #x0020 virtual modifier 5 + #x0010 virtual modifier 4 + #x0008 virtual modifier 3 + #x0004 virtual modifier 2 + #x0002 virtual modifier 1 + #x0001 virtual modifier 0 + + +SETofKB_EXPLICIT + #x80 XkbExplicitVModMap + #x40 XkbExplicitBehavior + #x20 XkbExplicitAutoRepeat + #x10 XkbExplicitInterpret + #x08 XkbExplicitKeyType4 + #x04 XkbExplicitKeyType3 + #x02 XkbExplicitKeyType2 + #x01 XkbExplicitKeyType1 + + +KB_SYMINTERPMATCH + #x80 XkbSI_LevelOneOnly + #x7f operation, one of the following: + 0 XkbSI_NoneOf + 1 XkbSI_AnyOfOrNone + 2 XkbSI_AnyOf + 3 XkbSI_AllOf + 4 XkbSI_Exactly + + +SETofKB_IMFLAG + #x80 XkbIM_NoExplicit + #x40 XkbIM_NoAutomatic + #x20 XkbIM_LEDDrivesKB + + +SETofKB_IMMODSWHICH + #x10 XkbIM_UseCompat + #x08 XkbIM_UseEffective + #x04 XkbIM_UseLocked + #x02 XkbIM_UseLatched + #x01 XkbIM_UseBase + + +SETofKB_IMGROUPSWHICH + #x10 XkbIM_UseCompat + #x08 XkbIM_UseEffective + #x04 XkbIM_UseLocked + #x02 XkbIM_UseLatched + #x01 XkbIM_UseBase + + +KB_INDICATORMAP +1 SETofKB_IMFLAGS flags +1 SETofKB_IMGROUPSWHICH whichGroups +1 SETofKB_GROUP groups +1 SETofKB_IMMODSWHICH whichMods +1 SETofKEYMASK mods +1 SETofKEYMASK realMods +2 SETofKB_VMOD vmods +4 SETofKB_BOOLCTRL ctrls + + +SETofKB_CMDETAIL + #x01 XkbSymInterp + #x02 XkbGroupCompat + + +SETofKB_NAMEDETAIL + #x0001 XkbKeycodesName + #x0002 XkbGeometryName + #x0004 XkbSymbolsName + #x0008 XkbPhysSymbolsName + #x0010 XkbTypesName + #x0020 XkbCompatName + #x0040 XkbKeyTypeNames + #x0080 XkbKTLevelNames + #x0100 XkbIndicatorNames + #x0200 XkbKeyNames + #x0400 XkbKeyAliases + #x0800 XkbVirtualModNames + #x1000 XkbGroupNames + #x2000 XkbRGNames + + +SETofKB_GBNDETAIL + #x01 XkbGBN_Types + #x02 XkbGBN_CompatMap + #x04 XkbGBN_ClientSymbols + #x08 XkbGBN_ServerSymbols + #x10 XkbGBN_IndicatorMaps + #x20 XkbGBN_KeyNames + #x40 XkbGBN_Geometry + #x80 XkbGBN_OtherNames + + +SETofKB_XIEXTDEVFEATURE + #x02 XkbXI_ButtonActions + #x04 XkbXI_IndicatorNames + #x08 XkbXI_IndicatorMaps + #x10 XkbXI_IndicatorState + + +SETofKB_XIFEATURE + Encoding same as SETofKB_XIEXTDEVFEATURE, with the addition of: + #x01 XkbXI_Keyboards + + +SETofKB_XIDETAIL + Encoding same as SETofKB_XIFEATURE, with the addition of: + #x8000 XkbXI_UnsupportedFeature + + +SETofKB_PERCLIENTFLAG + #x01 XkbDetectableAutorepeat + #x02 XkbGrabsUseXKBState + #x04 XkbAutoResetControls + #x08 XkbLookupStateWhenGrabbed + #x10 XkbSendEventUsesXKBState + + +KB_MODDEF +1 SETofKEYMASK mask +1 SETofKEYMASK realMods +2 SETofVMOD vmods + + +KB_COUNTED_STRING8 +1 l length +l STRING8 string + + +KB_COUNTED_STRING16 +2 l length +l STRING8 string + + +KB_COUNTED_STRING16 +p unused,p=pad(2+l) + + + + +Errors + +1 0 Error +2 ?? code +2 CARD16 sequence +4 CARD32 error value + most significant 8 bits of error value have the meaning: + 0xff XkbErrBadDevice + 0xfe XkbErrBadClass + 0xfd XkbErrBadId + the least significant 8 bits of the error value contain the device id, +class, or feedback + id which failed. +2 CARD16 minor opcode +1 CARD8 major opcode +21 unused + + + + +Key Actions + +1 0 type +7 unused + + +1 1 type +1 BITMASK flags + #x01 XkbSA_ClearLocks + #x02 XkbSA_LatchToLock + #x04 XkbSA_UseModMapMods +1 SETofKEYMASK mask +1 SETofKEYMASK real modifiers +1 SETofKB_VMODSHIGH virtual modifiers high +1 SETofKB_VMODSLOW virtual modifiers low +2 unused + + +1 2 type +1 BITMASK flags + #x01 XkbSA_ClearLocks + #x02 XkbSA_LatchToLock + #x04 XkbSA_UseModMapMods +1 SETofKEYMASK mask +1 SETofKEYMASK real modifiers +1 SETofKB_VMODSHIGH virtual modifiers high +1 SETofKB_VMODSLOW virtual modifiers low +2 unused + + +1 3 type +1 BITMASK flags + #x01 XkbSA_LockNoLock + #x02 XkbSA_LockNoUnlock + #x04 XkbSA_UseModMapMods +1 SETofKEYMASK mask +1 SETofKEYMASK real modifiers +1 SETofKB_VMODSHIGH virtual modifiers high +1 SETofKB_VMODSLOW virtual modifiers low +2 unused + + +1 4 type +1 BITMASK flags + #x01 XkbSA_ClearLocks + #x02 XkbSA_LatchToLock + #x04 XkbSA_GroupAbsolute +1 INT8 group +5 unused + + +1 5 type +1 BITMASK flags + #x01 XkbSA_ClearLocks + #x02 XkbSA_LatchToLock + #x04 XkbSA_GroupAbsolute +1 INT8 group +5 unused + + +1 6 type +1 BITMASK flags + #x01 XkbSA_LockNoLock + #x02 XkbSA_LockNoUnlock + #x04 XkbSA_GroupAbsolute +1 INT8 group +5 unused + + +1 7 type +1 BITMASK flags + #x01 XkbSA_NoAcceleration + #x02 XkbSA_MoveAbsoluteX + #x04 XkbSA_MoveAbsoluteY +1 INT8 x high +1 CARD8 x low +1 INT8 y high +1 CARD8 y low +2 unused + + +1 8 type +1 BITMASK flags +1 CARD8 count +1 CARD8 button +4 unused + + +1 9 type +1 BITMASK flags +1 unused +1 CARD8 button +4 unused + + +1 10 type +1 BITMASK flags + #x04 XkbSA_DfltBtnAbsolute +1 BITMASK affect + #x01 XkbSA_AffectDfltBtn +1 INT8 value +4 unused + + +1 11 type +1 BITMASK flags + #x01 XkbSA_LockNoLock + #x02 XkbSA_LockNoUnlock + #x04 XkbSA_UseModMapMods (if SA_ISODfltIsGroup is 0) + #x04 XkbSA_GroupAbsolute (if SA_ISODfltIsGroup is 1) + #x80 XkbSA_ISODfltIsGroup +1 SETofKEYMASK mask +1 SETofKEYMASK real modifiers +1 INT8 group +1 BITMASK affect + #x08 XkbSA_ISONoAffectCtrls + #x10 XkbSA_ISONoAffectPtr + #x20 XkbSA_ISONoAffectGroup + #x40 XkbSA_ISONoAffectMods +1 SETofKB_VMODSHIGH virtual modifiers high +1 SETofKB_VMODSLOW virtual modifiers low + + +1 12 type +7 unused + + +1 13 type +1 BITMASK flags + #x01 XkbSA_SwitchApplication + #x04 XkbSA_SwitchAbsolute +1 INT8 new screen +5 unused (must be 0) + + +1 14 type +3 unused (must be 0) +1 BITMASK boolean controls high + #x01 XkbAccessXFeedbackMask + #x02 XkbAudibleBellMask + #x04 XkbOverlay1Mask + #x08 XkbOverlay2Mask + #x10 XkbIgnoreGroupLockMask +1 BITMASK boolean controls low + #x01 XkbRepeatKeys + #x02 XkbSlowKeys + #x04 XkbBounceKeys + #x08 XkbStickyKeys + #x10 XkbMouseKeys + #x20 XkbMouseKeysAccel + #x40 XkbAccessXKeys + #x80 XkbAccessXTimeoutMask +2 unused (must be 0) + + +1 15 type +3 unused (must be 0) +1 BITMASK boolean controls high + #x01 XkbAccessXFeedbackMask + #x02 XkbAudibleBellMask + #x04 XkbOverlay1Mask + #x08 XkbOverlay2Mask + #x10 XkbIgnoreGroupLockMask +1 BITMASK boolean controls low + #x01 XkbRepeatKeys + #x02 XkbSlowKeys + #x04 XkbBounceKeys + #x08 XkbStickyKeys + #x10 XkbMouseKeys + #x20 XkbMouseKeysAccel + #x40 XkbAccessXKeys + #x80 XkbAccessXTimeoutMask + + +1 16 type +2 unused (must be 0) + + +1 16 type +1 BITMASK flags + #x01 XkbSA_MessageOnPress + #x02 XkbSA_MessageOnRelease + #x04 XkbSA_MessageGenKeyEvent +6 STRING message + + +1 17 type +1 KEYCODE new key +1 SETofKEYMASK mask +1 SETofKEYMASK real modifiers +1 SETofKB_VMODSHIGH virtual modifiers mask high +1 SETofKB_VMODSLOW virtual modifiers mask low +1 SETofKB_VMODSHIGH virtual modifiers high +1 SETofKB_VMODSLOW virtual modifiers low + + +1 18 type +1 0 flags +1 CARD8 count +1 CARD8 button +1 CARD8 device +3 unused (must be 0) + + +1 19 type +1 BITMASK flags + #x01 XkbSA_LockNoLock + #x02 XkbSA_LockNoUnlock +1 unused +1 CARD8 button +1 CARD8 device + + +1 20 type +1 CARD8 device +1 KB_SA_VALWHAT valuator 1 what + #x00 XkbSA_IgnoreVal + #x01 XkbSA_SetValMin + #x02 XkbSA_SetValCenter + #x03 XkbSA_SetValMax + #x04 XkbSA_SetValRelative + #x05 XkbSA_SetValAbsolute +1 CARD8 valuator 1 index +1 CARD8 valuator 1 value +1 KB_SA_VALWHAT valuator 2 what + Encodings as for "valuator 1 what" above +1 CARD8 valuator 2 index +1 CARD8 valuator 2 value + + + + +Key Behaviors + +1 #x00 type +1 unused + + +1 #x01 type +1 unused + + +1 #x02 type +1 0..31 group + + +1 #x03 type +1 KEYCODE key + + +1 #x04 type +1 CARD8 key + + +1 #x81 type +1 unused + + +1 #x82 type +1 0..31 group + + +1 #x83 type +1 KEYCODE key + + +1 #x84 type +1 KEYCODE key + + + + +Requests + +1 ?? opcode +1 0 xkb-opcode +2 2 request-length +2 CARD16 wantedMajor +2 CARD16 wantedMinor + + +1 1 Reply +1 BOOL supported +2 CARD16 sequence number +4 0 reply length +2 1 serverMajor +2 0 serverMinor +20 unused + + + +1 ?? opcode +1 1 xkb-opcode +2 4+(V+p)/4 request-length +2 KB_DEVICESPEC deviceSpec +2 SETofKB_EVENTTYPE affectWhich +2 SETofKB_EVENTTYPE clear +2 SETofKB_EVENTTYPE selectAll +2 SETofKB_MAPDETAILS affectMap +2 SETofKB_MAPDETAILS map +V LISTofITEMs details + SETofKB_EVENTTYPE +(affectWhich&(~clear)&(~selectAll)) + XkbNewKeyboardNotify affectNewKeyboard, newKeyboardDetails + XkbStateNotify affectState, stateDetails + XkbControlsNotify affectCtrls, ctrlDetails + XkbIndicatorStateNotify affectIndicatorState, indicatorStateDetails + XkbIndicatorMapNotify affectIndicatorMap, indicatorMapDetails + XkbNamesNotify affectNames, namesDetails + XkbCompatMapNotify affectCompat, compatDetails + XkbBellNotify affectBell, bellDetails + XkbActionMessage affectMsgDetails, msgDetails + XkbExtensionDeviceNotify affectExtDev, extdevDetails + + +ITEMs +p unused, p=pad(V) + + +ITEMs +2 SETofKB_NKNDETAIL affectNewKeyboard +2 SETofKB_NKNDETAIL newKeyboardDetails +2 SETofKB_STATEPART affectState +2 SETofKB_STATEPART stateDetails +4 SETofKB_CONTROL affectCtrls +4 SETofKB_CONTROL ctrlDetails +4 SETofKB_INDICATOR affectIndicatorState +4 SETofKB_INDICATOR indicatorStateDetails +4 SETofKB_INDICATOR affectIndicatorMaps +4 SETofKB_INDICATOR indicatorMapDetails +2 SETofKB_NAME_DETAIL affectNames +2 SETofKB_NAME_DETAIL namesDetails +1 SETofKB_CMDETAIL affectCompat +1 SETofKB_CMDETAIL compatDetails +1 SETofKB_BELLDETAIL affectBell +1 SETofKB_BELLDETAIL bellDetails +1 SETofKB_MSGDETAIL affectMsgDetails +1 SETofKB_MSGDETAIL msgDetails +2 SETofKB_AXNDETAIL affectAccessX +2 SETofKB_AXNDETAIL accessXDetails +2 SETofKB_XIDETAIL affectExtDev +2 SETofKB_XIDETAIL extdevDetails + + + +1 ?? opcode +1 3 xkb-opcode +2 7 request-length +2 KB_DEVICESPEC deviceSpec +2 KB_BELLCLASSSPEC bellClass +2 KB_IDSPEC bellID +1 INT8 percent +1 BOOL forceSound +1 BOOL eventOnly +1 unused +2 INT16 pitch +2 INT16 duration +2 unused +4 ATOM name +4 WINDOW window + + +1 ?? opcode +1 4 xkb-opcode +2 2 request-length +2 KB_DEVICESPEC deviceSpec +2 unused + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 0 length +1 SETofKEYMASK mods +1 SETofKEYMASK baseMods +1 SETofKEYMASK latchedMods +1 SETofKEYMASK lockedMods +1 KP_GROUP group +1 KP_GROUP lockedGroup +2 INT16 baseGroup +2 INT16 latchedGroup +1 SETofKEYMASK compatState +1 SETofKEYMASK grabMods +1 SETofKEYMASK compatGrabMods +1 SETofKEYMASK lookupMods +1 SETofKEYMASK compatLookupMods +1 unused +2 SETofBUTMASK ptrBtnState +6 unused + + + +1 ?? opcode +1 5 xkb-opcode +2 4 request-length +2 KB_DEVICESPEC deviceSpec +1 SETofKEYMASK affectModLocks +1 SETofKEYMASK modLocks +1 BOOL lockGroup +1 KB_GROUP groupLock +1 SETofKEYMASK affectModLatches +1 SETofKEYMASK modLatches +1 unused +1 BOOL latchGroup +2 INT16 groupLatch + + +1 ?? opcode +1 6 xkb-opcode +2 2 request-length +2 KB_DEVICESPEC deviceSpec +2 unused + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 15 length +1 CARD8 mouseKeysDfltBtn +1 CARD8 numGroups +1 CARD8 groupsWrap +1 SETofKEYMASK internalMods.mask +1 SETofKEYMASK ignoreLockMods.mask +1 SETofKEYMASK internalMods.realMods +1 SETofKEYMASK ignoreLockMods.realMods +1 unused +2 SETofKB_VMOD internalMods.vmods +2 SETofKB_VMOD ignoreLockMods.vmods +2 CARD16 repeatDelay +2 CARD16 repeatInterval +2 CARD16 slowKeysDelay +2 CARD16 debounceDelay +2 CARD16 mouseKeysDelay +2 CARD16 mouseKeysInterval +2 CARD16 mouseKeysTimeToMax +2 CARD16 mouseKeysMaxSpeed +2 INT16 mouseKeysCurve +2 SETofKB_AXOPTION accessXOptions +2 CARD16 accessXTimeout +2 SETofKB_AXOPTION accessXTimeoutOptionsMask +2 SETofKB_AXOPTION accessXTimeoutOptionValues +2 unused +4 SETofKB_BOOLCTRL accessXTimeoutMask +4 SETofKB_BOOLCTRL accessXTimeoutValues +4 SETofKB_BOOLCTRL enabledControls +32 LISTofCARD8 perKeyRepeat + + + +1 ?? opcode +1 7 xkb-opcode +2 25 request-length +2 KB_DEVICESPEC deviceSpec +1 SETofKEYMASK affectInternalRealMods +1 SETofKEYMASK internalRealMods +1 SETofKEYMASK affectIgnoreLockRealMods +1 SETofKEYMASK ignoreLockRealMods +2 SETofKB_VMOD affectInternalVirtualMods +2 SETofKB_VMOD internalVirtualMods +2 SETofKB_VMOD affectIgnoreLockVirtualMods +2 SETofKB_VMOD ignoreLockVirtualMods +1 CARD8 mouseKeysDfltBtn +1 CARD8 groupsWrap +2 SETofKB_AXOPTION accessXOptions +2 unused +4 SETofKB_BOOLCTRL affectEnabledControls +4 SETofKB_BOOLCTRL enabledControls +4 SETofKB_CONTROL changeControls +2 CARD16 repeatDelay +2 CARD16 repeatInterval +2 CARD16 slowKeysDelay +2 CARD16 debounceDelay +2 CARD16 mouseKeysDelay +2 CARD16 mouseKeysInterval +2 CARD16 mouseKeysTimeToMax +2 CARD16 mouseKeysMaxSpeed +2 INT16 mouseKeysCurve +2 CARD16 accessXTimeout +4 SETofKB_BOOLCTRL accessXTimeoutMask +4 SETofKB_BOOLCTRL accessXTimeoutValues +2 SETofKB_AXOPTION accessXTimeoutOptionsMask +2 SETofKB_AXOPTION accessXTimeoutOptionsValues +32 LISTofCARD8 perKeyRepeat + + +1 CARD8 opcode +1 8 xkb-opcode +2 7 request-length +2 KB_DEVICESPEC deviceSpec +2 SETofKB_MAPPART full +2 SETofKB_MAPPART partial +1 CARD8 firstType +1 CARD8 nTypes +1 KEYCODE firstKeySym +1 CARD8 nKeySyms +1 KEYCODE firstKeyAction +1 CARD8 nKeyActions +1 KEYCODE firstKeyBehavior +1 CARD8 nKeyBehaviors +2 SETofKB_VMOD virtualMods +1 KEYCODE firstKeyExplicit +1 CARD8 nKeyExplicit +1 KEYCODE firstModMapKey +1 CARD8 nModMapKeys +1 KEYCODE firstVModMapKey +1 CARD8 nVModMapKeys +2 unused + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 2+(I/4) length +2 unused +1 KEYCODE minKeyCode +1 KEYCODE maxKeyCode +2 SETofKB_MAPPART present +1 CARD8 firstType +1 t nTypes +1 CARD8 totalTypes +1 KEYCODE firstKeySym +2 S totalSyms +1 s nKeySyms +1 KEYCODE firstKeyAction +2 A totalActions +1 a nKeyActions +1 KEYCODE firstKeyBehavior +1 b nKeyBehaviors +1 B totalKeyBehaviors +1 KEYCODE firstKeyExplicit +1 e nKeyExplicit +1 E totalKeyExplicit +1 KEYCODE firstModMapKey +1 m nModMapKeys +1 M totalModMapKeys +1 KEYCODE firstVModMapKey +1 0 nVModMapKeys +1 V totalVModMapKeys +1 unused +2 SETofKB_VMOD virtualMods (has v bits set to 1) +I LISTofITEMs map + SETofKB_MAPPART (present) + XkbKeyTypes typesRtrn + XkbKeySyms symsRtrn + XkbKeyActions actsRtrn.count, actsRtrn.acts + XkbKeyBehaviors behaviorsRtrn + XkbVirtualMods vmodsRtrn + XkbExplicitComponents explicitRtrn + XkbModifierMap modmapRtrn + XkbVirtualModMap vmodMapRtrn + + +ITEMs +T1+..Tt LISTofKB_KEYTYPE typesRtrn +8s+4S LISTofKB_KEYSYMMAP symsRtrn +a LISTofCARD8 actsRtrn.count +p unused,p=pad(a) +8A LISTofKB_ACTION actsRtrn.acts +4B LISTofKB_SETBEHAVIOR behaviorsRtrn +v LISTofSETofKEYMASK vmodsRtrn +p unused, p=pad(v) +2E LISTofKB_SETEXPLICIT explicitRtrn +p unused,p=pad(2E) +2M LISTofKB_KEYMODMAP modmapRtrn +p unused, p=pad(2M) +4V LISTofKB_KEYVMODMAP vmodMapRtrn + + +KB_KEYTYPE 8+8m+[4m] +1 SETofKEYMASK mods.mask +1 SETofKEYMASK mods.mods +2 SETofKB_VMOD mods.vmods +1 CARD8 numLevels +1 m nMapEntries +1 BOOL hasPreserve +1 unused +8m LISTofKB_KTMAPENTRY map +[4m] LISTofKB_MODDEF preserve + + +KB_KTMAPENTRY +1 BOOL active +1 SETofKEYMASK mods.mask +1 CARD8 level +1 SETofKEYMASK mods.mods +2 SETofKB_VMOD mods.vmods +2 unused + + +KB_KEYSYMMAP 8+4n +4 LISTofCARD8 ktIndex +1 CARD8 groupInfo +1 CARD8 width +2 n nSyms +4n LISTofKEYSYM syms + + +KB_SETBEHAVIOR +1 KEYCODE keycode +2 KB_BEHAVIOR behavior +1 unused + + +KB_SETEXPLICIT +1 KEYCODE keycode +1 SETofKB_EXPLICIT explicit + + +KB_KEYMODMAP +1 KEYCODE keycode +1 SETofKB_KEYMASK mods + + +KB_KEYVMODMAP +1 KEYCODE keycode +1 unused +2 SETofKB_VMOD vmods + + + +1 CARD8 opcode +1 9 xkb-opcode +2 9+(I/4) request-length +2 KB_DEVICESPEC deviceSpec +2 SETofKB_MAPPART present +2 SETofKB_SETMAPFLAGS flags + #0001 SetMapResizeTypes + #0002 SetMapRecomputeActions +1 KEYCODE minKeyCode +1 KEYCODE maxKeyCode +1 CARD8 firstType +1 t nTypes +1 KEYCODE firstKeySym +1 s nKeySyms +2 S totalSyms +1 KEYCODE firstKeyAction +1 a nKeyActions +2 A totalActions +1 KEYCODE firstKeyBehavior +1 b nKeyBehaviors +1 B totalKeyBehaviors +1 KEYCODE firstKeyExplicit +1 e nKeyExplicit +1 E totalKeyExplicit +1 KEYCODE firstModMapKey +1 m nModMapKeys +1 M totalModMapKeys +1 KEYCODE firstVModMapKey +1 v nVModMapKeys +1 V totalVModMapKeys +2 SETofKB_VMOD virtualMods (has n bits set to 1) +I LISTofITEMs values + SETofKB_MAPPART (present) + XkbKeyTypes types + XkbKeySymbols syms + XkbKeyActions actions.count,actions.actions + XkbKeyBehaviors behaviors + XkbVirtualMods vmods + XkbExplicitComponents explicit + XkbModifierMap modmap + XkbVirtualModMap vmodmap + + +ITEMs +T0+..Tt LISTofKB_SETKEYTYPE types +8s+4S LISTofKB_KEYSYMMAP syms +a LISTofCARD8 actions.count +p unused,p=pad(a) +8A LISTofKB_ACTION actions.actions +4B LISTofKB_SETBEHAVIOR behaviors +v LISTofSETofKEYMASK vmods +p unused, p=pad(v) +2E LISTofKB_SETEXPLICIT explicit +p unused,p=pad(2E) +2M LISTofKB_KEYMODMAP modmap +P unused, p=pad(2M) +4V LISTofKB_KEYVMODMAP vmodmap + + +KB_SETKEYTYPE 8+4m+[4m] +1 SETofKEYMASK mask +1 SETofKEYMASK realMods +2 SETofKB_VMOD virtualMods +1 CARD8 numLevels +1 m nMapEntries +1 BOOL preserve +1 unused +4m LISTofKB_KTSETMAPENTRY entries +[4m] LISTofKB_MODDEF preserveEntries (if preserve==TRUE) + + +KB_KTSETMAPENTRY +1 CARD8 level +1 SETofKEYMASK realMods +2 SETofKB_VMOD virtualMods + + + +1 ?? opcode +1 10 xkb-opcode +2 3 request-length +2 KB_DEVICESPEC deviceSpec +1 SETofKB_GROUP groups +1 BOOL getAllSI +2 CARD16 firstSI +2 CARD16 nSI + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 (16n+4g)/4 length +1 SETofKB_GROUP groupsRtrn (has g bits set to 1) +1 unused +2 CARD16 firstSIRtrn +2 n nSIRtrn +2 CARD16 nTotalSI +16 unused +16n LISTofKB_SYMINTERPRET siRtrn +4g LISTofKB_MODDEF groupRtrn + + + +1 ?? opcode +1 11 xkb-opcode +2 4+(16n+4g) request-length +2 KB_DEVICESPEC deviceSpec +1 unused +1 BOOL recomputeActions +1 BOOL truncateSI +1 SETofKB_GROUP groups (has g bits set to 1) +2 CARD16 firstSI +2 n nSI +2 unused +16n LISTofKB_SYMINTERPRET si +4g LISTofKB_MODDEF groupMaps + + +1 ?? opcode +1 12 xkb-opcode +2 2 request-length +2 KB_DEVICESPEC deviceSpec + + +ITEMs +2 unused + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 0 length +4 SETofKB_INDICATOR state +20 unused + + + +1 ?? opcode +1 13 xkb-opcode +2 3 request-length +2 KB_DEVICESPEC deviceSpec +2 unused +4 SETofKB_INDICATOR which + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 12n/4 length +4 SETofKB_INDICATOR which (has n bits set to 1) +4 SETofKB_INDICATOR realIndicators +1 n nIndicators +15 unused +12n LISTofKB_INDICATORMAP maps + + + +1 ?? opcode +1 14 xkb-opcode +2 3+3n request-length +2 KB_DEVICESPEC deviceSpec +2 unused +4 SETofKB_INDICATOR which (has n bits set to 1) +12n LISTofKB_INDICATORMAP maps + + +1 CARD8 opcode +1 15 xkb-opcode +2 4 request-length +2 KB_DEVICESPEC deviceSpec +2 KB_LEDCLASSSPEC ledClass +2 KB_IDSPEC ledID +2 unused +4 ATOM indicator + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 0 length +4 ATOM indicator +1 BOOL found +1 BOOL on +1 BOOL realIndicator +1 KB_INDICATOR ndx +1 SETofKB_IMFLAGS map.flags +1 SETofKB_IMGROUPSWHICH map.whichGroups +1 SETofKB_GROUPS map.groups +1 SETofKB_IMMODSWHICH map.whichMods +1 SETofKEYMASK map.mods +1 SETofKEYMASK map.realMods +2 SETofKB_VMOD map.vmods +4 SETofKB_BOOLCTRL map.ctrls +1 BOOL supported +3 unused + + + +1 ?? opcode +1 16 xkb-opcode +2 8 request-length +2 KB_DEVICESPEC deviceSpec +2 KB_LEDCLASSSPEC ledClass +2 KB_IDSPEC ledID +2 unused +4 ATOM indicator +1 BOOL setState +1 BOOL on +1 BOOL setMap +1 BOOL createMap +1 unused +1 SETofKB_IMFLAGS map.flags +1 SETofKB_IMGROUPSWHICH map.whichGroups +1 SETofKB_GROUP map.groups +1 SETofKB_IMMODSWHICH map.whichMods +1 SETofKEYMASK map.realMods +2 SETofKB_VMOD map.vmods +4 SETofKB_BOOLCTRL map.ctrls + + +1 CARD8 opcode +1 17 xkb-opcode +2 3 request-length +2 KB_DEVICESPEC deviceSpec +2 unused +4 SETofKB_NAMEDETAIL which + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 V/4 length +4 SETofKB_NAMEDETAIL which +1 KEYCODE minKeyCode +1 KEYCODE maxKeyCode +1 t nTypes +1 SETofKB_GROUP groupNames (has g bits set to 1) +2 SETofKB_VMOD virtualMods (has v bits set to 1) +1 KEYCODE firstKey +1 k nKeys +4 SETofKB_INDICATOR indicators (has i bits set to 1) +1 r nRadioGroups +1 a nKeyAliases +2 l nKTLevels +4 unused +V LISTofITEMs valueList + SETofKB_NAMEDETAIL (which) + XkbKeycodesName keycodesName + XkbGeometryName geometryName + XkbSymbolsName symbolsName + XkbPhySymbolsName physSymbolsName + XkbTypesName typesName + XkbCompatName compatName + XkbKeyTypeNames typeNames + XkbKTLevelNames nLevelsPerType, ktLevelNames + XkbIndicatorNames indicatorNames + XkbVirtualModNames virtualModNames + XkbGroupNames groupNames + XkbKeyNames keyNames + XkbKeyAliases keyAliases + XkbRGNames radioGroupNames + + +ITEMs +4 ATOM keycodesName +4 ATOM geometryName +4 ATOM symbolsName +4 ATOM physSymbolsName +4 ATOM typesName +4 ATOM compatName +4t LISTofATOM typeNames +l LISTofCARD8 nLevelsPerType, sum of all elements=L +p unused, p=pad(l) +4L LISTofATOM ktLevelNames +4i LISTofATOM indicatorNames +4v LISTofATOM virtualModNames +4g LISTofATOM groupNames +4k LISTofKB_KEYNAME keyNames +8a LISTofKB_KEYALIAS keyAliases +4r LISTofATOM radioGroupNames + + + +1 CARD8 opcode +1 18 xkb-opcode +2 7+(V/4) request-length +2 KB_DEVICESPEC deviceSpec +2 SETofKB_VMOD virtualMods +4 SETofKB_NAMEDETAIL which +1 CARD8 firstType +1 t nTypes +1 CARD8 firstKTLevel +1 l nKTLevels +4 SETofKB_INDICATOR indicators (has i bits set to 1) +1 SETofKB_GROUP groupNames (has g bits set to 1) +1 r nRadioGroups +1 KEYCODE firstKey +1 k nKeys +1 a nKeyAliases +1 unused +2 L totalKTLevelNames +V LISTofITEMs values + SETofKB_NAMEDETAIL (which) + XkbKeycodesName keycodesName + XkbGeometryName geometryName + XkbSymbolsName symbolsName + XkbPhySymbolsName physSymbolsName + XkbTypesName typesName + XkbCompatName compatName + XkbKeyTypeNames typeNames + XkbKTLevelNames nLevelsPerType, ktLevelNames + XkbIndicatorNames indicatorNames + XkbVirtualModNames virtualModNames + XkbGroupNames groupNames + XkbKeyNames keyNames + XkbKeyAliases keyAliases + XkbRGNames radioGroupNames + + +ITEMs +4 ATOM keycodesName +4 ATOM geometryName +4 ATOM symbolsName +4 ATOM physSymbolsName +4 ATOM typesName +4 ATOM compatName +4t LISTofATOM typeNames +l LISTofCARD8 nLevelsPerType +p unused, p=pad(l) +4L LISTofATOM ktLevelNames +4i LISTofATOM indicatorNames +4v LISTofATOM virtualModNames +4g LISTofATOM groupNames +4k LISTofKB_KEYNAME keyNames +8a LISTofKB_KEYALIAS keyAliases +4r LISTofATOM radioGroupNames + + + +1 CARD8 opcode +1 19 xkb-opcode +2 3 request-length +2 KB_DEVICESPEC deviceSpec +2 unused +4 ATOM name + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 (f+8p+C*+H*+S*+D*+A*)/4 length +4 ATOM name +1 BOOL found +1 unused +2 CARD16 widthMM +2 CARD16 heightMM +2 p nProperties +2 c nColors +2 h nShapes +2 s nSections +2 d nDoodads +2 a nKeyAliases +1 CARD8 baseColorNdx +1 CARD8 labelColorNdx +f KB_COUNTED_STRING16 labelFont +8p LISTofKB_PROPERTY properties +C0+..Cc LISTofKB_COUNTED_STRING16 colors +H0+..Hh LISTofKB_SHAPE shapes +S0+..Ss LISTofKB_SECTION sections +D0+..Dd LISTofKB_DOODAD doodads +A0+..Aa LISTofKB_KEYALIAS keyAliases + + +KB_PROPERTY 4+n+v +2 n nameLength +n STRING8 name +2 v valueLength +v STRING8 value + + +KB_SHAPE 8+O* +4 ATOM name +1 o nOutlines +1 CARD8 primaryNdx +1 CARD8 approxNdx +1 unused +O0+..Oo LISTofKB_OUTLINE outlines + + +KB_OUTLINE 4+4p +1 p nPoints +1 CARD8 cornerRadius +2 unused +4p LISTofKB_POINT points + + +KB_POINT +2 INT16 x +2 INT16 y + + +KB_SECTION 20+R*+D*+O* +4 ATOM name +2 INT16 top +2 INT16 left +2 CARD16 width +2 CARD16 height +2 INT16 angle +1 CARD8 priority +1 r nRows +1 d nDoodads +1 o nOverlays +2 unused +R0+..Rr LISTofKB_ROW rows +D0+..Dd LISTofKB_DOODAD doodads +O0+..Oo LISTofKB_OVERLAY overlays + + +KB_ROW 8+8k +2 INT16 top +2 INT16 left +1 k nKeys +1 BOOL vertical +2 unused +8k LISTofKB_KEY keys + + +KB_KEY +4 STRING8 name +2 INT16 gap +1 CARD8 shapeNdx +1 CARD8 colorNdx + + +KB_OVERLAY 8+R* +4 ATOM name +1 r nRows +3 unused +R0+..Rr LISTofKB_OVERLAYROW rows + + +KB_OVERLAYROW 4+8k +1 CARD8 rowUnder +1 k nKeys +2 unused +8k LISTofKB_OVERLAYKEY keys + + +KB_OVERLAYKEY +4 STRING8 over +4 STRING8 under + + +KB_SHAPEDOODAD +4 ATOM name +1 CARD8 type + + +KB_SHAPEDOODAD + #1 XkbOutlineDoodad + #2 XkbSolidDoodad +1 CARD8 priority +2 INT16 top +2 INT16 left +2 INT16 angle +1 CARD8 colorNdx +1 CARD8 shapeNdx +6 unused + + +KB_TEXTDOODAD 20+t+f +4 ATOM name +1 CARD8 type + #3 XkbTextDoodad +1 CARD8 priority +2 INT16 top +2 INT16 left +2 INT16 angle +2 CARD16 width +2 CARD16 height +1 CARD8 colorNdx +3 unused +t KB_COUNTED_STRING16 text +f KB_COUNTED_STRING16 font + + +KB_INDICATORDOODAD +4 ATOM name +1 CARD8 type + #4 XkbIndicatorDoodad +1 CARD8 priority +2 INT16 top +2 INT16 left +2 INT16 angle +1 CARD8 shapeNdx +1 CARD8 onColorNdx +1 CARD8 offColorNdx +5 unused + + +KB_LOGODOODAD 20+n +4 ATOM name +1 CARD8 type + #5 XkbLogoDoodad +1 CARD8 priority +2 INT16 top +2 INT16 left +2 INT16 angle +1 CARD8 colorNdx +1 CARD8 shapeNdx +6 unused +n KB_COUNTED_STRING16 logoName + + +KB_DOODAD: + KB_SHAPEDOODAD, or KB_TEXTDOODAD, or + KB_INDICATORDOODAD, or KB_LOGODOODAD + + + +1 CARD8 opcode +1 20 xkb-opcode +2 7+(f+8p+C*+H*+S*+D*+A*)/4 request-length +2 KB_DEVICESPEC deviceSpec +1 h nShapes +1 s nSections +4 ATOM name +2 CARD16 widthMM +2 CARD16 heightMM +2 p nProperties +2 c nColors +2 d nDoodads +2 a nKeyAliases +1 CARD8 baseColorNdx +1 CARD8 labelColorNdx +2 unused +f KB_COUNTED_STRING16 labelFont +8p LISTofKB_PROPERTY properties +C0+..Cc LISTofKB_COUNTED_STRING16 colors +H0+..Hh LISTofKB_SHAPE shapes +S0+..Ss LISTofKB_SECTION sections +D0+..Dd LISTofKB_DOODAD doodads +A0+..Aa LISTofKB_KEYALIAS keyAliases + + +1 CARD8 opcode +1 21 xkb-opcode +2 7 request-length +2 KB_DEVICESPEC deviceSpec +2 unused +4 SETofKB_PERCLIENTFLAG change +4 SETofKB_PERCLIENTFLAG value +4 SETofKB_BOOLCTRL ctrlsToChange +4 SETofKB_BOOLCTRL autoCtrls +4 SETofKB_BOOLCTRL autoCtrlValues + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 0 length +4 SETofKB_PERCLIENTFLAG supported +4 SETofKB_PERCLIENTFLAG value +4 SETofKB_BOOLCTRL autoCtrls +4 SETofKB_BOOLCTRL autoCtrlValues +8 unused + + + +1 CARD8 opcode +1 22 xkb-opcode +2 2+(6+m+k+t+c+s+g+p)/4 request-length +2 KB_DEVICESPEC deviceSpec +2 CARD16 maxNames +1 m keymapsSpecLen +m STRING keymapsSpec +1 k keycodesSpecLen +k STRING keycodesSpec +1 t typesSpecLen +t STRING typesSpec +1 c compatMapSpecLen +c STRING compatMapSpec +1 s symbolsSpecLen +s STRING symbolsSpec +1 g geometrySpecLen +g STRING geometrySpec +p unused,p=pad(6+m+k+t+c+s+g) + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 (M*+K*+T*+C*+S*+G*+p)/4 length +2 m nKeymaps +2 k nKeycodes +2 t nTypes +2 c nCompatMaps +2 s nSymbols +2 g nGeometries +2 CARD16 extra +10 unused +M0+..Mm LISTofKB_LISTING keymaps +K0+..Kk LISTofKB_LISTING keycodes +T0+..Tt LISTofKB_LISTING types +C0+..Cc LISTofKB_LISTING compatMaps +S0+..Ss LISTofKB_LISTING symbols +G0+..Gg LISTofKB_LISTING geometries +p unused,p=pad(M*+K*+T*+C*+S*+G*) + + +KB_LISTING 4+n+p +2 CARD16 flags +2 n length +n STRING8 string +p unused,p=pad(n) to a 2-byte boundary + + + +1 CARD8 opcode +1 23 xkb-opcode +2 3+(6+m+k+t+c+s+g+p)/4 request-length +2 KB_DEVICESPEC deviceSpec +2 SETofKB_GBNDETAILMASK need +2 SETofKB_GBNDETAILMASK want +1 BOOL load +1 unused +1 m keymapsSpecLen +m STRING8 keymapsSpec +1 k keycodesSpecLen +k STRING8 keycodesSpec +1 t typesSpecLen +t STRING8 typesSpec +1 c compatMapSpecLen +c STRING8 compatMapSpec +1 s symbolsSpecLen +s STRING8 symbolsSpec +1 g geometrySpecLen +g STRING8 geometrySpec +p unused,p=pad(6+m+k+t+c+s+g) + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 V/4 length +1 KEYCODE minKeyCode +1 KEYCODE maxKeyCode +1 BOOL loaded +1 BOOL newKeyboard +2 SETofKB_GBNDETAILMASK found +2 SETofKB_GBNDETAILMASK reported +16 unused +V LISTofITEMs replies + SETofKB_GBNDETAILMASK (reported) + XkbGBN_Types map + XkbGBN_CompatMap compat + XkbGBN_ClientSymbols map + XkbGBN_ServerSymbols map + XkbGBN_IndicatorMap indicators + XkbGBN_KeyNames names + XkbGBN_OtherNames names + XkbGBN_Geometry geometry + + +ITEMs +M XkbGetMap reply map +C XkbGetCompatMap reply compat +I XkbGetIndicatorMap reply indicators +N XkbGetNames reply names +G XkbGetGeometry reply geometry + + + +1 CARD8 opcode +1 24 xkb-opcode +2 4 request-length +2 KB_DEVICESPEC deviceSpec +2 SETofKB_DEVFEATURE wanted +1 BOOL allButtons +1 CARD8 firstButton +1 CARD8 nButtons +1 unused +2 KB_LEDCLASSSPEC ledClass +2 KB_IDSPEC ledID + + +1 1 Reply +1 CARD8 deviceID +2 CARD16 sequence number +4 (2+n+p+8b+L*)/4 length +2 SETofKB_DEVFEATURE present +2 SETofKB_FEATURE supported +2 SETofKB_FEATURE unsupported +2 l nDeviceLedFBs +1 CARD8 firstBtnWanted +1 CARD8 nBtnsWanted +1 CARD8 firstBtnRtrn +1 b nBtnsRtrn +1 CARD8 totalBtns +1 BOOL hasOwnState +2 SETofKB_IDRESULT dfltKbdFB +2 SETofKB_IDRESULT dfltLedFB +2 unused +4 ATOM devType +2 n nameLen +n STRING8 name +p unused,p=pad(2+n) +8b LISTofKB_ACTION btnActions +L0+..Ll LISTofKB_DEVICELEDINFO leds + + +KB_DEVICELEDINFO 20+4n+12m +2 KB_LEDCLASSSPEC ledClass +2 KB_IDSPEC ledID +4 SETofKB_INDICATOR namesPresent (has n bits set to 1) +4 SETofKB_INDICATOR mapsPresent (has m bits set to 1) +4 SETofKB_INDICATOR physIndicators +4 SETofKB_INDICATOR state +4n LISTofATOM names +12m LISTofKB_INDICATORMAP maps + + + +1 ?? opcode +1 25 xkb-opcode +2 3+(8b+L*)/4 request-length +2 KB_DEVICESPEC deviceSpec +1 CARD8 firstBtn +1 b nBtns +2 SETofKB_DEVFEATURE change +2 l nDeviceLedFBs +8b LISTofKB_ACTION btnActions +L0+..Ll LISTofKB_DEVICELEDINFO leds + Encoding of KB_DEVICELEDINFO is as for XkbGetDeviceInfo + + +1 ?? opcode +1 101 xkb-opcode +2 6+(n+p)/4 request-length +2 n msgLength +2 unused +4 CARD32 affectFlags +4 CARD32 flags +4 CARD32 affectCtrls +4 CARD32 ctrls +n STRING8 message +p unused, p=pad(n) + + +1 1 Reply +1 unused +2 CARD16 sequence number +4 0 length +4 CARD32 currentFlags +4 CARD32 currentCtrls +4 CARD32 supportedFlags +4 CARD32 supportedCtrls +8 unused + + + + + +Events + +1 ?? code +1 0 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 CARD8 oldDeviceID +1 KEYCODE minKeyCode +1 KEYCODE maxKeyCode +1 KEYCODE oldMinKeyCode +1 KEYCODE oldMaxKeyCode +1 CARD8 requestMajor +1 CARD8 requestMinor +2 SETofKB_NKNDETAIL changed +14 unused + + +1 ?? code +1 1 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 SETofBUTMASK ptrBtnActions +2 SETofKB_MAPPART changed +1 KEYCODE minKeyCode +1 KEYCODE maxKeyCode +1 CARD8 firstType +1 CARD8 nTypes +1 KEYCODE firstKeySym +1 CARD8 nKeySyms +1 KEYCODE firstKeyAct +1 CARD8 nKeyActs +1 KEYCODE firstKeyBehavior +1 CARD8 nKeyBehavior +1 KEYCODE firstKeyExplicit +1 CARD8 nKeyExplicit +1 KEYCODE firstModMapKey +1 CARD8 nModMapKeys +1 KEYCODE firstVModMapKey +1 CARD8 nVModMapKeys +2 SETofKB_VMOD virtualMods +2 unused + + +1 ?? code +1 2 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 SETofKEYMASK mods +1 SETofKEYMASK baseMods +1 SETofKEYMASK latchedMods +1 SETofKEYMASK lockedMods +1 KB_GROUP group +2 INT16 baseGroup +2 INT16 latchedGroup +1 KB_GROUP lockedGroup +1 SETofKEYMASK compatState +1 SETofKEYMASK grabMods +1 SETofKEYMASK compatGrabMods +1 SETofKEYMASK lookupMods +1 SETofKEYMASK compatLookupMods +2 SETofBUTMASK ptrBtnState +2 SETofKB_STATEPART changed +1 KEYCODE keycode +1 CARD8 eventType +1 CARD8 requestMajor +1 CARD8 requestMinor + + +1 ?? code +1 3 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 CARD8 numGroups +2 unused +4 SETofKB_CONTROL changedControls +4 SETofKB_BOOLCTRL enabledControls +4 SETofKB_BOOLCTRL enabledControlChanges +1 KEYCODE keycode +1 CARD8 eventType +1 CARD8 requestMajor +1 CARD8 requestMinor +4 unused + + +1 ?? code +1 4 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +3 unused +4 SETofKB_INDICATOR state +4 SETofKB_INDICATOR stateChanged +12 unused + + +1 ?? code +1 5 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +3 unused +4 SETofKB_INDICATOR state +4 SETofKB_INDICATOR mapChanged +12 unused + + +1 ?? code +1 6 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 unused +2 SETofKB_NAMEDETAIL changed +1 CARD8 firstType +1 CARD8 nTypes +1 CARD8 firstLevelName +1 CARD8 nLevelNames +1 unused +1 CARD8 nRadioGroups +1 CARD8 nKeyAliases +1 SETofKB_GROUP changedGroupNames +2 SETofKB_VMOD changedVirtualMods +1 KEYCODE firstKey +1 CARD8 nKeys +4 SETofKB_INDICATOR changedIndicators +4 unused + + +1 ?? code +1 7 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 SETofKB_GROUP changedGroups +2 CARD16 firstSI +2 CARD16 nSI +2 CARD16 nTotalSI +16 unused + + +1 ?? code +1 8 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 KB_BELLCLASSRESULT bellClass +1 CARD8 bellID +1 CARD8 percent +2 CARD16 pitch +2 CARD16 duration +4 ATOM name +4 WINDOW window +1 BOOL eventOnly +7 unused + + +1 ?? code +1 9 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 KEYCODE keycode +1 BOOL press +1 BOOL keyEventFollows +1 SETofKEYMASK mods +1 KB_GROUP group +8 STRING8 message +10 unused + + +1 ?? code +1 10 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 KEYCODE keycode +2 SETofKB_AXNDETAIL detail +2 CARD16 slowKeysDelay +2 CARD16 debounceDelay + + +1 ?? code +16 unused + + +1 ?? code +1 11 xkb code +2 CARD16 sequence number +4 TIMESTAMP time +1 CARD8 deviceID +1 unused +2 SETofKB_XIDETAIL reason +2 KB_LEDCLASSRESULT ledClass +2 CARD8 ledID +4 SETofKB_INDICATOR ledsDefined +4 SETofKB_INDICATOR ledState +1 CARD8 firstButton +1 CARD8 nButtons +2 SETofKB_XIFEATURE supported +2 SETofKB_XIFEATURE unsupported +2 unused + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch01.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch01.xml new file mode 100644 index 0000000000000000000000000000000000000000..27dcc8830350086bd2a3f4fbba8d5bb2d2b79fc0 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch01.xml @@ -0,0 +1,101 @@ + +Overview + +This extension provides a number of new capabilities and controls for +text keyboards. + + + +The core X protocol specifies the ways that the +Shift +, +Control + and +Lock + modifiers and the modifiers bound to the +Mode_switch + or +Num_Lock + keysyms interact to generate keysyms and characters. The core protocol also +allows users to specify that a key affects one or more modifiers. This behavior +is simple and fairly flexible, but it has a number of limitations that make it +difficult or impossible to properly support many common varieties of keyboard +behavior. The limitations of core protocol support for keyboards include: + + + + + Use of a single, uniform, four-symbol mapping for all keyboard keys +makes it difficult to properly support keyboard overlays, PC-style break keys +or keyboards that comply with ISO9995 or a host of other national and +international standards. + + + + Use of a modifier to specify a second keyboard group has side-effects +that wreak havoc with client grabs and X toolkit translations and limit us to +two keyboard groups. + + + + Poorly specified locking key behavior requires X servers to look for a +few "magic" keysyms to determine which keys should lock when pressed. This +leads to incompatibilities between X servers with no way for clients to detect +implementation differences. + + + + Poorly specified capitalization and control behavior requires +modifications to X library source code to support new character sets or locales +and can lead to incompatibilities between system-wide and X library +capitalization behavior. + + + + Limited interactions between modifiers specified by the core protocol +make many common keyboard behaviors difficult or impossible to implement. For +example, there is no reliable way to indicate whether or not using shift should +"cancel" the lock modifier. + + + + The lack of any explicit descriptions for indicators, most modifiers +and other aspects of the keyboard appearance requires clients that wish to +clearly describe the keyboard to a user to resort to a mishmash of prior +knowledge and heuristics. + + + + + +This extension makes it possible to clearly and explicitly specify most aspects +of keyboard behavior on a per-key basis. It adds the notion of a numeric +keyboard group to the global keyboard state and provides mechanisms to more +closely track the logical and physical state of the keyboard. For keyboard +control clients, this extension provides descriptions and symbolic names for +many aspects of keyboard appearance and behavior. It also includes a number of +keyboard controls designed to make keyboards more accessible to people with +movement impairments. + + + + +The X Keyboard Extension essentially replaces the core protocol definition of a +keyboard. The following sections describe the new capabilities of the extension +and the effect of the extension on core protocol requests, events and errors. + + + +Conventions and Assumptions + +This document uses the syntactic +conventions, common types, and errors defined in sections two through four of +the specification of the X Window System Protocol. This document assumes +familiarity with the fundamental concepts of X, especially those related to the +way that X handles keyboards. Readers who are not familiar with the meaning or +use of keycodes, keysyms or modifiers should consult (at least) the first five +chapters of the protocol specification of the X Window System before +continuing. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch02.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch02.xml new file mode 100644 index 0000000000000000000000000000000000000000..023429732490a78f255af5f6f9f7785133bdeb88 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch02.xml @@ -0,0 +1,441 @@ + +Keyboard State + +The core protocol description of +keyboard state consists of eight +modifiers +( +Shift +, +Lock +, +Control +, and +Mod1 +- +Mod5 +). A modifier reports the state of one or modifier keys, which are similar to +qualifier keys as defined by the ISO9995 standard: + + + + + Qualifier key + + +A key whose operation +has no immediate effect, but which, for as long as it is held down, modifies +the effect of other keys. A qualifier key may be, for example, a shift key or a +control key. + + + + + + +Whenever a modifier key is physically or logically depressed, the modifier it +controls is set in the keyboard state. The protocol implies that certain +modifier keys lock (i.e. affect modifier state after they have been physically +released) but does not explicitly discuss locking keys or their behavior. The +current modifier state is reported to clients in a number of core protocol +events and can be determined using the +QueryPointer + request. + + + +The XKB extension retains the eight "real" modifiers defined by the core +protocol but extends the core protocol notion of +keyboard state + to include up to four +keysym groups +, as defined by the ISO9995 standard: + + + + + + Group: + + +A logical state of a keyboard providing +access to a collection of characters. A group usually contains a set of +characters which logically belong together and which may be arranged on several +shift levels within that group. + + + + + + +For example, keyboard group can be used to select between multiple alphabets on +a single keyboard, or to access less-commonly used symbols within a character +set. + + + +Locking and Latching Modifiers and Groups + +With the core protocol, there is no way to +tell whether a modifier is set due to a lock or because the user is actually +holding down a key; this can make for a clumsy user-interface as locked +modifiers or group state interfere with accelerators and translations. + + +XKB adds explicit support for locking +and latching modifiers and groups. Locked modifiers or groups apply to all +future key events until they are explicitly changed. Latched modifiers or +groups apply only to the next key event that does not change keyboard state. + + + + +Fundamental Components of XKB Keyboard State + +The fundamental components of XKB keyboard state include: + + + + + The locked modifiers and group + + + The latched modifiers and group + + + The base modifiers and group (for which keys are physically or +logically down) + + + + The effective modifiers and group (the cumulative effect of the base, +locked and latched modifier and group states). + + + + State of the core pointer buttons. + + + + +The latched and locked state of modifiers and groups can be changed in response +to keyboard activity or under application control using the +XkbLatchLockState + request. The base modifier, base group +and pointer button states always reflect the logical state of the keyboard and +pointer and change +only + in response to keyboard or pointer activity. + + + +Computing Effective Modifier and Group + +The effective modifiers and group +report the cumulative effects of the base, latched and locked modifiers and +group respectively, and cannot be directly changed. Note that the effective +modifiers and effective group are computed differently. + + + +The effective modifiers are simply the bitwise union of the base, latched and +locked modifiers. + + + + +The effective group is the arithmetic sum of the base, latched and locked +groups. The locked and effective keyboard group must fall in the range + +Group1 +- +Group4 +, so they are adjusted into range as specified by the global +GroupsWrap +control as follows: + + + + + +If the +RedirectIntoRange + flag is set, the four least significant +bits of the groups wrap control specify the index of a group to which all +illegal groups correspond. If the specified group is also out of range, all +illegal groups map to +Group1. + + + + +If the +ClampIntoRange + flag is set, out-of-range groups +correspond to the nearest legal group. Effective groups larger than the highest +supported group are mapped to the highest supported group; effective groups +less than +Group1 + are mapped to +Group1 +. For example, a key with two groups of symbols uses +Group2 + type and symbols if the global effective group is either +Group3 + or +Group4. + + + + +If neither flag is set, group is +wrapped into range using integer modulus. For example, a key with two groups of +symbols for which groups wrap uses +Group1 + symbols if the global effective group is +Group3 + or +Group2 + symbols if the global effective group is +Group4. + + + + + +The base and latched keyboard groups are unrestricted eight-bit integer values +and are not affected by the +GroupsWrap + control. + + + + + +Computing A State Field from an XKB State + +Many events report the keyboard state +in a single +state + field. Using XKB, a state field combines modifiers, group and the pointer +button state into a single sixteen bit value as follows: + + + + + Bits 0 through 7 (the least significant eight bits) of the effective +state comprise a mask of type KEYMASK which reports the state modifiers. + + + + Bits 8 through 12 comprise a mask of type BUTMASK which reports pointer +button state. + + + + Bits 13 and 14 are interpreted as a two-bit unsigned numeric value and +report the state keyboard group. + + + + Bit 15 (the most significant bit) is reserved and must be zero. + + + + + +It is possible to assemble a state field from any of the components of the XKB +keyboard state. For example, the effective keyboard state would be assembled as +described above using the effective keyboard group, the effective keyboard +modifiers and the pointer button state. + + + + + + +Derived Components of XKB Keyboard State + +In addition to the fundamental state +components, XKB keeps track of and reports a number of state components which +are derived from the fundamental components but stored and reported separately +to make it easier to track changes in the keyboard state. These derived +components are updated automatically whenever any of the fundamental components +change but cannot be changed directly. + + + +The first pair of derived state components control the way that passive grabs +are activated and the way that modifiers are reported in core protocol events +that report state. The server uses the +ServerInternalModifiers +, +IgnoreLocksModifiers + and +IgnoreGroupLock + controls, described in Server +Internal Modifiers and Ignore Locks Behavior, to derive these two +states as follows: + + + + + The lookup state is the state used to determine the symbols associated +with a key event and consists of the effective state minus any server internal +modifiers. + + + + The grab state is the state used to decide whether a particular event +triggers a passive grab and consists of the lookup state minus any members of +the ignore locks modifiers that are not either latched or logically depressed. +If the ignore group locks control is set, the grab state does not include the +effects of any locked groups. + + + + + +Server Internal Modifiers and Ignore Locks Behavior + +The core protocol does not provide any +way to exclude certain modifiers from client events, so there is no way to set +up a modifier which affects only the server. + + + +The modifiers specified in the mask of the +InternalMods + control are not reported in any core +protocol events, are not used to determine grabs and are not used to calculate +compatibility state for XKB-unaware clients. Server internal modifiers affect +only the action applied when a key is pressed. + + + + +The core protocol does not provide any way to exclude certain modifiers from +grab calculations, so locking modifiers often have unanticipated and +unfortunate side-effects. XKB provides another mask which can help avoid some +of these problems. + + + + +The locked state of the modifiers specified in mask of the +IgnoreLockMods + control is not reported in most core +protocol events and is not used to activate grabs. The only core events which +include the locked state of the modifiers in the ignore locks mask are key +press and release events that do not activate a passive grab and which do not +occur while a grab is active. If the +IgnoreGroupLock + control is set, the locked state of the +keyboard group is not considered when activating passive grabs. + + + + +Without XKB, the passive grab set by a translation (e.g. +Alt<KeyPress>space +) does not trigger if any modifiers other than those specified by the +translation are set, with the result that many user interface components do not +react when either Num Lock or when the secondary keyboard group are active. The +ignore locks mask and the ignore group locks control make it possible to avoid +this behavior without exhaustively grabbing every possible modifier combination. + + + + + + +Compatibility Components of Keyboard State + +The core protocol interpretation of +keyboard modifiers does not include direct support for multiple groups, so XKB +reports the effective keyboard group to XKB-aware clients using some of the +reserved bits in the state field of some core protocol events, as described in +Computing A State Field from an +XKB State. + + + +This modified state field would not be interpreted correctly by XKB-unaware +clients, so XKB provides a +group compatibility mapping +(see Group Compatibility Map) which +remaps the keyboard group into a core modifier mask that has similar effects, +when possible. XKB maintains three compatibility state components that are used +to make non-XKB clients work as well as possible: + + + + + +The +compatibility state + corresponds to the effective modifier +and effective group state. + + + + +The +compatibility lookup state + is the core-protocol equivalent of the +lookup state. + + + + +The +compatibility grab state + is the nearest core-protocol equivalent +of the grab state. + + + + + +Compatibility states are essentially the corresponding XKB state, but with +keyboard group possibly encoded as one or more modifiers; Group Compatibility Map describes +the group compatibility map, which specifies the modifier(s) that correspond to +each keyboard group. + + + + +The compatibility state reported to XKB-unaware + clients for any given core protocol event +is computed from the modifier state that XKB-capable clients would see for that +same event. For example, if the ignore group locks control is set and group 2 +is locked, the modifier bound to +Mode_switch + is not reported in any event except (Device)KeyPress and (Device)KeyRelease +events that do not trigger a passive grab. + + + + +Referring to clients as "XKB-capable + is somewhat misleading in this context. +The sample implementation of XKB invisibly extends the X library to use the +keyboard extension if it is present. This means that most clients can take +advantage of all of XKB without modification, but it also means that the XKB +state can be reported to clients that have not explicitly requested the +keyboard extension. Clients that +directly + interpret the state field of core protocol events or that interpret the keymap +directly may be affected by some of the XKB differences; clients that use +library or toolkit routines to interpret keyboard events automatically use all +of the XKB features. + + + + +XKB-aware clients can query the keyboard state at any time or request immediate +notification of a change to any of the fundamental or derived components of the +keyboard state. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch03.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch03.xml new file mode 100644 index 0000000000000000000000000000000000000000..d71f353783cabb8c03d13aaec1c8944282d0dc16 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch03.xml @@ -0,0 +1,220 @@ + +Virtual Modifiers + +The core protocol specifies that +certain keysyms, when bound to modifiers, affect the rules of keycode to keysym +interpretation for all keys; for example, when +Num_Lock + is bound to some modifier, that modifier is used to choose shifted or +unshifted state for the numeric keypad keys. The core protocol does not provide +a convenient way to determine the mapping of modifier bits, in particular + +Mod1 + through +Mod5 +, to keysyms such as +Num_Lock + and +Mode_switch +. Clients must retrieve and search the modifier map to determine the keycodes +bound to each modifier, and then retrieve and search the keyboard mapping to +determine the keysyms bound to the keycodes. They must repeat this process for +all modifiers whenever any part of the modifier mapping is changed. + + + +XKB provides a set of sixteen named virtual modifiers, each of which can be +bound to any set of the eight "real" modifiers ( +Shift +, +Lock +, +Control + and +Mod1 +- +Mod5 + as reported in the keyboard state). This makes it easier for applications and +keyboard layout designers to specify to the function a modifier key or data +structure should fulfill without having to worry about which modifier is bound +to a particular keysym. + + + + +The use of a single, server-driven mechanism for reporting changes to all data +structures makes it easier for clients to stay synchronized. For example, the +core protocol specifies a special interpretation for the modifier bound to the + +Num_Lock + key. Whenever any keys or modifiers are rebound, every application has to +check the keyboard mapping to make sure that the binding for +Num_Lock + has not changed. If +Num_Lock + is remapped when XKB is in use, the keyboard description is automatically +updated to reflect the new binding, and clients are notified immediately and +explicitly if there is a change they need to consider. + + + + +The separation of function from physical modifier bindings also makes it easier +to specify more clearly the intent of a binding. X servers do not all assign +modifiers the same way — for example, +Num_Lock + might be bound to +Mod2 + for one vendor and to +Mod4 + for another. This makes it cumbersome to automatically remap the keyboard to a +desired configuration without some kind of prior knowledge about the keyboard +layout and bindings. With XKB, applications simply use virtual modifiers to +specify the behavior they want, without regard for the actual physical bindings +in effect. + + + + +XKB puts most aspects of the keyboard under user or program control, so it is +even more important to clearly and uniformly refer to modifiers by function. + + + +Modifier Definitions + +Use an +XKB modifier definition + to specify the modifiers affected by any XKB control or data structure. An XKB +modifier definition consists of a set of real modifiers, a set of virtual +modifiers, and an effective mask. The mask is derived from the real and virtual +modifiers and cannot be explicitly changed — it contains all of the real +modifiers specified in the definition +plus + any real modifiers that are bound to the virtual modifiers specified in the +definition. For example, this modifier definition specifies the numeric lock +modifier if the +Num_Lock + keysym is not bound to any real modifier: + + +{ real_mods= None, virtual_mods= NumLock, mask= None } + + + +If we assign +Mod2 + to the +Num_Lock + key, the definition changes to: + + + +{ real_mods= None, virtual_mods= NumLock, mask= Mod2 } + + + +Using this kind of modifier definition makes it easy to specify the desired +behavior in such a way that XKB can automatically update all of the data +structures that make up a keymap to reflect user or application specified +changes in any one aspect of the keymap. + + + + +The use of modifier definitions also makes it possible to unambiguously specify +the reason that a modifier is of interest. On a system for which the +Alt + and +Meta + keysyms are bound to the same modifier, the following definitions behave +identically: + + + +{ real_mods= None, virtual_mods= Alt, mask= Mod1 } +{ real_mods= None, virtual_mods= Meta, mask= Mod1 } + + + +If we rebind one of the modifiers, the modifier definitions automatically +reflect the change: + + + +{ real_mods= None, virtual_mods= Alt, mask= Mod1 } +{ real_mods= None, virtual_mods= Meta, mask= Mod4 } + + + +Without the level of indirection provided by virtual modifier maps and modifier +definitions, we would have no way to tell which of the two definitions is +concerned with +Alt + and which is concerned with +Meta. + + + + +Inactive Modifier Definitions + +Some XKB structures ignore modifier +definitions in which the virtual modifiers are unbound. Consider this +example: + + +if ( state matches { Shift } ) Do OneThing; +if ( state matches { Shift+NumLock } ) Do Another; + + + +If the +NumLock + virtual modifier is not bound to any real modifiers, these effective masks for +these two cases are identical (i.e. they contain only +Shift +). When it is essential to distinguish between +OneThing + and Another, XKB considers only those modifier definitions for which all +virtual modifiers are bound. + + + + + +Virtual Modifier Mapping + +XKB maintains a +virtual modifier mapping +, which lists the virtual modifiers associated with each key. The real +modifiers bound to a virtual modifier always include all of the modifiers bound +to any of the keys that specify that virtual modifier in their virtual modifier +mapping. + + + +For example, if +Mod3 + is bound to the +Num_Lock + key by the core protocol modifier mapping, and the +NumLock + virtual modifier is bound to they +Num_Lock + key by the virtual modifier mapping, +Mod3 + is added to the set of modifiers associated with the +NumLock + virtual modifier. + + + + +The virtual modifier mapping is normally updated automatically whenever actions +are assigned to keys (see Changing +the Keyboard Mapping Using the Core Protocol for details) and few +applications should need to change the virtual modifier mapping explicitly. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch04.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch04.xml new file mode 100644 index 0000000000000000000000000000000000000000..d35e2b4b3a18256ba7f335c04617af5dbc2d8d45 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch04.xml @@ -0,0 +1,865 @@ + +Global Keyboard Controls + + +The X Keyboard Extension supports a number of +global key controls +, which affect the way that XKB handles the keyboard as a whole. Many of these +controls make the keyboard more accessible to the physically impaired and are +based on the AccessDOS package +AccessDOS provides access to the DOS operating system for people with physical +impairments and was developed by the Trace R&D Center at the University of +Wisconsin. For more information on AccessDOS, contact the Trace R&D Center, +Waisman Center and Department of Industrial Engineering, University of +Wisconsin-Madison WI 53705-2280. Phone: 608-262-6966. e-mail: +info@trace.wisc.edu.. + + + +The RepeatKeys Control + + +The core protocol only allows control over whether or not the entire keyboard +or individual keys should autorepeat when held down. The +RepeatKeys + control extends this capability by adding control over the delay until a key +begins to repeat and the rate at which it repeats. +RepeatKeys + is also coupled with the core autorepeat control; changes to one are always +reflected in the other. + + + + +The +RepeatKeys + control has two parameters. The +autorepeat delay + specifies the delay between the initial press of an autorepeating key and the +first generated repeat event in milliseconds. The +autorepeat interval + specifies the delay between all subsequent generated repeat events in +milliseconds. + + + + +The PerKeyRepeat Control + + +When +RepeatKeys + are active, the +PerKeyRepeat + control specifies whether or not individual keys should autorepeat when held +down. XKB provides the +PerKeyRepeat + for convenience only, and it always parallels the +auto-repeats + field of the core protocol +GetKeyboardControl + request — changes to one are always reflected in the other. + + + + + +Detectable Autorepeat + + +The X server usually generates both press and release events whenever an +autorepeating key is held down. If an XKB-aware client enables the +DetectableAutorepeat + per-client option for a keyboard, the server sends that client a key release +event only when the key is +physically + released. For example, holding down a key to generate three characters without +detectable autorepeat yields: + + + +Press -> Release -> Press -> Release -> Press -> Release + + + +If detectable autorepeat is enabled, the client instead receives: + + + +Press-> Press -> Press -> Release + + + +Note that only clients that request detectable autorepeat are affected; other +clients continue to receive both press and release events for autorepeating +keys. Also note that support for detectable autorepeat is optional; servers are +not required to support detectable autorepeat, but they must correctly report +whether or not it is supported. + + + + +Querying and Changing Per-Client +Flags describes the +XkbPerClientFlags + request, which reports or changes values for all of the per-client flags, and +which lists the per-client flags that are supported. + + + + + + +The SlowKeys Control + + +Some users often bump keys accidentally while moving their hand or typing stick +toward the key they want. Usually, the keys that are bumped accidentally are +hit only for a very short period of time. The +SlowKeys + control helps filter these accidental bumps by telling the server to wait a +specified period, called the +SlowKeys acceptance delay +, before delivering key events. If the key is released before this period +elapses, no key events are generated. The user can then bump any number of keys +on their way to the one they want without generating unwanted characters. Once +they have reached the key they want, they can then hold it long enough for + +SlowKeys + to accept it. + + + + +The +SlowKeys + control has one parameter; the +slow keys delay + specifies the length of time, in milliseconds, that a key must be held down +before it is accepted. + + + + +When +SlowKeys + are active, the X Keyboard Extension reports the initial press, acceptance, +rejection or release of any key to interested clients using +AccessXNotify + events. The +AccessXNotify + event is described in more detail in Events. + + + + +The BounceKeys Control + + +Some people with physical impairments accidentally "bounce" on a key when they +press it. That is, they press it once, then accidentally press it again +immediately. The +BounceKeys + control temporarily disables a key after it has been pressed, effectively +"debouncing" the keyboard. + + + + +The +BounceKeys + has a single parameter. The +BounceKeys delay + specifies the period of time, in milliseconds, that the key is disabled after +it is pressed. + + + + +When +BounceKeys + are active, the server reports the acceptance or rejection of any key to +interested clients by sending an +AccessXNotify + event. The +AccessXNotify + event is described in more detail in Events. + + + + +The StickyKeys Control + + +Some people find it difficult or impossible to press two keys at once. The + +StickyKeys + control makes it easier for them to type by changing the behavior of the +modifier keys. When +StickyKeys + are enabled, a modifier is latched when the user presses it just once, so the +user can first press a modifier, release it, then press another key. For +example, to get an exclamation point (!) on a PC-style keyboard, the user can +press the +Shift + key, release it, then press the +1 + key. + + + + +By default, +StickyKeys + also allows users to lock modifier keys without requiring special locking +keys. The user can press a modifier twice in a row to lock it, and then unlock +it by pressing it one more time. + + + + +Modifiers are automatically unlatched when the user presses a non-modifier key. +For instance, to enter the sequence +Shift ++ +Ctrl ++ +Z + the user could press and release the +Shift + key to latch the +Shift + modifier, then press and release the +Ctrl + key to latch the +Control + modifier — the +Ctrl + key is a modifier key, so pressing it does not unlatch the +Shift + modifier, but leaves both the +Shift + and +Control + modifiers latched, instead. When the user presses the +Z + key, it will be as though the user pressed +Shift ++ +Ctrl ++ +Z + simultaneously. The +Z + key is not a modifier key, so the +Shift + and +Control + modifiers are unlatched after the event is generated. + + + + +A locked a modifier remains in effect until the user unlocks it. For example, +to enter the sequence ("XKB") on a PC-style keyboard with a typical US/ASCII +layout, the user could press and release the +Shift + key twice to lock the +Shift + modifier. Then, when the user presses the +9 +, +‘ +, +x +, +k +, +b +, +‘ +, and +0 + keys in sequence, it will generate ("XKB"). To unlock the +Shift + modifier, the user can press and release the +Shift + key. + + + + +Two option flags modify the behavior of the +StickyKeys + control: + + + + + If the +XkbAX_TwoKeys + flag is set, XKB automatically turns +StickyKeys + off if the user presses two or more keys at once. This serves to automatically +disable StickyKeys when a user who does not require sticky keys is using the +keyboard. + + + + The +XkbAX_LatchToLock + controls the locking behavior of +StickyKeys +; the +StickyKeys + control only locks modifiers as described above if the +XkbAX_LatchToLock + flag is set. + + + + + + +The MouseKeys Control + + +The +MouseKeys + control lets a user control all the mouse functions from the keyboard. When + +MouseKeys + are enabled, all keys with +MouseKeys + actions bound to them generate core pointer events instead of normal key press +and release events. + + + + +The +MouseKeys + control has a single parameter, the +mouse keys default button +, which specifies the core pointer button to be used by mouse keys actions that +do not explicitly specify a button. + + + + + +The MouseKeysAccel Control + + +If the +MouseKeysAccel + control is enabled, the effect of a pointer motion action changes as a key is +held down. The +mouse keys delay + specifies the amount of time between the initial key press and the first +repeated motion event. The +mouse keys interval + specifies the amount of time between repeated mouse keys events. The +steps to maximum acceleration + field specifies the total number of events before the key is travelling at +maximum speed. The +maximum acceleration + field specifies the maximum acceleration. The +curve + parameter controls the ramp used to reach maximum acceleration. + + + + +When +MouseKeys + are active and a +SA_MovePtr + key action (see Key +Actions) is activated, a pointer motion event is generated immediately. +If +MouseKeysAccel + is enabled and if acceleration is enabled for the key in question, a second +event is generated after +mouse keys delay +milliseconds, and additional events are generated every +mouse keys interval + milliseconds for as long as the key is held down. + + + + +Relative Pointer Motion + + +If the +SA_MovePtr + action specifies relative motion, events are generated as follows: The initial +event always moves the cursor the distance specified in the action; after + +steps to maximum acceleration + events have been generated, all subsequent events move the pointer the +distance specified in the action times the +maximum acceleration. + Events after the first but before maximum acceleration has been achieved are +accelerated according to the formula: + + + + + + + + + + +Where +action_delta + is the offset specified by the mouse keys action, +max_accel +and +steps_to_max + are parameters to the +MouseKeysAccel + ctrl, and the curveFactor is computed using the +MouseKeysAccel + +curve + parameter as follows: + + + + + + + + + +With the result that a +curve + of +0 + causes the distance moved to increase linearly from +action_delta + to + + + + +, and the minimum legal +curve + of - +1000 + causes all events after the first move at +max_accel +. A negative +curve + causes an initial sharp increase in acceleration which tapers off, while a +positive curve yields a slower initial increase in acceleration followed by a +sharp increase as the number of pointer events generated by the action +approaches +steps_to_max +. + + + + + +Absolute Pointer Motion + + +If an +SA_MovePtr + action specifies an absolute position for one of the coordinates but still +allows acceleration, all repeated events contain any absolute coordinates +specified in the action. + + + + + + +The AccessXKeys Control + + +If +AccessXKeys + is enabled many controls can also be turned on or off from the keyboard by +entering the following standard key sequences: + + + + + Holding down a shift key by itself for eight seconds toggles the + +SlowKeys + control. + + + + Pressing and releasing a shift key five times in a row without any +intervening key events and with less than 30 seconds delay between consecutive +presses toggles the state of the +StickyKeys + control. + + + + Simultaneously operating two or more modifier keys deactivates the + +StickyKeys + control. + + + + + +Some of these key sequences optionally generate audible feedback of the change +in state, as described in The +AccessXFeedback Control, or cause +XkbAccessXNotify + events as described in Events. + + + + + +The AccessXTimeout Control + + +In environments where computers are shared, features such as +SlowKeys + present a problem: if +SlowKeys + is on, the keyboard can appear to be unresponsive because keys have no effect +unless they are held for a certain period of time. To help address this +problem, XKB provides an +AccessXTimeout + control to automatically change the value of any global controls or AccessX +options if the keyboard is idle for a specified period of time. + + + + +The AccessXTimeout control has a number of parameters which affect the duration +of the timeout and the features changed when the timeout expires. + + + + +The +AccessX Timeout + field specifies the number of seconds the keyboard must be idle before the +global controls and AccessX options are modified. The +AccessX Options Mask + field specifies which values in the +AccessX Options + field are to be changed, and the +AccessX Options Values + field specifies the new values for those options. The +AccessX Controls Mask + field specifies which controls are to be changed in the global set of + +enabled controls +, and the +AccessX Controls Values + field specifies the new values for those controls. + + + + + +The AccessXFeedback Control + + +If +AccessXFeedback + is enabled, special beep-codes indicate changes in keyboard controls (or some +key events when +SlowKeys + or +StickyKeys + are active). Many beep codes sound as multiple tones, but XKB reports a single + +XkbBellNotify + event for the entire sequence of tones. + + + + +All feedback tones are governed by the +AudibleBell + control. Individual feedback tones can be explicitly enabled or disabled using +the +accessX options mask + or set to deactivate after an idle period using the +accessX timeout options mask +. XKB defines the following feedback tones: + + + + + + + + + + + + Feedback Name + Bell Name + Default Sound + Indicates + + + + + FeatureFB + AX_FeatureOn + rising tone + Keyboard control enabled + + + + AX_FeatureOff + falling tone + Keyboard control disabled + + + + AX_FeatureChange + two tones + Several controls changed state + + + IndicatorFB + AX_IndicatorOn + high tone + Indicator Lit + + + + AX_IndicatorOff + low tone + Indicator Extinguished + + + + AX_IndicatorChange + two high tones + Several indicators changed state + + + SlowWarnFB + AX_SlowKeysWarning + three high tones + Shift key held for four seconds + + + SKPressFB + AX_SlowKeyPress + single tone + Key press while +SlowKeys + are on + + + SKReleaseFB + AX_SlowKeyRelease + single tone + Key release while +SlowKeys + are on + + + SKAcceptFB + AX_SlowKeyAccept + single tone + Key event accepted by +SlowKeys + + + + SKRejectFB + AX_SlowKeyReject + low tone + Key event rejected by +SlowKeys + + + + StickyKeysFB + AX_StickyLatch + low tone then high tone + Modifier latched by +StickyKeys + + + + + AX_StickyLock + high tone + Modifier locked by +StickyKeys + + + + + AX_StickyUnlock + low tone + Modifier unlocked by +StickyKeys + + + + BKRejectFB + AX_BounceKeysReject + low tone + Key event rejected by +BounceKeys + + + + + + + +Implementations that cannot generate continuous tones may generate multiple +beeps instead of falling and rising tones; for example, they can generate a +high-pitched beep followed by a low-pitched beep instead of a continuous +falling tone. + + + + +If the physical keyboard bell is not very capable, attempts to simulate a +continuous tone with multiple bells can sound horrible. Set the +DumbBellFB + AccessX option to inform the server that the keyboard bell is not very capable +and that XKB should use only simple bell combinations. Keyboard capabilities +vary wildly, so the sounds generated for the individual bells when the + +DumbBellFB + option is set are implementation specific. + + + + + +The Overlay1 and Overlay2 Controls + + +A keyboard overlay allows some subset of the keyboard to report alternate +keycodes when the overlay is enabled. For example a keyboard overlay can be +used to simulate a numeric or editing keypad on keyboard that does not actually +have one by generating alternate of keycodes for some keys when the overlay is +enabled. This technique is very common on portable computers and embedded +systems with small keyboards. + + + + +XKB includes direct support for two keyboard overlays, using the +Overlay1 + and +Overlay2 + controls. When +Overlay1 + is enabled, all of the keys that are members of the first keyboard overlay +generate an alternate keycode. When +Overlay2 + is enabled, all of the keys that are members of the second keyboard overlay +generate an alternate keycode. + + + + +To specify the overlay to which a key belongs and the alternate keycode it +should generate when that overlay is enabled, assign it either the +KB_Overlay1 + or +KB_Overlay2 + key behaviors, as described in +Key Behavior. + + + + + +"Boolean" Controls and The EnabledControls Control + + +All of the controls described above, along with the +AudibleBell + control (described in Disabling +Server Generated Bells) and the +IgnoreGroupLock + control (described in Server +Internal Modifiers and Ignore Locks Behavior) comprise the +boolean controls +. In addition to any parameters listed in the descriptions of the individual +controls, the boolean controls can be individually enabled or disabled by +changing the value of the +EnabledControls + control. + + + + +The following +non-boolean + controls are always active and cannot be changed using the +EnabledControls + control or specified in any context that accepts only boolean controls: + +GroupsWrap + (Computing Effective Modifier and +Group), +EnabledControls +, +InternalMods + (Server Internal Modifiers and +Ignore Locks Behavior), and +IgnoreLockMods + (Server Internal Modifiers and +Ignore Locks Behavior) and +PerKeyRepeat + (The RepeatKeys Control) + + + + + +Automatic Reset of Boolean Controls + + +The +auto-reset controls + are a per-client value which consist of two masks that can contain any of the +boolean controls (see "Boolean" +Controls and The EnabledControls Control). Whenever the client exits +for any reason, any boolean controls specified in the +auto-reset mask + are set to the corresponding value from the +auto-reset values + mask. This makes it possible for clients to "clean up after themselves" +automatically, even if abnormally terminated. + + + + +For example, a client that replace the keyboard bell with some other audible +cue might want to turn off the +AudibleBell + control (Disabling Server +Generated Bells) to prevent the server from also generating a sound and +thus avoid cacophony. If the client were to exit without resetting the + +AudibleBell +control, the user would be left without any feedback at all. Setting +AudibleBell + in both the auto-reset mask and auto-reset values guarantees that the audible +bell will be turned back on when the client exits. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch05.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch05.xml new file mode 100644 index 0000000000000000000000000000000000000000..5669a39eac50dfc9d28e1cf0e620a03d795a3ddd --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch05.xml @@ -0,0 +1,86 @@ + + +Key Event Processing Overview + + +There are three steps to processing each key event in the X server, and at +least three in the client. This section describes each of these steps briefly; +the following sections describe each step in more detail. + + + + + First, the server applies global keyboard controls to determine whether +the key event should be processed immediately, deferred, or ignored. For +example, the +SlowKeys + control can cause a key event to be deferred until the slow keys delay has +elapsed while the +RepeatKeys + control can cause multiple X events from a single physical key press if the +key is held down for an extended period. The global keyboard controls affect +all of the keys on the keyboard and are described in +Global Keyboard Controls. + + + + Next, the server applies per-key behavior. Per key-behavior can be used +to simulate or indicate some special kinds of key behavior. For example, +keyboard overlays, in which a key generates an alternate keycode under certain +circumstances, can be implemented using per-key behavior. Every key has a +single behavior, so the effect of key behavior does not depend on keyboard +modifier or group state, though it might depend on global keyboard controls. +Per-key behaviors are described in detail in +Key Behavior. + + + + Finally, the server applies key actions. Logically, every keysym on the +keyboard has some action associated with it. The key action tells the server +what to do when an event which yields the corresponding keysym is generated. +Key actions might change or suppress the event, generate some other event, or +change some aspect of the server. Key actions are described in Key Actions. + + + + + +If the global controls, per-key behavior and key action combine to cause a key +event, the client which receives the event processes it in several steps. + + + + + First the client extracts the effective keyboard group and a set of +modifiers from the state field of the event. See Computing A State Field from an XKB +State for details. + + + + Using the modifiers and effective keyboard group, the client selects a +symbol from the list of keysyms bound to the key. Determining the KeySym Associated with a +Key Event discusses symbol selection. + + + + If necessary, the client transforms the symbol and resulting string +using any modifiers that are "left over" from the process of looking up a +symbol. For example, if the +Lock + modifier is left over, the resulting keysym is capitalized according to the +capitalization rules specified by the system. See + +Transforming the KeySym Associated with a +Key Event for a more detailed discussion of the transformations defined +by XKB. + + + + Finally, the client uses the keysym and remaining modifiers in an +application-specific way. For example, applications based on the X toolkit +might apply translations based on the symbol and modifiers reported by the +first three steps. + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch06.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch06.xml new file mode 100644 index 0000000000000000000000000000000000000000..ec6a5f29be774fde717d812fa3ab31c3cb6d8c71 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch06.xml @@ -0,0 +1,1767 @@ + +Key Event Processing in the Server + + +This section describes the steps involved in processing a key event within the +server when XKB is present. Key events can be generated due to keyboard +activity and passed to XKB by the DDX layer, or they can be synthesized by +another extension, such as XTEST. + + + +Applying Global Controls + + +When the X Keyboard Extension receives a key event, it first checks the global +key controls to decide whether to process the event immediately or at all. The +global key controls which might affect the event, in descending order of +priority, are: + + + + + If a key is pressed while the +BounceKeys + control is enabled, the extension generates the event only if the key is +active. When a key is released, the server deactivates the key and starts a + +bounce keys timer + with an interval specified by the debounce delay. + + +If the bounce keys timer expires or if some other key is pressed before the +timer expires, the server reactivates the corresponding key and deactivates the +timer. Neither expiration nor deactivation of a bounce keys timer causes an +event. + + + If the +SlowKeys + control is enabled, the extension sets a +slow keys timer + with an interval specified by the slow keys delay, but does not process the +key event immediately. The corresponding key release deactivates this timer. + + +If the slow keys timer expires, the server generates a key press for the +corresponding key, sends an +XkbAccessXNotify + and deactivates the timer. + + + + The extension processes key press events normally whether or not the + +RepeatKeys + control is active, but if +RepeatKeys + are enabled and per-key autorepeat is enabled for the event key, the extension +processes key press events normally, but it also initiates an +autorepeat timer + with an interval specified by the autorepeat delay. The corresponding key +release deactivates the timer. + + +If the autorepeat timer expires, the server generates a key release and a key +press for the corresponding key and reschedules the timer according to the +autorepeat interval. + + + + + +Key events are processed by each global control in turn: if the +BounceKeys + control accepts a key event, +SlowKeys + considers it. Once +SlowKeys + allows or synthesizes an event, the +RepeatKeys + control acts on it. + + + + + +Key Behavior + + +Once an event is accepted by all of the controls or generated by a timer, the +server checks the per-key behavior of the corresponding key. This extension +currently defines the following key behaviors: + + + + + + + + + + Behavior + Effect + + + + + +KB_Default + + Press and release events are processed normally. + + + +KB_Lock + + If a key is logically up (i.e. the corresponding bit of the core key +map is cleared) when it is pressed, the key press is processed normally and the +corresponding release is ignored. If the key is logically down when pressed, +the key press is ignored but the corresponding release is processed normally. + + + + + + +KB_RadioGroup + + + + flags: CARD8 + + + index: CARD8 + + + If another member of the radio group specified by +index + is logically down when a key is pressed, the server synthesizes a key release +for the member that is logically down and then processes the new key press +event normally. + +If the key itself is logically down when pressed, the key press event is +ignored, but the processing of the corresponding key release depends on the +value of the +RGAllowNone + bit in +flags +. If it is set, the key release is processed normally; otherwise the key +release is also ignored. + + +All other key release events are ignored. + + + + + + +KB_Overlay1 + + + + key: KEYCODE + + + If the +Overlay1 + control is enabled, events from this key are reported as if they came from the +key specified in +key +. Otherwise, press and release events are processed normally. + + + + + +KB_Overlay2 + + + + key: KEYCODE + + + If the +Overlay2 + control is enabled, events from this key are reported as if they came from the +key specified in +key +. Otherwise, press and release events are processed normally. + + + + + + +The X server uses key behavior to determine whether to process or filter out +any given key event; key behavior is independent of keyboard modifier or group +state (each key has exactly one behavior. + + + +Key behaviors can be used to simulate any of these types of keys or to indicate +an unmodifiable physical, electrical or software driver characteristic of a +key. An optional +permanent + flag can modify any of the supported behaviors and indicates that behavior +describes an unalterable physical, electrical or software aspect of the +keyboard. Permanent behaviors cannot be changed or set by the +XkbSetMap + request. The +permanent + flag indicates a characteristic of the underlying system that XKB cannot +affect, so XKB treats all permanent behaviors as if they were +KB_Default + and does not filter key events described in the table above. + + + + + +Key Actions + + +Once the server has applied the global controls and per-key behavior and has +decided to process a key event, it applies +key actions + to determine the effects of the key on the internal state of the server. A key +action consists of an operator and some optional data. XKB supports actions +which: + + + + + change base, latched or locked modifiers or group + + + + move the core pointer or simulate core pointer button events + + + + change most aspects of keyboard behavior + + + + terminate or suspend the server + + + + send a message to interested clients + + + + simulate events on other keys + + + + + +Each key has an optional list of actions. If present, this list parallels the +list of symbols associated with the key (i.e. it has one action per symbol +associated with the key). For key press events, the server looks up the action +to be applied from this list using the key symbol mapping associated with the +event key, just as a client looks up symbols as described in Determining the KeySym Associated with a +Key Event; if the event key does not have any actions, the server uses +the +SA_NoAction + event for that key regardless of modifier or group state. + + + + +Key actions have essentially two halves; the effects on the server when the key +is pressed and the effects when the key is released. The action applied for a +key press event determines the further actions, if any, that are applied to the +corresponding release event or to events that occur while the key is held down. +Clients can change the actions associated with a key while the key is down +without changing the action applied next time the key is released; subsequent +press-release pairs will use the newly bound key action. + + + + +Most actions directly change the state of the keyboard or server; some actions +also modify other actions that occur simultaneously with them. Two actions +occur simultaneously if the keys which invoke the actions are both logically +down at the same time, regardless of the order in which they are pressed or +delay between the activation of one and the other. + + + + +Most actions which affect keyboard modifier state accept a modifier definition +(see Virtual Modifiers) +named +mods + and a boolean flag name +useModMap + among their arguments. These two fields combine to specify the modifiers +affected by the action as follows: If +useModMap + is +True +, the action sets any modifiers bound by the modifier mapping to the key that +initiated the action; otherwise, the action sets the modifiers specified by + +mods +. For brevity in the text of the following definitions, we refer to this +combination of +useModMap + and +mods + as the "action modifiers." + + + + +The X Keyboard Extension supports the following actions: + + + + + + + + + + Action + Effect + + + + + SA_NoAction + + + + +No direct effect, though SA_NoAction + events may change the effect of other server actions (see below). + + + + + + + + + SA_SetMods + + + mods: MOD_DEF + + + useModMap: BOOL + + + clearLocks: BOOL + + + + + + +Key press adds any action modifiers to the keyboard’s base modifiers. + + + + Key release clears any action modifiers in the keyboard’s base +modifiers, provided that no other key which affects the same modifiers is +logically down. + + + + If no keys were operated simultaneously with this key and +clearLocks + is set, release unlocks any action modifiers. + + + + + + + + + +SA_LatchMods + + + + mods: MOD_DEF + + + useModMap: BOOL + + + clearLocks: BOOL + + + latchToLock: BOOL + + + + + + Key press and release events have the same effect as for +SA_SetMods +; if no keys were operated simultaneously with the latching modifier key, key +release events have the following additional effects: + + + + Modifiers that were unlocked due to +clearLocks + have no further effect. + + + + If +latchToLock + is set, key release locks and then unlatches any remaining action modifiers +that are already latched. + + + + Finally, key release latches any action modifiers that were not used by +the +clearLocks + or +latchToLock + flags. + + + + + + + + + +SA_LockMods + + + + mods: MOD_DEF + + + useModMap: BOOL + + + noLock: BOOL + + + noUnlock: BOOL + + + + + + Key press sets the base and possibly the locked state of any action +modifiers. If +noLock + is +True +, only the base state is changed. + + + + For key release events, clears any action modifiers in the keyboard’s +base modifiers, provided that no other key which affects the same modifiers is +down. If +noUnlock + is +False + and any of the action modifiers were locked before the corresponding key press +occurred, key release unlocks them. + + + + + + + + + +SA_SetGroup + + + + group: INT8 + + + groupAbsolute: BOOL + + + clearLocks: BOOL + + + + + + If +groupAbsolute + is set, key press events change the base keyboard group to +group +; otherwise, they add +group + to the base keyboard group. In either case, the resulting effective keyboard +group is brought back into range depending on the value of the +GroupsWrap + control for the keyboard. + + + + If an +SA_ISOLock + key is pressed while this key is held down, key release has no effect, +otherwise it cancels the effects of the press. + + + + If no keys were operated simultaneously with this key and +clearLocks + is set, key release also sets the locked keyboard group to +Group1 +. + + + + + + + + + +SA_LatchGroup + + + + group: INT8 + + + groupAbsolute: BOOL + + + clearLocks: BOOL + + + latchToLock: BOOL + + + + + + Key press and release events have the same effect as an +SA_SetGroup + action; if no keys were operated simultaneously with the latching group key +and the +clearLocks + flag was not set or had no effect, key release has the following additional +effects: + + + + If +latchToLock + is set and the latched keyboard group is non-zero, the key release adds the +delta applied by the corresponding key press to the locked keyboard group and +subtracts it from the latched keyboard group. The locked and effective keyboard +group are brought back into range according to the value of the global + +GroupsWrap + control for the keyboard. + + + + Otherwise, key release adds the key press delta to the latched keyboard +group. + + + + + + + + + +SA_LockGroup + + + + group: INT8 + + + groupAbsolute: BOOL + + + + + + If +groupAbsolute + is set, key press sets the locked keyboard group to +group +. Otherwise, key press adds +group + to the locked keyboard group. In either case, the resulting locked and +effective group is brought back into range depending on the value of the + +GroupsWrap + control for the keyboard. + + + + Key release has no effect. + + + + + + + + + +SA_MovePtr + + + + x, y: INT16 + + + noAccel: BOOL + + + absoluteX: BOOL + + + absoluteY: BOOL + + + + + + If +MouseKeys + are not enabled, this action behaves like +SA_NoAction +, otherwise this action cancels any pending repeat key timers for this key and +has the following additional effects. + + + + Key press generates a core pointer +MotionNotify + event instead of the usual +KeyPress +. If +absoluteX + is +True +, +x + specifies the new pointer X coordinate, otherwise +x + is added to the current pointer X coordinate; +absoluteY + and +y + specify the new Y coordinate in the same way. + + + + If +noAccel + is +False +, and the +MouseKeysAccel + keyboard control is enabled, key press also initiates the mouse keys timer for +this key; every time this timer expires, the cursor moves again. The distance +the cursor moves in these subsequent events is determined by the mouse keys +acceleration as described in The +MouseKeysAccel Control. + + + + Key release disables the mouse keys timer (if it was initiated by the +corresponding key press) but has no other effect and is ignored (does not +generate an event of any type). + + + + + + + + + +SA_PtrBtn + + + + button: CARD8 + + + count: CARD8 + + + useDfltBtn: BOOL + + + + + + If +MouseKeys + are not enabled, this action behaves like +SA_NoAction +. + + + + If +useDfltBtn + is set, the event is generated for the current default core button. Otherwise, +the event is generated for the button specified by +button +. + + + + If the mouse button specified for this action is logically down, the +key press and corresponding release are ignored and have no effect. + + + + Otherwise, key press causes one or more core pointer button events +instead of the usual key press. If +count + is +0 +, key press generates a single +ButtonPress + event; if +count + is greater than +0 +, key press generates +count + pairs of +ButtonPress + and +ButtonRelease + events. + + + + If +count + is +0 +, key release generates a core pointer +ButtonRelease + which matches the event generated by the corresponding key press; if count is +non-zero, key release does not cause a +ButtonRelease + event. Key release never causes a key release event. + + + + + + + + + +SA_LockPtrBtn + + + + button: BUTTON + + + noLock: BOOL + + + noUnlock: BOOL + + + useDfltBtn: BOOL + + + + + + If +MouseKeys + are not enabled, this action behaves like +SA_NoAction +. + + + + Otherwise, if the button specified by +useDfltBtn + and +button + is not locked, key press causes a +ButtonPress + instead of a key press and locks the button. If the button is already locked +or if +noLock + is +True +, key press is ignored and has no effect. + + + + If the corresponding key press was ignored, and if +noUnlock + is +False +, key release generates a +ButtonRelease + event instead of a key release event and unlocks the specified button. If the +corresponding key press locked a button, key release is ignored and has no +effect. + + + + + + + + + +SA_SetPtrDflt + + + + affect: CARD8 + + + value: CARD8 + + + dfltBtnAbs: BOOL + + + + + + If +MouseKeys + are not enabled, this action behaves like +SA_NoAction +. + + + + Otherwise, both key press and key release are ignored, but key press +changes the pointer value specified by +affect +to +value +, as follows: + + + + If +which + is +SA_AffectDfltBtn +, +value + and +dfltBtnAbs + specify the default pointer button used by the various pointer actions as +follow: If +dfltBtnAbs +is True, value specifies the button to be used, otherwise, +value + specifies the amount to be added to the current default button. In either +case, illegal button choices are wrapped back into range. + + + + + + + + + +SA_ISOLock + + + + dfltIsGroup: +False + + + + mods: MOD_DEF + + + useModMap: BOOL + + + noLock: BOOL + + + noUnlock: BOOL + + + noAffectMods: BOOL + + + noAffectGrp: BOOL + + + noAffectPtr: BOOL + + + noAffectCtrls: BOOL + + +or + + + dfltIsGroup: +True + + + + group: INT8 + + + groupAbsolute: BOOL + + + noAffectMods: BOOL + + + noAffectGrp: BOOL + + + noAffectPtr: BOOL + + + noAffectCtrls: BOOL + + + + + + If +dfltIsGroup + is +True +, key press sets the base group specified by +groupAbsolute + and +group +. Otherwise, key press sets the action modifiers in the keyboard’s base +modifiers. + + + + Key release clears the base modifiers or group that were set by the key +press; it may have additional effects if no other appropriate actions occur +simultaneously with the +SA_ISOLock + operation. + + + + If +noAffectMods + is +False +, any +SA_SetMods + or +SA_LatchMods + actions that occur simultaneously with the +ISOLock + action are treated as +SA_LockMods + instead. + + + + If +noAffectGrp + is +False +, any +SA_SetGroup + or +SA_LatchGroup + actions that occur simultaneously with this action are treated as +SA_LockGroup + actions instead. + + + + If +noAffectPtr + is +False +, +SA_PtrBtn + actions that occur simultaneously with the +SA_ISOLock + action are treated as +SA_LockPtrBtn + actions instead. + + + + If +noAffectCtrls + is +False +, any +SA_SetControls + actions that occur simultaneously with the +SA_ISOLock + action are treated as +SA_LockControls + actions instead. + + + + If no other actions were transformed by the +SA_ISOLock + action, key release locks the group or modifiers specified by the action +arguments. + + + + + + + +SA_TerminateServer + + + + + Key press terminates the server. Key release is ignored. + + + + This action is optional; servers are free to ignore it. If ignored, it +behaves like +SA_NoAction +. + + + + + + + + + +SA_SwitchScreen + + + + num: INT8 + + + switchApp: BOOL + + + screenAbs: BOOL + + + + + + If the server supports this action and multiple screens or displays +(either virtual or real), this action changes to the active screen indicated by + +num + and +screenAbs +. If +screenAbs + is +True +, num specifies the index of the new screen; otherwise, num specifies an offset +from the current screen to the new screen. + + + + If +switchApp + is +False +, it should switch to another screen on the same server. Otherwise it should +switch to another X server or application which shares the same physical +display. + + + + This action is optional; servers are free to ignore the action or any +of its flags if they do not support the requested behavior. If the action is +ignored, it behaves like +SA_NoAction +, otherwise neither key press nor release generate an event. + + + + + + + + SA_SetControls + controls: KB_BOOLCTRLMASK + + + + + +Key press enables any boolean controls that are specified in +controls + and not already enabled at the time of the key press. Key release disables any +controls that were enabled by the corresponding key press. This action can +cause +XkbControlsNotify + events. + + + + + + + + SA_LockControls + + controls: KB_BOOLCTRLMASK + + + noLock: BOOL + + + noUnlock: BOOL + + + + + + If +noLock + is +False +, key press locks and enables any controls that are specified in +controls + and not already locked at the time of the key press. + + +If +noUnlock + is +False +, key release unlocks and disables any controls that are specified in +controls + and were not enabled at the time of the corresponding key press. + + + + + + + + + +SA_ActionMessage +: + pressMsg: BOOL + + + releaseMsg: BOOL + + + genEvent: BOOL + + + message: STRING + + + + + + if +pressMsg + is +True +, key press generates an +XkbActionMessage + event which reports the keycode, event type and the contents of +message +. + + + + If +releaseMsg + is +True +, key release generates an +XkbActionMessage + event which reports the keycode, event type and contents of +message +. + + + + If +genEvent + is +True +, both press and release generate key press and key release events, regardless +of whether they also cause an +XkbActionMessage +. + + + + + + + + + +SA_RedirectKey + + + + newKey: KEYCODE + + + modsMask: KEYMASK + + + mods: KEYMASK + + + vmodsMask: CARD16 + + + vmods: CARD16 + + + + + + Key press causes a key press event for the key specified by +newKey + instead of for the actual key. The state reported in this event reports of the +current effective modifiers changed as follow: Any real modifiers specified in + +modsMask + are set to corresponding values from +mods +. Any real modifiers bound to the virtual modifiers specified in +vmodsMask + are either set or cleared, depending on the corresponding value in +vmods +. If the real and virtual modifier definitions specify conflicting values for a +single modifier, the real modifier definition has priority. + + + + Key release causes a key release event for the key specified by + +newKey +; the state field for this event consists of the effective keyboard modifiers +at the time of the release, changed as described above. + + + + The +SA_RedirectKey + action normally redirects to another key on the same device as the key or +button which caused the event, unless that device does not belong to the input +extension KEYCLASS, in which case this action causes an event on the core +keyboard device. + + + + + + + + + +SA_DeviceBtn + + + + count: CARD8 + + + button: BUTTON + + + device: CARD8 + + + + + + The +device + field specifies the ID of an extension device; the +button + field specifies the index of a button on that device. If the button specified +by this action is logically down, the key press and corresponding release are +ignored and have no effect. If the device or button specified by this action +are illegal, this action behaves like +SA_NoAction +. + + + + Otherwise, key press causes one or more input extension device button +events instead of the usual key press event. If +count + is +0 +, key press generates a single +DeviceButtonPress + event; if +count + is greater than +0 +, key press generates +count + pairs of +DeviceButtonPress + and +DeviceButtonRelease + events. + + + + If +count + is +0 +, key release generates an input extension +DeviceButtonRelease + which matches the event generated by the corresponding key press; if count is +non-zero, key release does not cause a +DeviceButtonRelease + event. Key release never causes a key release event. + + + + + + + + + +SA_LockDeviceBtn + + + + button: BUTTON + + + device: CARD8 + + + noLock: BOOL + + + noUnlock: BOOL + + + + + + The +device + field specifies the ID of an extension device; the +button + field specifies the index of a button on that device. If the device or button +specified by this action are illegal, it behaves like +SA_NoAction +. + + + + Otherwise, if the specified button is not locked and if +noLock + is +False +, key press causes an input extension +DeviceButtonPress + event instead of a key press event and locks the button. If the button is +already locked or if +noLock + is +True +, key press is ignored and has no effect. + + + + If the corresponding key press was ignored, and if +noUnlock + is +False +, key release generates an input extension +DeviceButtonRelease + event instead of a core protocol or input extension key release event and +unlocks the specified button. If the corresponding key press locked a button, +key release is ignored and has no effect. + + + + + + + + + +SA_DeviceValuator + + + + +device +: CARD8 + + + +val1What +: SA_DVOP + + + +val1 +: CARD8 + + + +val1Value +: INT8 + + + +val1Scale +: 0...7 + + + +val2What +: BOOL + + + +val2 +: CARD8 + + + +val2Value +: INT8 + + + +val2Scale +: 0...7 + + + + + + The +device + field specifies the ID of an extension device; +val1 + and +val2 + specify valuators on that device. If +device + is illegal or if neither +val1 + nor +val2 + specifies a legal valuator, this action behaves like +SA_NoAction +. + + + + If +valn + specifies a legal valuator and +valnWhat + is not +SA_IgnoreVal +, the specified value is adjusted as specified by +valnWhat +: + + + + If +valnWhat + is +SA_SetValMin +, +valn + is set to its minimum legal value. + + + + If +valnWhat + is +SA_SetValCenter +, +valn + is centered (to (max-min)/2). + + + + If +valnWhat + is +SA_SetValMax +, +valn + is set to its maximum legal value. + + + + if +valnWhat + is +SA_SetValRelative +, + + + + + is added to +valn +. + + + + if +valnWhat + is +SA_SetValAbsolute +, +valn + is set to + + + + +. + + + + Illegal values for +SA_SetValRelative + or +SA_SetValAbsolute + are clamped into range. + + + + + + + + + + +If +StickyKeys + are enabled, all +SA_SetMods + and +SA_SetGroup + actions act like +SA_LatchMods + and +SA_LatchGroup + respectively. If the +LatchToLock + AccessX option is set, either action behaves as if both the +SA_ClearLocks + and +SA_LatchToLock + flags are set. + + + + +Actions which cause an event from another key or from a button on another +device immediately generate the specified event. These actions do not consider +the behavior or actions (if any) that are bound to the key or button to which +the event is redirected. + + + + +Core events generated by server actions contain the keyboard state that was in +effect at the time the key event occurred; the reported state does not reflect +any changes in state that occur as a result of the actions bound to the key +event that caused them. + + + + +Events sent to clients that have not issued an +XkbUseExtension + request contain a compatibility state in place of the actual XKB keyboard +state. See Effects of XKB on Core +Protocol Events for a description of this compatibility mapping. + + + + + +Delivering a Key or Button Event to a Client + + +The window and client that receive core protocol and input extension key or +button events are determined using the focus policy, window hierarchy and +passive grabs as specified by the core protocol and the input extension, with +the following changes: + + + + + A passive grab triggers if the modifier state specified in the grab +matches the grab compatibility state (described in Compatibility Components of Keyboard +State). Clients can choose to use the XKB grab state instead by setting +the +GrabsUseXKBState + per-client flag. This flag affects all passive grabs that are requested by the +client which sets it but does not affect passive grabs that are set by any +other client. + + + + The state field of events which trigger a passive grab reports the XKB +or compatibility grab state in effect at the time the grab is triggered; the +state field of the corresponding release event reports the corresponding grab +state in effect when the key or button is released. + + + + If the +LookupStateWhenGrabbed + per-client flag is set, all key or button events that occur while a keyboard +or pointer grab is active contain the XKB or compatibility lookup state, +depending on the value of the +GrabsUseXKBState + per-client flag. If +LookupStateWhenGrabbed + is not set, they include the XKB or compatibility grab state, instead. + + + + Otherwise, the state field of events that do not trigger a passive grab +report is derived from the XKB effective modifiers and group, as described in +Computing A State Field from an +XKB State. + + + + If a key release event is the result of an autorepeating key that is +being held down, and the client to which the event is reported has requested +detectable autorepeat (see +Detectable Autorepeat), the event is not delivered to the client. + + + + + +The following section explains the intent of the XKB interactions with core +protocol grabs and the reason that the per-client flags are needed. + + + + +XKB Interactions With Core Protocol Grabs + + +XKB provides the separate lookup and grab states to help work around some +difficulties with the way the core protocol specifies passive grabs. +Unfortunately, many clients work around those problems differently, and the way +that XKB handles grabs and reports keyboard state can sometimes interact with +those client workarounds in unexpected and unpleasant ways. + + + + +To provide more reasonable behavior for clients that are aware of XKB without +causing problems for clients that are unaware of XKB, this extension provides +two per-client flags that specify the way that XKB and the core protocol should +interact. + + + + + The largest problems arise from the fact that an XKB state field +encodes an explicit keyboard group in bits 13-14 (as described in Computing A State Field from an XKB +State), while pre-XKB clients use one of the eight keyboard modifiers +to select an alternate keyboard group. To make existing clients behave +reasonably, XKB normally uses the compatibility grab state instead of the XKB +grab state to determine whether or not a passive grab is triggered. XKB-aware +clients can set the +GrabsUseXKBState + per-client flag to indicate that they are specifying passive grabs using an +XKB state. + + + + Some toolkits start an active grab when a passive grab is triggered, in +order to have more control over the conditions under which the grab is +terminated. Unfortunately, the fact that XKB reports a different state in +events that trigger or terminate grabs means that this grab simulation can fail +to terminate the grab under some conditions. To work around this problem, XKB +normally reports the grab state in all events whenever a grab is active. +Clients which do not use active grabs like this can set the +LookupStateWhenGrabbed + per-client flag in order to receive the same state component whether or not a +grab is active. + + +The +GrabsUseXKBState + per-client flag also applies to the state of events sent while a grab is +active. If it is set, events during a grab contain the XKB lookup or grab +state; by default, events during a grab contain the compatibility lookup or +grab state. + + + + +The state used to trigger a passive grab is controlled by the setting of the + +GrabsUseXKBState + per-client flag at the time the grab is registered. Changing this flag does +not affect existing passive grabs. + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch07.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch07.xml new file mode 100644 index 0000000000000000000000000000000000000000..b5ffc6850c396c5fa6efcafb87ae1987531f56d5 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch07.xml @@ -0,0 +1,688 @@ + +Key Event Processing in the Client + + +The XKB +client map + for a keyboard is the collection of information a client needs to interpret +key events that come from that keyboard. It contains a global list of +key types +, described in Key Types, +and an array of +key symbol map +s, each of which describes the symbols bound to one particular key and the +rules to be used to interpret those symbols. + + + +Notation and Terminology + + +XKB associates a two-dimensional array of symbols with each key. Symbols are +addressed by keyboard group (see +Keyboard State) and shift level, where level is defined as in the +ISO9995 standard: + + + + + Level + + +One of several states (normally 2 or 3) which govern which graphic +character is produced when a graphic key is actuated. In certain cases the +level may also affect function keys. + + + + + + +Note that shift level is derived from the modifier state, but not necessarily +in the same way for all keys. For example, the +Shift + modifier selects shift level 2 on most keys, but for keypad keys the modifier +bound to +Num_Lock + (i.e. the +NumLock + virtual modifier) also selects shift level 2.gray symbols on a key + + + +We use the notation G +n +L +n + to specify the position of a symbol on a key or in memory: + + + + + + + + + +The gray characters indicate symbols that are implied or expected but are not +actually engraved on the key. + + +Unfortunately, the "natural" orientation of symbols on a key and +the natural orientation in memory are reversed from one another, so keyboard +group refers to a column on the key and a row in memory. There’s no real help +for it, but we try to minimize confusion by using "group" and "level" (or +"shift level") to refer to symbols regardless of context. + + + +Determining the KeySym Associated with a Key Event + + +To look up the symbol associated with an XKB key event, we need to know the +group and shift level that correspond to the event. + + + + +Group is reported in bits 13-14 of the state field of the key event, as +described in Computing A State +Field from an XKB State. The keyboard group reported in the event might +be out-of-range for any particular key because the number of groups can vary +from key to key. The XKB description of each key contains a +group info + field which is interpreted identically to the global groups wrap control (see +Computing Effective Modifier and +Group) and which specifies the interpretation of groups that are +out-of-range for that key. + + + + +Once we have determined the group to be used for the event, we have to +determine the shift level. The description of a key includes a +key type + for each group of symbols bound to the key. Given the modifiers from the key +event, this key type yields a shift level and a set of "leftover" modifiers, as +described in Key Types +below. + + + + +Finally, we can use the effective group and the shift level returned by the +type of that group to look up a symbol in a two-dimensional array of symbols +associated with the key. + + + + +Key Types + + +Each entry of a key type’s +map + field specifies the shift level that corresponds to some XKB modifier +definition; any combination of modifiers that is not explicitly listed +somewhere in the map yields shift level one. Map entries which specify unbound +virtual modifiers (see Inactive +Modifier Definitions) are not considered; each entry contains an +automatically-updated +active + field which indicates whether or not it should be used. + + + + +Each key type includes a few fields that are derived from the contents of the +map and which report some commonly used values so they don’t have to be +constantly recalculated. The +numLevels + field contains the highest shift level reported by any of its map entries; XKB +uses +numLevels + to insure that the array of symbols bound to a key is large enough (the number +of levels reported by a key type is also referred to as its width). The + +modifiers + field reports all real modifiers considered by any of the map entries for the +type. Both +modifiers + + +and +numLevels + are updated automatically by XKB and neither can be changed explicitly. + + + + +Any modifiers specified in +modifiers + are normally +consumed + (see Transforming the KeySym +Associated with a Key Event), which means that they are not considered +during any of the later stages of event processing. For those rare occasions +that a modifier +should + be considered despite having been used to look up a symbol, key types include +an optional +preserve + field. If a +preserve + list is present, each entry corresponds to one of the key type’s map entries +and lists the modifiers that should +not + be consumed if the matching map entry is used to determine shift level. + + + + +For example, the following key type implements caps lock as defined by the core +protocol (using the second symbol bound to the key): + + + +type "ALPHABETIC" { + modifiers = Shift+Lock; + map[Shift]= Level2; + map[Lock]= Level2; + map[Shift+Lock]= Level2; +}; + + + +The problem with this kind of definition is that we could assign completely +unrelated symbols to the two shift levels, and "Caps Lock" would choose the +second symbol. Another definition for alphabetic keys uses system routines to +capitalize the keysym: + + + +type "ALPHABETIC" { + modifiers= Shift; + map[Shift]= Level2; +}; + + + +When caps lock is applied using this definition, we take the symbol from shift +level one and capitalize it using system-specific capitalization rules. If +shift and caps lock are both set, we take the symbol from shift level two and +try to capitalize it, which usually has no effect. + + + + +The following key type implements shift-cancels-caps lock behavior for +alphabetic keys: + + + +type "ALPHABETIC" { + modifiers = Shift+Lock; + map[Shift] = Level2; + preserve[Lock]= Lock; +}; + + + +Consider the four possible states that can affect alphabetic keys: no +modifiers, shift alone, caps lock alone or shift and caps lock together. The +map contains no explicit entry for +None + (no modifiers), so if no modifiers are set, any group with this type returns +the first keysym. The map entry for +Shift + reports +Level2 +, so any group with this type returns the second symbol when +Shift + is set. There is no map entry for +Lock + alone, but the type specifies that the +Lock + modifier should be preserved in this case, so +Lock + alone returns the first symbol in the group but first applies the +capitalization transformation, yielding the capital form of the symbol. In the +final case, there is no map entry for +Shift+Lock +, so it returns the first symbol in the group; there is no preserve entry, so +the +Lock + modifier is consumed and the symbol is not capitalized. + + + + + +Key Symbol Map + + +The +key symbol map + for a key contains all of the information that a client needs to process +events generated by that key. Each key symbol mapping reports: + + + + + The number of groups of symbols bound to the key ( +numGroups +). + + + + The treatment of out-of-range groups ( +groupInfo +). + + + + The index of the key type to for each +possible + group ( +kt_index[MaxKbdGroups] +). + + + + The width of the widest type associated with the key ( +groupsWidth +). + + + + The two-dimensional (numGroups +× + groupsWidth) array of symbols bound to the key. + + + + + +It is legal for a key to have zero groups, in which case it also has zero +symbols and all events from that key yield +NoSymbol +. The array of key types is of fixed width and is large enough to hold key +types for the maximum legal number of groups ( +MaxKbdGroups +, currently four); if a key has fewer than +MaxKbdGroups + groups, the extra key types are reported but ignored. The +groupsWidth + field cannot be explicitly changed; it is updated automatically whenever the +symbols or set of types bound to a key are changed. + + + + +If, when looking up a symbol, the effective keyboard group is out-of-range for +the key, the +groupInfo + field of the key symbol map specifies the rules for determining the +corresponding legal group as follows: + + + + + If the +RedirectIntoRange + flag is set, the two least significant bits of +groupInfo + specify the index of a group to which all illegal groups correspond. If the +specified group is also out of range, all illegal groups map to +Group1 +. + + + + If +ClampIntoRange + flag is set, out-of-range groups correspond to the nearest legal group. +Effective groups larger than the highest supported group are mapped to the +highest supported group; effective groups less than +Group1 + are mapped to +Group1 +. For example, a key with two groups of symbols uses +Group2 + type and symbols if the global effective group is either +Group3 + or +Group4 +. + + + + If neither flag is set, group is wrapped into range using integer +modulus. For example, a key with two groups of symbols for which groups wrap +uses +Group1 + symbols if the global effective group is +Group3 + or +Group2 + symbols if the global effective group is +Group4 +. + + + + + +The client map contains an array of key symbol mappings, with one entry for +each key between the minimum and maximum legal keycodes, inclusive. All +keycodes which fall in that range have key symbol mappings, whether or not any +key actually yields that code. + + + + + + +Transforming the KeySym Associated with a Key Event + + +Any modifiers that were not used to look up the keysym, or which were +explicitly preserved, might indicate further transformations to be performed on +the keysym or the character string that is derived from it. For example, If the + +Lock + modifier is set, the symbol and corresponding string should be capitalized +according to the locale-sensitive capitalization rules specified by the system. +If the +Control + modifier is set, the keysym is not affected, but the corresponding character +should be converted to a control character as described in Default Symbol Transformations. + + + + +This extension specifies the transformations to be applied when the +Control + or +Lock + modifiers are active but were not used to determine the keysym to be used: + + + + + + + + + + Modifier + Transformation + + + + + +Control + + Report the control character associated with the symbol. This +extension defines the control characters associated with the ASCII alphabetic +characters (both upper and lower case) and for a small set of punctuation +characters (see +Default Symbol Transformations). +Applications are +free to associate control characters with any symbols that are not specified by +this extension. + + + +Lock + + Capitalize the symbol either according to capitalization rules +appropriate to the application locale or using the capitalization rules defined +by this extension (see Default Symbol Transformations). + + + + + + +Interpretation of other modifiers is application dependent. + + +This definition of capitalization is fundamentally different from +the core protocol’s, which uses the lock modifier to select from the symbols +bound to the key. Consider key 9 in the +client map example; +the core protocol provides no way to generate the capital form +of either symbol bound to this key. XKB specifies that we first look up the +symbol and then capitalize, so XKB yields the capital form of the two symbols +when caps lock is active. + + +XKB specifies the behavior of +Lock + and +Control +, but interpretation of other modifiers is left to the application. + + + + + +Client Map Example + + +Consider a simple, if unlikely, keyboard with the following keys (gray +characters indicate symbols that are implied or expected but are not actually +engraved on the key): + + + + + + + + + +The core protocol represents this keyboard as a simple array with one row per +key and four columns (the widest key, key 10, determines the width of the +entire array). + + + + + + + + + + + + + Key + G1L1 + G1L2 + G2L1 + G2L2 + + + + + 8 + Q + NoSymbol + at + NoSymbol + + + 9 + odiaeresis + egrave + NoSymbol + NoSymbol + + + 10 + A + NoSymbol + Æ + NoSymbol + + + 11 + ssharp + question + backslash + questiondown + + + 12 + KP_End + KP_1 + NoSymbol + NoSymbol + + + 13 + Num_Lock + NoSymbol + NoSymbol + NoSymbol + + + 14 + NoSymbol + NoSymbol + NoSymbol + NoSymbol + + + 15 + Return + NoSymbol + NoSymbol + NoSymbol + + + + + + +The row to be used for a given key event is determined by keycode; the column +to be used is determined by the symbols bound to the key, the state of the + +Shift + and +Lock + Modifiers and the state of the modifiers bound to the +Num_Lock + and +Mode_switch + keys as specified by the core protocol. + + + + +The XKB description of this keyboard consists of six key symbol maps, each of +which specifies the types and symbols associated with each keyboard group for +one key: + + + + + + + + + + + + Key + Group: Type + L1 + L2 + + + + + 8 + G1: ALPHABETIC + q + Q + + + G2: ONE_LEVEL + @ + NoSymbol + + + 9 + G1: TWO_LEVEL + odiaeresis + egrave + + + 10 + G1: ALPHABETIC + a + A + + + G2: ALPHABETIC + ae + AE + + + 11 + G1: TWO_LEVEL + ssharp + question + + + G2: ONE_LEVEL + backslash + questiondown + + + 12 + G1: KEYPAD + KP_End + KP_1 + + + 13 + G1: ONE_LEVEL + Num_Lock + + + + 14 + No Groups + + + + + 15 + G1: ONE_LEVEL + Return + + + + + + + +The keycode reported in a key event determines the row to be used for that +event; the effective keyboard group determines the list of symbols and key type +to be used. The key type determines which symbol is chosen from the list. + + + + +Determining the KeySym Associated +with a Key Event details the procedure to map from a key event to a +symbol and/or a string. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch08.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch08.xml new file mode 100644 index 0000000000000000000000000000000000000000..08524a8b10c731bad20fd2a1657df2ea937ab225 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch08.xml @@ -0,0 +1,157 @@ + +Symbolic Names + + +The core protocol does not provide any information to clients other than that +actually used to interpret events. This makes it difficult to write a client +which presents the keyboard to a user in an easy-to-understand way. Such +applications have to examine the vendor string and keycodes to determine the +type of keyboard connected to the server and have to examine keysyms and +modifier mappings to determine the effects of most modifiers (the +Shift +, +Lock + and +Control + modifiers are defined by the core protocol but no semantics are implied for +any other modifiers). + + + + +This extension provides such applications with symbolic names for most +components of the keyboard extension and a description of the physical layout +of the keyboard. + + + + +The +keycodes + name describes the range and meaning of the keycodes returned by the keyboard +in question; the +keyboard + +geometry +name describes the physical location, size and shape of the various keys on the +keyboard. As an example to distinguish between these two names, consider +function keys on PC-compatible keyboards. Function keys are sometimes above the +main keyboard and sometimes to the left of the main keyboard, but the same +keycode is used for the key that is logically +F1 + regardless of physical position. Thus, all PC-compatible keyboards might share +a keycodes name but different geometry names. + + +The keycodes name is intended to be a very general description of +the keycodes returned by a keyboard; A single keycodes name might cover +keyboards with differing numbers of keys provided that the keys that all keys +have the same semantics when present. For example, 101 and 102 key PC keyboards +might use the same name. Applications can use the keyboard geometry to +determine which subset of the named keyboard type is in use. + + +The +symbols + name identifies the symbols bound to the keys. The symbols name is a human or +application-readable description of the intended locale or usage of the +keyboard with these symbols. The +physical symbols + name describes the symbols actually engraved on the keyboard, which might be +different than the symbols currently being used. + + + + +The +types + name provides some information about the set of key types that can be +associated with the keyboard keys. The +compat + name provides some information about the rules used to bind actions to keys +changed using core protocol requests. + + + + +The +compat +, +types +, +keycodes +, +symbols + and +geometry + names typically correspond to the keyboard components from which the current +keyboard description was assembled. These components are stored individually in +the server’s database of keyboard components, described in + +The Server Database of Keyboard +Components, and can be combined to assemble a complete keyboard +description. + + + + +Each key has a four-byte symbolic name. The key name links keys with similar +functions or in similar positions on keyboards that report different scan +codes. +Key aliases + allow the keyboard layout designer to assign multiple names to a single key, +to make it easier to refer to keys using either their position +or + their "function." + + + + +For example, consider the common keyboard customizations: + + + + + Set the "key to the left of the letter a" to be a control key. + + + + Change the "caps lock" key, wherever it might be, to a control key. + + + + + +If we specify key names by position, the first customization is simple but the +second is impossible; if we specify key names by function, the second +customization is simple but the first is impossible. Using key aliases, we can +specify both function and position for "troublesome" keys, and both +customizations are straightforward. + + + + +Key aliases can be specified both in the symbolic names component and in the +keyboard geometry (see Keyboard +Geometry). Both sets of aliases are always valid, but key alias +definitions in the keyboard geometry have priority; if both symbolic names and +geometry include aliases, applications should consider the definitions from the +geometry before considering the definitions from the symbolic names section. + + + + +XKB provides symbolic names for each of the four keyboard groups, sixteen +virtual modifiers, thirty-two keyboard indicators, and up to +MaxRadioGroups + (32) radio groups. + + + + +XKB allows keyboard layout designers or editors to assign names to each key +type and to each of the levels in a key type. For example, the second position +on an alphabetic key might be called the "Caps" level while the second position +on a numeric keypad key might be called the "Num Lock" level. + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch09.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch09.xml new file mode 100644 index 0000000000000000000000000000000000000000..d5f587b75e97bea6d3a5dd76224fd73777e4eb75 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch09.xml @@ -0,0 +1,605 @@ + +Keyboard Indicators + + +Although the core X protocol supports thirty-two LEDs on a keyboard, it does +not provide any way to link the state of the LEDs and the logical state of the +keyboard. For example, most keyboards have a "Caps Lock" LED, but X does not +provide any standard way to make the LED automatically follow the logical state +of the modifier bound to the +Caps Lock + key. + + + + +The core protocol also gives no way to determine which bits in the +led_mask + field of the keyboard state map to the particular LEDs on the keyboard. For +example, X does not provide a method for a client to determine which bit to set +in the +led_mask + to turn on the "Scroll Lock" LED, or even if the keyboard has a "Scroll Lock" +LED. + + + + +Most X servers implement some kind of automatic behavior for one or more of the +keyboard LEDs, but the details of that automatic behavior are +implementation-specific and can be difficult or impossible to control. + + + + +XKB provides indicator names and programmable indicators to help solve these +problems. Using XKB, clients can determine the names of the various indicators, +determine and control the way that the individual indicators should be updated +to reflect keyboard changes, and determine which of the 32 keyboard indicators +reported by the protocol are actually present on the keyboard. Clients may also +request immediate notification of changes to the state of any subset of the +keyboard indicators, which makes it straightforward to provide an on-screen +"virtual" LED panel. + + + +Global Information About Indicators + + +XKB provides only two pieces of information about the indicators as a group. + + + + +The +physical indicators + mask reports which of the 32 logical keyboard indicators supported by the core +protocol and XKB corresponds to some actual indicator on the keyboard itself. +Because the physical indicators mask describes a physical characteristic of the +keyboard, it cannot be directly changed under program control. It is possible, +however, for the set of physical indicators to be change if a new keyboard is +attached or if a completely new keyboard description is loaded by the +XkbGetKeyboardByName + request (see Using the Server’s +Database of Keyboard Components). + + + + +The +indicator state + mask reports the current state of the 32 logical keyboard indicators. This +field and the core protocol indicator state (as reported by the +led-mask + field of the core protocol +GetKeyboardControl + request) are always identical. + + + + + +Per-Indicator Information + + +Each of the thirty-two keyboard indicators has a symbolic name, of type ATOM. +The +XkbGetNames + request reports the symbolic names for all keyboard components, including the +indicators. Use the +XkbSetNames + request to change symbolic names. Both requests are described in Querying and Changing Symbolic +Names. + + + + +Indicator Maps + + +XKB also provides an +indicator map + for each of the thirty-two keyboard indicators; an indicator map specifies: + + + + + The conditions under which the keyboard modifier state affects the +indicator. + + + + The conditions under which the keyboard group state affects the +indicator. + + + + The conditions under which the state of the boolean controls affects +the indicator. + + + + The effect (if any) of attempts to explicitly change the state of the +indicator using the core protocol +SetKeyboardControl + request. + + + + + +If +IM_NoAutomatic + is set in the +flags + field of an indicator map, that indicator never changes in response to changes +in keyboard state or controls, regardless of the values for the other fields of +the indicator map. If +IM_NoAutomatic + is not set in +flags +, the other fields of the indicator map specify the automatic changes to the +indicator in response to changes in the keyboard state or controls. + + + + +The +which_groups + and the +groups + fields of an indicator map determine how the keyboard group state affects the +corresponding indicator. The +which_groups + field controls the interpretation of +groups + and may contain any one of the following values: + + + + + + + + + + Value + Interpretation of the Groups Field + + + + + +IM_UseNone + + The +groups + field and the current keyboard group state are ignored. + + + +IM_UseBase + + If +groups + is non-zero, the indicator is lit whenever the base keyboard group is +non-zero. If +groups + is zero, the indicator is lit whenever the base keyboard group is zero. + + + +IM_UseLatched + + If +groups + is non-zero, the indicator is lit whenever the latched keyboard group is +non-zero. If +groups + is zero, the indicator is lit whenever the latched keyboard group is +zero. + + + +IM_UseLocked + + The +groups + field is interpreted as a mask. The indicator is lit when the current locked +keyboard group matches one of the bits that are set in +groups +. + + + +IM_UseEffective + + The +groups + field is interpreted as a mask. The indicator is lit when the current +effective keyboard group matches one of the bits that are set in +groups +. + + + + + + +The +which_mods + and +mods + fields of an indicator map determine how the state of the keyboard modifiers +affect the corresponding indicator. The +mods + field is an XKB modifier definition, as described in Modifier Definitions, which can +specify both real and virtual modifiers. The mods field takes effect even if +some or all of the virtual indicators specified in +mods + are unbound. + + + + +The +which_mods + field can specify one or more components of the XKB keyboard state. The +corresponding indicator is lit whenever any of the real modifiers specified in +the +mask + field of the +mods + modifier definition are also set in any of the current keyboard state +components specified by the +which_mods +. The +which_mods + field may have any combination of the following values: + + + + + + + + + + Value + Keyboard State Component To Be Considered + + + + + +IM_UseBase + + Base modifier state + + + +IM_UseLatched + + Latched modifier state + + + +IM_UseLocked + + Locked modifier state + + + +IM_UseEffective + + Effective modifier state + + + +IM_UseCompat + + Modifier compatibility state + + + + + + +The +controls + field specifies a subset of the boolean keyboard controls (see "Boolean" Controls and The +EnabledControls Control). The indicator is lit whenever any of the +boolean controls specified in +controls + are enabled. + + + + +An indicator is lit whenever any of the conditions specified by its indicator +map are met, unless overridden by the +IM_NoAutomatic + flag (described above) or an explicit indicator change (described below). + + + + +Effects of Explicit Changes on Indicators + + +If the +IM_NoExplicit + flag is set in an indicator map, attempts to change the state of the indicator +are ignored. + + + + +If both +IM_NoExplicit + and +IM_NoAutomatic + are both absent from an indicator map, requests to change the state of the +indicator are honored but might be immediately superseded by automatic changes +to the indicator state which reflect changes to keyboard state or controls. + + + + +If the +IM_LEDDrivesKB + flag is set and the +IM_NoExplicit + flag is not, the keyboard state and controls are changed to reflect the other +fields of the indicator map, as described in the remainder of this section. +Attempts to explicitly change the value of an indicator for which +IM_LEDDrivesKB + is absent or for which +IM_NoExplicit + is present do not affect keyboard state or controls. + + + + +The effect on group state of changing an explicit indicator which drives the +keyboard is determined by the value of +which_groups + and +groups +, as follows: + + + + + + + + + + + which_groups + New State + Effect on Keyboard Group State + + + + + +IM_UseNone +, or +IM_UseBase + + On or Off + No Effect + + + +IM_UseLatched + + On + The +groups + field is treated as a group mask. The keyboard group latch is changed to the +lowest numbered group specified in +groups +; if +groups + is empty, the keyboard group latch is changed to zero. + + + IM_UseLatched + Off + The +groups + field is treated as a group mask. If the indicator is explicitly extinguished, +keyboard group latch is changed to the lowest numbered group not specified in + +groups +; if +groups + is zero, the keyboard group latch is set to the index of the highest legal +keyboard group. + + + +IM_UseLocked +, or +IM_UseEffective + + On + If the +groups + mask is empty, group is not changed, otherwise the locked keyboard group is +changed to the lowest numbered group specified in +groups +. + + + +IM_UseLocked +, or +IM_UseEffective + + Off + Locked keyboard group is changed to the lowest numbered group that +is not specified in the +groups + mask, or to +Group1 + if the +groups + mask contains all keyboard groups. + + + + + + +The effect on the keyboard modifiers of changing an explicit indicator which +drives the keyboard is determined by the values that are set in of +which_mods + and +mods +, as follows: + + + + + + + + + + + Set in which_mods + New State + Effect on Keyboard Modifiers + + + + + +IM_UseBase + + On or Off + No Effect + + + +IM_UseLatched + + On + Any modifiers specified in the +mask + field of +mods + are added to the latched modifiers. + + + +IM_UseLatched + + Off + Any modifiers specified in the +mask + field of +mods + are removed from the latched modifiers. + + + +IM_UseLocked +, +IM_UseCompat +, or +IM_UseEffective + + On + Any modifiers specified in the +mask + field of +mods + are added to the locked modifiers. + + + +IM_UseLocked + + Off + Any modifiers specified in the +mask + field of +mods + are removed from the locked modifiers. + + + +IM_UseCompat +, or +IM_UseEffective + + Off + Any modifiers specified in the +mask + field of +mods + are removed from both the locked and latched modifiers. + + + + + + +Lighting an explicit indicator which drives the keyboard also enables all of +the boolean controls specified in the +controls + field of its indicator map. Explicitly extinguishing such an indicator +disables all of the boolean controls specified in +controls +. + + + + +The effects of changing an indicator which drives the keyboard are cumulative; +it is possible for a single change to affect keyboard group, modifiers and +controls simultaneously. + + + + +If an indicator for which both the +IM_LEDDrivesKB + and +IM_NoAutomatic + flags are specified is changed, the keyboard changes specified above are +applied and the indicator is changed to reflect the state that was explicitly +requested. The indicator will remain in the new state until it is explicitly +changed again. + + + + +If the +IM_NoAutomatic + flag is not set for an indicator which drives the keyboard, the changes +specified above are applied and the state of the indicator is set to the values +specified by the indicator map. Note that it is possible in this case for the +indicator to end up in a different state than the one that was explicitly +requested. For example, an indicator with +which_mods + of +IM_UseBase + and +mods + of +Shift + is not extinguished if one of the +Shift + keys is physically depressed when the request to extinguish the indicator is +processed. + + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch10.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch10.xml new file mode 100644 index 0000000000000000000000000000000000000000..74362b0a3f6b565ac039c21a250591617143a453 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch10.xml @@ -0,0 +1,174 @@ + +Keyboard Bells + + +The core protocol provides requests to control the pitch, volume and duration +of the keyboard bell and a request to explicitly sound the bell. + + + + +The X Keyboard Extension allows clients to disable the audible bell, attach a +symbolic name to a bell request or receive an event when the keyboard bell is +rung. + + + +Client Notification of Bells + + +Clients can ask to receive +XkbBellNotify + event when a bell is requested by a client or generated by the server. Bells +can be sounded due to core protocol +Bell + requests, X Input Extension +DeviceBell + requests, X Keyboard Extension +XkbBell + requests or for reasons internal to the server such as the XKB +AccessXFeedback + control. + + + + +Bell events caused by the +XkbBell + request or by the +AccessXFeedback + control include an optional window and symbolic name for the bell. If present, +the window makes it possible to provide some kind of visual indication of which +window caused the sound. The symbolic name can report some information about +the reason the bell was generated and makes it possible to generate a distinct +sound for each type of bell. + + + + + +Disabling Server Generated Bells + + +The global +AudibleBell + boolean control for a keyboard indicates whether bells sent to that device +should normally cause the server to generate a sound. Applications which +provide "sound effects" for the various named bells will typically disable the +server generation of bells to avoid burying the user in sounds. + + + + +When the +AudibleBell + control is active, all bells caused by core protocol +Bell + and X Input Extension +DeviceBell + requests cause the server to generate a sound, as do all bells generated by +the XKB +AccessXFeedback + control. Bells requested via the X +kbBell + request normally cause a server-generated sound, but clients can ask the +server not to sound the default keyboard bell. + + + + +When the +AudibleBell + control is disabled, the server generates a sound only for bells that are +generated using the +XkbBell + request and which specify forced delivery of the bell. + + + + + +Generating Named Bells + + +The +XkbBell + request allows clients to specify a symbolic name which is reported in the +bell events they cause. Bells generated by the +AccessXFeedback + control of this extension also include a symbolic name, but all kinds of +feedback cause a single event even if they sound multiple tones. + + + + +The X server is permitted to use symbolic bell names (when present) to generate +sounds other than simple tones, but it is not required to do so. + + + + +Aside from those used by the XKB +AccessXFeedback + control (see The AccessXFeedback +Control), this extension does not specify bell names or their +interpretation. + + + + + +Generating Optional Named Bells + + +Under some circumstances, some kind of quiet audio feedback is useful, but a +normal keyboard bell is not. For example, a quiet "launch effect" can be +helpful to let the user know that an application has been started, but a loud +bell would simply be annoying. + + + + +To simplify generation of these kinds of effects, the +XkbBell + request allows clients to specify "event only" bells. The X server never +generates a normal keyboard bell for "event only" bells, regardless of the +setting of the global +AudibleBell + control. + + + + +If the X server generates different sounds depending bell name, it is permitted +to generate a sound even for "event only" bells. This field is intended simply +to weed out "normal" keyboard bells. + + + + + +Forcing a Server Generated Bell + + +Occasionally, it is useful to force the server to generate a sound. For +example, a client could "filter" server bells, generating sound effects for +some but sounding the normal server bell for others. Such a client needs a way +to tell the server that the requested bell should be generated regardless of +the setting of the +AudibleBell + control. + + + + +To simplify this process, clients which call the +XkbBell + request can specify that a bell is forced. A forced bell always causes a +server generated sound and never causes a +XkbBellNotify + event. Because forced bells do not cause bell notify events, they have no +associated symbolic name or event window. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch11.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch11.xml new file mode 100644 index 0000000000000000000000000000000000000000..39361a47c31c6af350571576e99e673f2f7fb81f --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch11.xml @@ -0,0 +1,413 @@ + + +Keyboard Geometry + + +The XKB description of a keyboard includes an optional keyboard geometry which +describes the physical appearance of the keyboard. Keyboard geometry describes +the shape, location and color of all keyboard keys or other visible keyboard +components such as indicators. The information contained in a keyboard geometry +is sufficient to allow a client program to draw an accurate two-dimensional +image of the keyboard. + + + + +The components of the keyboard geometry include the following: + + + + + A +symbolic name + to help users identify the keyboard. + + + + The +width + and +height + of the keyboard, in + + + +. For non-rectangular keyboards, the width and height describe the smallest +bounding-box that encloses the outline of the keyboard. + + + + A list of up to +MaxColors + ( +32 +) +color names +. A color name is a string whose interpretation is not specified by XKB. Other +geometry components refer to colors using their indices in this list. + + + + The + base color + of the keyboard is the predominant color on the keyboard and is used as the +default color for any components whose color is not explicitly specified. + + + + The +label color + is the color used to draw the labels on most of the keyboard keys. + + + + The +label font + is a string which describes the font used to draw labels on most keys; XKB +does not specify a format or name space for font names. + + + + A list of +geometry properties +. A geometry property associates an arbitrary string with an equally arbitrary +name. Geometry properties can be used to provide hints to programs that display +images of keyboards, but they are not interpreted by XKB. No other geometry +structures refer to geometry properties. + + + + A list of +key aliases +, as described in Symbolic +Names. + + + + A list of +shapes +; other keyboard components refer to shapes by their index in this list. A +shape consists of a name and one or more closed-polygons called +outlines +. Shapes and outlines are described in detail in Shapes and Outlines. + + + + + +Unless otherwise specified, geometry measurements are in + + + + + units. The origin (0,0) is in the top left corner of the keyboard image. Some +geometry components can be drawn rotated; all such objects rotate about their +origin in + + + + + increments. + + + + +All geometry components include a +priority +, which indicates the order in which overlapping objects should be drawn. +Objects are drawn in order from highest priority ( +0 +) to lowest ( +255 +). + + + + +The description of the actual appearance of the keyboard is subdivided into +named +sections + of related keys and +doodads +. A a +doodad + describes some visible aspect of the keyboard that is not a key. A section is +a collection of keys and doodads that are physically close together and +logically related. + + + +Shapes and Outlines + + +An outline is a list of one or more points which describes a single +closed-polygon, as follows: + + + + + A list with a single point describes a rectangle with one corner at the +origin of the shape ( +0 +, +0 +) and the opposite corner at the specified point. + + + + A list of two points describes a rectangle with one corner at the +position specified by the first point and the opposite corner at the position +specified by the second point. + + + + A list of three or more points describes an arbitrary polygon. If +necessary, the polygon is automatically closed by connecting the last point in +the list with the first. + + + + A non-zero value for the +cornerRadius + field specifies that the corners of the polygon should be drawn as circles +with the specified radius. + + + + + +All points in an outline are specified relative to the origin of the enclosing +shape. Points in an outline may have negative values for the X and Y coordinate. + + + + +One outline (usually the first) is the primary outline; a keyboard display +application can generate a simpler but still accurate keyboard image by +displaying only the primary outlines for each shape. Non-rectangular keys must +include a rectangular +approximation + as one of the outlines associated with the shape; the approximation is not +normally displayed but can be used by very simple keyboard display applications +to generate a recognizable but degraded image of the keyboard. + + + + + +Sections + + +Each section has its own coordinate system — if a section is rotated, the +coordinates of any components within the section are interpreted relative to +the edges that were on the top and left before rotation. The components that +make up a section include: + + + + + A list of +rows +. A row is a list of horizontally or vertically adjacent keys. Horizontal rows +parallel the (pre-rotation) top of the section and vertical rows parallel the +(pre-rotation) left of the section. All keys in a horizontal row share a common +top coordinate; all keys in a vertical row share a left coordinate. + + +A key description consists of a key +name +, a +shape +, a key +color +, and a +gap +. The key +name + should correspond to one of the keys named in the keyboard names description, +the +shape + specifies the appearance of the key, and the key +color + specifies the color of the key (not the label on the key). Keys are normally +drawn immediately adjacent to one another from left-to-right (or top-to-bottom) +within a row. The +gap + field specifies the distance between a key and its predecessor. + + + + An optional list of doodads; any type of doodad can be enclosed within +a section. Position and angle of rotation are relative to the origin and angle +of rotation of the sections that contain them. Priority is relative to the +other components of the section, not to the keyboard as a whole. + + + + An optional list of +overlay keys +. Each overlay key definition indicates a key that can yield multiple scan +codes and consists of a field named +under +, which specifies the primary name of the key and a field named +over +, which specifies the name for the key when the overlay keycode is selected. +The key specified in +under + must be a member of the section that contains the overlay key definition, +while the key specified in over must not. + + + + + + +Doodads + + +Doodads can be global to the keyboard or part of a section. Doodads have +symbolic names of arbitrary length. The only doodad name whose interpretation +is specified by XKB is "Edges", which describes the outline of the entire +keyboard, if present. + + + + +All doodads report their origin in fields named +left + and +top +. XKB supports five kinds of doodads: + + + + + An +indicator doodad + describes one of the physical keyboard indicators. Indicator doodads specify +the shape of the indicator, the indicator color when it is lit ( +on_color +) and the indicator color when it is dark ( +off_color +). + + + + An +outline doodad + describes some aspect of the keyboard to be drawn as one or more hollow, +closed polygons. Outline doodads specify the shape, color, and angle of +rotation about the doodad origin at which they should be drawn. + + + + A +solid doodad + describes some aspect of the keyboard to be drawn as one or more filled +polygons. Solid doodads specify the shape, color and angle of rotation about +the doodad origin at which they should be drawn. + + + + A +text doodad + describes a text label somewhere on the keyboard. Text doodads specify the +label string, the font and color to use when drawing the label, and the angle +of rotation of the doodad about its origin. + + + + A +logo doodad + is a catch-all, which describes some other visible element of the keyboard. A +logo doodad is essentially an outline doodad with an additional symbolic name +that describes the element to be drawn. + + +If a keyboard display program recognizes the symbolic name, it can draw +something appropriate within the bounding region of the shape specified in the +doodad. If the symbolic name does not describe a recognizable image, it should +draw an outline using the specified shape, outline, and angle of rotation. + + +The XKB extension does not specify the interpretation of logo names. + + + + + + +Keyboard Geometry Example + + +Consider the following example keyboard: + + + + + + + + + + +This keyboard has six sections: The left and right function sections (at the +very top) each have one horizontal row with eight keys. The left and right +alphanumeric sections (the large sections in the middle) each have six vertical +rows, with four or five keys in each row. The left and right editing sections +each have three vertical rows with one to three keys per row; the left editing +section is rotated 20° clockwise about its origin while the right editing +section is rotated 20° counterclockwise. + + + + +This keyboard has four global doodads: Three small, round indicators and a +rectangular logo. The program which generated this image did not recognize the +logo, so it displays an outline with an appropriate shape in its place. + + + + +This keyboard has seven shapes: All of the keys in the two function sections +use the "FKEY" shape. Most of the keys in the alphanumeric sections, as well as +four of the keys in each of the editing sections use the "NORM" shape. The keys +in the first column of the left alphanumeric section and the last column of the +right alphanumeric section all use the "WIDE" shape. Two keys in each of the +editing sections use the "TALL" shape. The "LED" shape describes the three +small, round indicators between the function and alphabetic sections. The +"LOGO" shape describes the keyboard logo, and the "EDGE" shape describes the +outline of the keyboard as a whole. + + + + +The keyboard itself is white, as are all of the keys except for the eight keys +that make up the home row, which use the "grey20" color. It isn’t really +visible in this picture, but the three indicators have an "on" color of "green" +and are "green30" when they are turned off. The keys in the alphanumeric and +editing sections all have a (vertical) gap of 0.5mm; the keys in the two +function sections have a (horizontal) gap of 3mm. + + + + +Many of the keys in the right alphanumeric section, and the rightmost key in +the right editing section are drawn with two names in this image. Those are +overlay keys; the bottom key name is the normal name while the overlay name is +printed at the top. For example, the right editing section has a single overlay +key entry, which specifies an +under + name of +<SPCE> + and an +over + name of +<KP0> +, which indicates that the key in question is usually the shift key, but can +behave like the +0 + key on the numeric keypad when an overlay is active. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch12.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch12.xml new file mode 100644 index 0000000000000000000000000000000000000000..efc6d6a2ca63725247d43161eea3e8f6b42cd5c1 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch12.xml @@ -0,0 +1,1024 @@ + + +Interactions Between XKB and the Core Protocol + + +In addition to providing a number of new requests, XKB replaces or extends +existing core protocol requests and events. Some aspects of the this extension, +such as the ability to lock any key or modifier, are visible even to clients +that are unaware of the XKB extension. Other capabilities, such as control of +keysym selection on a per-key basis, are available only to XKB-aware clients. + + + + +Though they do not have access to some advanced extension capabilities, the XKB +extension includes compatibility mechanisms to ensure that non-XKB clients +behave as expected and operate at least as well with an XKB-capable server as +they do today. + + + + +There are a few significant areas in which XKB state and mapping differences +might be visible to XKB-unaware clients: + + + + + The core protocol uses a modifier to choose between two keyboard +groups, while this extension provides explicit support for multiple groups. + + + + The order of the symbols associated with any given key by XKB might not +match the ordering demanded by the core protocol. + + + + + +To minimize problems that might result from these differences, XKB includes +ways to specify the correspondence between core protocol and XKB modifiers and +symbols. + + + + +This section describes the differences between the core X protocol’s notion +of a keyboard mapping and XKB and explains the ways they can interact. + + + +Group Compatibility Map + + +As described in Keyboard +State, the current keyboard group is reported to XKB-aware clients in +bits 13-14 of the state field of many core protocol events. XKB-unaware clients +cannot interpret those bits, but they might use a keyboard modifier to +implement support for a single keyboard group. To ensure that pre-XKB clients +continue to work when XKB is present, XKB makes it possible to map an XKB state +field, which includes both keyboard group and modifier state into a pre-XKB +state field which contains only modifiers. + + + + +A keyboard description includes one +group compatibility map + per keyboard group (four in all). Each such map is a modifier definition (i.e. +specifies both real and virtual modifiers) which specifies the modifiers to be +set in the compatibility states when the corresponding keyboard group is +active. Here are a few examples to illustrate the application of the group +compatibility map: + + + + + + + + + + + + + + Group + GroupCompat Map + Effective Modifiers + State for XKB Clients + Compatibility Modifiers + State for non-XKB Clients + + + + + 1 + Group1=None + Shift + x00xxxxx00000001 + Shift + xxxxxxxx00000001 + + + 2 + Group2=Mod3 + None + x01xxxxx00000000 + Mod3 + xxxxxxxx00100000 + + + 3 + Group3=Mod2 + Shift + x10xxxxx00000001 + Shift+Mod2 + xxxxxxxx00010001 + + + 4 + Group4=None + Control + x11xxxxx00000100 + Control + xxxxxxxx00000100 + + + + + + +Note that non-XKB clients (i.e. clients that are linked with a version of the X +library that does not support XKB) cannot detect the fact that +Group4 + is active in this example because the group compatibility map for +Group4 + does not specify any modifiers. + + + + +Setting a Passive Grab for an XKB State + + +The fact that the +state + field of an event might look different when XKB is present can cause problems +with passive grabs. Existing clients specify the modifiers they wish to grab +using the rules defined by the core protocol, which use a normal modifier to +indicate keyboard group. If we used an XKB state field, the high bits of the +state field would be non-zero whenever the keyboard was in any group other than + +Group1 +, and none of the passive grabs set by clients could ever be triggered. + + + + +To avoid this behavior, the X server normally uses the compatibility grab state +to decide whether or not to activate a passive grab, even for XKB-aware +clients. The group compatibility map attempts to encode the keyboard group in +one or more modifiers of the compatibility state, so existing clients continue +to work exactly the way they do today. By default, there is no way to directly +specify a keyboard group in a +Grabbed + or +GrabButton + request, but groups can be specified indirectly by correctly adjusting the +group compatibility map. + + + + +Clients that wish to specify an XKB keyboard state, including a separate +keyboard group, can set the +GrabsUseXKBState + per-client flag which indicates that all subsequent key and button grabs from +the requesting clients are specified using an XKB state. + + + + +Whether the XKB or core state should be used to trigger a grab is determined by +the setting of the +GrabsUseXKBState + flag for the requesting client at the time the key or button is grabbed. There +is no way to change the state to be used for a grab that is already registered +or for grabs that are set by some other client. + + + + + + +Changing the Keyboard Mapping Using the Core Protocol + + +An XKB keyboard description includes a lot of information that is not present +in the core protocol description of a keyboard. Whenever a client remaps the +keyboard using core protocol requests, XKB examines the map to determine likely +default values for the components that cannot be specified using the core +protocol. + + + + +Some aspects of this automatic mapping are configurable, and make it fairly +easy to take advantage of many XKB features using existing tools like +xmodmap +, but much of the process of mapping a core keyboard description into an XKB +description is designed to preserve compatible behavior for pre-XKB clients and +cannot be redefined by the user. Clients or users that want behavior that +cannot be described using this mapping should use XKB functions directly. + + + + +Explicit Keyboard Mapping Components + + +This automatic remapping might accidentally replace definitions that were +explicitly requested by an application, so the XKB keyboard description defines +a set of +explicit components + for each key; any components that are listed in the explicit components for a +key are not changed by the automatic keyboard mapping. The explicit components +field for a key can contain any combination of the following values: + + + + + + + + + + Bit in Explicit Mask + Protects Against + + + + + ExplicitKeyType1 + Automatic determination of the key type associated with +Group1 + (see Assigning Types To Groups of +Symbols for a Key) + + + ExplicitKeyType2 + Automatic determination of the key type associated with +Group2 +(see Assigning Types To Groups of +Symbols for a Key) + + + ExplicitKeyType3 + Automatic determination of the key type associated with +Group3 +(see Assigning Types To Groups of +Symbols for a Key). + + + ExplicitKeyType4 + Automatic determination of the key type associated with +Group4 +(see Assigning Types To Groups of +Symbols for a Key). + + + ExplicitInterpret + Application of any of the fields of a symbol interpretation to the +key in question (see Assigning +Actions To Keys). + + + ExplicitAutoRepeat + Automatic determination of autorepeat status for the key, as +specified in a symbol interpretation (see Assigning Actions To +Keys). + + + ExplicitBehavior + Automatic assignment of the +KB_Lock + behavior to the key, if the +LockingKey + flag is set in a symbol interpretation (see Assigning Actions To +Keys). + + + ExplicitVModMap + Automatic determination of the virtual modifier map for the key +based on the actions assigned to the key and the symbol interpretations which +match the key (see Assigning +Actions To Keys). + + + + + + + +Assigning Symbols To Groups + + +The first step in applying the changes specified by a core protocol +ChangeKeyboardMapping + request to the XKB description of a keyboard is to determine the number of +groups that are defined for the key and the width of each group. The XKB +extension does not change key types in response to core protocol +SetModifierMapping + requests, but it does choose key actions as described in Assigning Actions To Keys. + + + + +Determining the number of symbols required for each group is straightforward. +If the key type for some group is not protected by the corresponding +ExplicitKeyType + component, that group has two symbols. If any of the explicit components for +the key include +ExplicitKeyType3 + or +ExplicitKeyType4 +, the width of the key type currently assigned to that group determines the +number of symbols required for the group in the core protocol keyboard +description. The explicit type components for +Group1 + and +Group2 + behave similarly, but for compatibility reasons the first two groups must have +at least two symbols in the core protocol symbol mapping. Even if an explicit +type assigned to either of the first two keyboard groups has fewer than two +symbols, XKB requires two symbols for it in the core keyboard description. + + + + +If the core protocol request contains fewer symbols than XKB needs, XKB adds +trailing +NoSymbol + keysyms to the request to pad it to the required length. If the core protocol +request includes more symbols than it needs, XKB truncates the list of keysyms +to the appropriate length. + + + + +Finally, XKB divides the symbols from the (possibly padded or truncated) list +of symbols specified by the core protocol request among the four keyboard +groups. In most cases, the symbols for each group are taken from the core +protocol definition in sequence (i.e. the first pair of symbols is assigned to + +Group1 +, the second pair of symbols is assigned to +Group2 +, and so forth). If either +Group1 + or +Group2 + has an explicitly defined key type with a width other than two, it gets a +little more complicated. + + + + +Assigning Symbols to Groups One and Two with Explicitly Defined Key Types + + +The server assigns the first four symbols from the expanded or truncated map to +the symbol positions G1L1 , G1L2, +G2L1 and G2L2, respectively. If the key +type assigned to Group1 reports more than two shift levels, +the fifth and following symbols contain +the extra keysyms for +Group2 +. If the key type assigned to +Group2 + reports more than two shift levels, the extra symbols follow the symbols (if +any) for +Group1 + in the core protocol list of symbols. Symbols for +Group3 + and +Group4 + are contiguous and follow the extra symbols, if any, for +Group1 + and +Group2 +. + + + + +For example, consider a key with a key type that returns three shift levels +bound to each group. The symbols bound to the core protocol are assigned in +sequence to the symbol positions: + + + +G1L1, G1L2, G2L1, G2L2, G1L3, G2L3, G3L1, G3L2, G3L3, G4L1, G4L2, and G4L3 + + + +For a key with a width one key type on group one, a width two key type on group +two and a width three key type on group three, the symbols bound to the key by +the core protocol are assigned to the following key positions: + + + +G1L1, (G1L2), G2L1, G2L2, G3L1, G3L2, G3L3 + + + +Note that the second and fourth symbols (positions +G1L2 and G2L2 +) can never be generated if the key type associated with the group yields only +one symbol. XKB accepts and ignores them in order to maintain compatibility +with the core protocol. + + + + + + +Assigning Types To Groups of Symbols for a Key + + +Once the symbols specified by +ChangeKeyboardMapping + have been assigned to the four keyboard groups for a key, the X server assigns +a key type to each group on the key from a canonical list of key types. The +first four key types in any keyboard map are reserved for these standard key +types: + + + + + + + + + + Key Type Name + Standard Definition + + + + + +ONE_LEVEL + + Describes keys that have exactly one symbol per group. Most special +or function keys (such as +Return +) are +ONE_LEVEL + keys. Any combination of modifiers yields level +0 +. Index +0 + in any key symbol map specifies key type +ONE_LEVEL +. + + + +TWO_LEVEL + + Describes non-keypad and non-alphabetic keys that have exactly two +symbols per group. By default, the +TWO_LEVEL + type yields column +1 + if the Shift modifier is set, column +0 + otherwise. Index +1 + in any key symbol map specifies key type +TWO_LEVEL +. + + + +ALPHABETIC + + Describes alphabetic keys that have exactly two symbols per group. +The default definition of the +ALPHABETIC + type provides shift-cancels-caps behavior as described in Key Types. Index +2 + in any key symbol map specifies key type +ALPHABETIC +. + + + +KEYPAD + + Describes numeric keypad keys with two symbols per group. Yields +column +1 + if either of the +Shift + modifier or the real modifier bound to the virtual modifier named +NumLock + are set. Yields column +0 + if neither or both modifiers are set. Index +3 + in any key symbol map specifies key type +KEYPAD +. + + + + + + +Users or applications may change these key types to get different default +behavior (to make shift cancel caps lock, for example) but they must always +have the specified number of symbols per group. + + + + +Before assigning key types to groups, the X server expands any alphanumeric +symbol definitions as follows: + + + + +If the second symbol of either group is +NoSymbol + and the first symbol of that group is an alphabetic keysym for which both +lowercase and uppercase forms are defined, the X server treats the key as if +the first element of the group were the lowercase form of the symbol and the +second element were the uppercase form of the symbol. For the purposes of this +expansion, XKB ignores the locale and uses the capitalization rules defined in +Default Symbol Transformations. + + + + +For each keyboard group that does not have an explicit type definition, XKB +chooses a key type from the canonical key types. If the second symbol assigned +to a group is +NoSymbol + (after alphabetic expansion), the server assigns key type +ONE_LEVEL +. If the group contains the lowercase and uppercase forms of a single glyph +(after alphanumeric expansion), the server assigns key type +ALPHABETIC +. If either of the symbols in a group is a numeric keypad keysym ( +KP_* +), the server assigns key type +KEYPAD +. Otherwise, it assigns key type +TWO_LEVEL +. + + + + +Finally, XKB determines the number of groups of symbols that are actually +defined for the key. Trailing empty groups (i.e. groups that have +NoSymbol + in all symbol positions) are ignored. + + + + +There are two last special cases for compatibility with the core protocol: If, +after trailing empty groups are excluded, all of the groups of symbols bound to +the key have identical type and symbol bindings, XKB assigns only one group to +the key. If +Group2 + is empty and either of +Group3 + or +Group4 + are not, and if neither +Group1 + nor +Group2 + have explicit key types, XKB copies the symbols and key type from +Group1 + into +Group2 +. + + + + + +Assigning Actions To Keys + + +Once symbols have been divided into groups and key types chosen for the keys +affected by a +ChangeKeyboardMapping + request, XKB examines the symbols and modifier mapping for each changed key +and assigns server actions where appropriate. XKB also automatically assigns +server actions to changed keys if the client issues a core protocol +SetModifierMapping + request, and does so optionally in response to +XkbSetMap + and +XkbSetCompatMap + requests. + + + + +The compatibility map includes a list of +symbol interpretations +, which XKB compares to each symbol associated with any changed keys in turn, +unless the +ExplicitInterp + component is set for a key. Setting the +ExplicitInterp + component prevents the application of symbol interpretations to that key. + + + + +If the modifiers and keysym specified in a symbol interpretation match the +modifier mapping and a symbol bound to a changed key that is not protected by + +ExplicitInterp +, the server applies the symbol interpretation to the symbol position. The +server considers all symbol interpretations which specify an explicit keysym +before considering any that do not. The server uses the first interpretation +which matches the given combination of keysym and modifier mapping; other +matching interpretations are ignored. + + + + +XKB uses four of the fields of a symbol interpretation to decide if it matches +one of the symbols bound to some changed key: + + + + + The +symbol + field is a keysym which matches if it has the value +NoSymbol + or is identical to the symbol in question. + + + + The modifiers specified in the +mods + field are compared to the modifiers affected by the key in question as +indicated by +match +. + + + + The +match + field can specify any of the comparisons: +NoneOf +, +AnyOfOrNone +, +AnyOf +, +AllOf + or +Exactly +. + + + + The +levelOneOnly + setting, indicates that the interpretation in question should only use the +modifiers bound to this key by the modifier mapping if the symbol that matches +in level one of its group. Otherwise, if the symbol being considered is not in +shift level one of its group, the server behaves as if the modifier map for the +key were empty. Note that it is still possible for such an interpretation to +apply to a symbol in a shift level other than one if it matches a key without +modifiers; the +levelOneOnly + flag only controls the way that matches are determined and that the key +modifiers are applied when an interpretation does match. + + + + + +Applying a symbol interpretation can affect several aspects of the XKB +definition of the key symbol mapping to which it is applied: + + + + + The +action + specified in the symbol interpretation is bound to the symbol position; any +key event which yields that symbol will also activate the new action. + + + + If the matching symbol is in position G1L1, the autorepeat behavior of +the key is set from the +autorepeat + field of the symbol interpretation. The +ExplicitAutoRepeat + component protects the autorepeat status of a key from symbol interpretation +initiated changes. + + + + If the symbol interpretation specifies an associated virtual modifier, +that virtual modifier is added to the virtual modifier map for the key. The + +ExplicitVModMap + component guards the virtual modifier map for a key from automatic changes. If +the +levelOneOnly + flag is set for the interpretation, and the symbol in question is not in +position G1L1, the virtual modifier map is not updated. + + + + If the matching symbol is in position G1L1, and the +locking key + field is set in the symbol interpretation, the behavior of the key is changed +to +KB_Lock + (see Key Behavior). The + +ExplicitBehavior + component prevents this change. + + + + + +If no interpretations match a given symbol or key, the server uses: +SA_NoAction +, autorepeat enabled, non-locking key. with no virtual modifiers. + + + + +If all of the actions computed for a key are +SA_NoAction +, the server assigns an length zero list of actions to the key. + + + + +If the core protocol modifier mapping is changed, the server regenerates +actions for the affected keys. The +XkbSetMap + and +XkbSetCompatMap + requests can also cause actions for some or all keyboard keys to be recomputed. + + + + + +Updating Everything Else + + +Changes to the symbols or modifier mapping can affect the bindings of virtual +modifiers. If any virtual modifiers change, XKB updates all of its data +structures to reflect the change. Applying virtual modifier changes to the +keyboard mapping night result in changes to types, the group compatibility map, +indicator maps, internal modifiers or ignore locks modifiers. + + + + + + +Effects of XKB on Core Protocol Events + + +After applying server actions which modify the base, latched or locked modifier +or group state of the keyboard, the X server recomputes the effective group and +state. Several components of the keyboard state are reported to XKB-aware +clients depending on context (see +Keyboard State for a detailed description of each of the keyboard state +components): + + + + + The effective modifier state is reported in +XkbStateNotify + events and in response to +XkbGetState + requests. + + + + The symbol lookup state is reported to XKB-aware clients in the state +field of core protocol and input extension key press and release events that do +not activate passive grabs. Unless the +LookupStateWhenGrabbed + per-client flag is set, the lookup state is only reported in these events when +no grabs are active. + + + + The grab state is reported to XKB-aware clients in the state field of +all core protocol events that report keyboard state, except +KeyPress + and +KeyRelease + events that do not activate passive grabs. + + + + The effective group is the sum of the base, latched and locked keyboard +groups. An out of range effective group is wrapped or truncated into range +according to the setting of the +groupsWrap + flag for the keyboard. + + + + + +The server reports compatibility states to any clients that have not issued a +successful +XkbUseExtension + request. The server computes the compatibility symbol lookup state and the +compatibility effective grab state by applying the compatibility modifier map +to the corresponding computed XKB states. + + + + +The compatibility symbol lookup state is reported to non-XKB clients whenever +an XKB-aware client would receive the XKB lookup state. The compatibility grab +state is reported to XKB-unaware clients whenever an XKB client would receive +the XKB grab state. + + + + +If the +GrabsUseXKBState + per-client option is not set, even XKB-aware clients receive the compatibility +grab state in events that trigger or terminate passive grabs. If this flag is +not set, XKB clients also receive the compatibility grab or lookup state +whenever any keyboard grab is active. + + + + +If the +LookupStateWhenGrabbed + per-client option is set, clients receive either the XKB or compatibility +lookup state when the keyboard is grabbed, otherwise they receive either the +XKB or compatibility grab state. All non-XKB clients receive the compatibility +form of the appropriate state component; the form that is sent to an XKB-aware +client depends on the setting of the +GrabsUseXKBState + option for that client. + + + + + +Effect of XKB on Core Protocol Requests + + +Whenever a client updates the keyboard mapping using a core protocol request, +the server saves the requested core protocol keyboard mapping and reports it to +any clients that issue +GetKeyboardMapping + or +GetModifierMapping + requests. Whenever a client updates the keyboard mapping using XKB requests, +the server discards the affected portion of the stored core keyboard +description and regenerates it based on the XKB description of the keyboard. + + + + +The symbols associated with the XKB keyboard description appear in the order: + + + +G1L1 G1L2 G2L1 G2L2 G1L3-n G2L3-n G3L* G4L* + + + +If the type associated with +Group1 + is width one, the second symbol is +NoSymbol +; if the type associated with +Group2 + is width one, the fourth symbol is +NoSymbol +. + + + + +If a key has only one group but the keyboard has several, the symbols for + +Group1 + are repeated for each group. For example, given a keyboard with three groups +and a key with one group that contains the symbols { +a A + }, the core protocol description would contain the six symbols: { +a + +A + +a + +A + +a + +A + }. As a slightly more complicated example, an XKB key which had a single width +three group with the symbols { +a + +b + +c + } would show up in the generated core protocol keyboard description with the +symbols { +a + +b + +a + +b + +c + +c + +a + +b + +c + } for a keyboard with three groups. + + + + +The generated modifier mapping for a key contains all of the modifiers affected +by all of the actions associated with the key plus all of the modifiers +associated with any virtual modifiers bound to the key by the virtual modifier +mapping. If any of the actions associated with a key affect any component of +the keyboard group, any modifiers specified in any entry of the group +compatibility map (see Group +Compatibility Map) are reported in the modifier mask. The +SA_ISOLock + action can theoretically affect any modifier, but the modifier map of an + +SA_ISOLock + key contains only the modifiers or group state that it sets by default. + + + + +The server notifies interested clients of keyboard map changes in one of two +ways. It sends +XkbMapNotify + to clients that have explicitly selected them and core protocol +MappingNotify + events to clients that have not. Once a client requests +XkbMapNotify + events, the server stops sending it +MappingNotify + events to inform it of keyboard changes. + + + + + +Sending Events to Clients + + +XKB normally assumes that events sent to clients using the core protocol + +SendEvent + request contain a core protocol state, if applicable. If the client which will +receive the event is not XKB-capable, XKB attempts to convert the core state to +an XKB state as follows: if any of the modifiers bound to +Group2 + in the group compatibility map are set in the event state, XKB clears them in +the resulting event but sets the effective group in the event state to + +Group2 +. + + + + +If the +PCF_SendEventUsesXKBState + per-client flag is set at the time of the SendEvent request, XKB instead +assumes that the event reported in the event is an XKB state. If the receiving +client is not XKB-aware, the extension converts the XKB state (which contains +the effective state in bits 13-14) to a core state by applying the group +compatibility map just as it would for actual key events. + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch13.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch13.xml new file mode 100644 index 0000000000000000000000000000000000000000..25fa96dd95a8a223bcaa929d655808765bee9b8e --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch13.xml @@ -0,0 +1,442 @@ + +The Server Database of Keyboard Components + + +The X server maintains a database of keyboard components and common keyboard +mappings. This database contains five kinds of components; when combined, these +five components provide a complete description of a keyboard and its behavior. + + + + +The X Keyboard Extension provides requests to list the contents of this +database, to assemble and complete keyboard descriptions by merging the current +keyboard description with the contents of this database, or to replace the +current keyboard description with a complete keyboard description assembled as +described below. + + + +Component Names + + +Component and keymap names have the form " +class +( +member +)" where +class + describes a subset of the available components for a particular type and the +optional +member + identifies a specific component from that subset. For example, the name +"atlantis(acme)" might specify the symbols used for the atlantis national +keyboard layout by the vendor "acme." Each class has an optional +default + member — references which specify a class but not a member refer to the +default member of the class, if one exists. + + + + +The +class + and +member + names are both specified using characters from the Latin-1 character set. XKB +implementations must accept all alphanumeric characters, minus (‘-’) and +underscore (‘_’) in class or member names, and must not accept parentheses, +plus, vertical bar, percent sign, asterisk, question mark or white space. The +use of other characters is implementation-dependent. + + + + + +Partial Components and Combining Multiple Components + + +Some of the elements in the server database contain describe only a piece of +the corresponding keyboard component. These +partial + components should be combined with other components of the same type to be +useful. + + + + +For example, a partial symbols map might describe the differences between a +common ASCII keyboard and some national layout. Such a partial map is not +useful on its own because it does not include those symbols that are the same +on both the ASCII and national layouts (such as function keys). On the other +hand, this partial map can configure +any + ASCII keyboard to use a national layout. + + + + +Two components can be combined in two ways: + + + + + If the second component +overrides + the first, any definitions that are present in both components are taken from +the second. + + + + If the second component +augments + the first, any definitions that are present in both components are taken from +the first. + + + + + +Applications can use a +component expression + to combine multiple components of some time into a complete description of +some aspect of the keyboard. A component expression is a string which lists the +components to be combined separated by operators which specify the rules for +combining them. A complete description is assembled from the listed components, +left to right, as follows: + + + + + If the new elements are being merged with an existing map, the special +component name ‘%’ refers to the unmodified value of the map. + + + + The ‘+’ operator specifies that the next specified component should +override the current assembled definition. + + + + The ‘|’ operator specifies that the next specified component should +augment the currently assembled definition. + + + + If the new elements are being merged with an existing map and the +component expression begins with an operator, a leading ‘%’ is implied. + + + + If any unknown or illegal characters appear anywhere in the string, the +entire expression is invalid and is ignored. + + + + + +For example, the component expression "+de" specifies that the default element +of the "de" map should be applied to the current keyboard mapping, overriding +any existing definitions. + + + + +A slightly more involved example: the expression +"acme(ascii)+de(basic)|iso9995-3" constructs a German (de) mapping for the +ASCII keyboard supplied by the "acme" vendor. The new definition begins with +the symbols for the default ASCII keyboard for Acme, overrides them with any +keys that are defined for the default German keyboard layout and then applies +the definitions from the iso9995-3 to any undefined keys or groups of keys +(part three of the iso9995 standard defines a common set of bindings for the +secondary group, but allows national layouts to override those definitions +where necessary). + + + + + +Component Hints + + +Each component has a set of flags that provide some additional hints about that +component. XKB provides these hints for clients that present the keyboard +database to users and specifies their interpretation only loosely. Clients can +use these hints to constrain the list of components or to control the way that +components are presented to the user. + + + + +Hints for a component are reported with its name. The least significant byte of +the hints field has the same meaning for all five types of keyboard components, +and can contain any combination of the following values: + + + + + + + + + + Flag + Meaning + + + + + +LC_Hidden + + Indicates a component that should not normally be presented to the +user. + + + +LC_Default + + Indicates a component that is the default member of its +class. + + + +LC_Partial + + Indicates a partial component. + + + + + + +The interpretation of the most significant byte of the hints field is dependent +on the type of component. The hints defined for each kind of component are +listed in the section below that describes that kind of component. + + + + + +Keyboard Components + + +The five types of components stored in the server database of keyboard +components correspond to the +symbols +, +geometry +, +keycodes +, +compat + and +types + symbolic names associated with a keyboard. + + + + +The Keycodes Component + + +The +keycodes + component of a keyboard mapping specifies the range and interpretation of the +raw keycodes reported by the device. It sets the +keycodes + symbolic name, the minimum and maximum legal keycodes for the keyboard, and +the symbolic name for each key. The keycodes component might also contain +aliases for some keys, symbolic names for some indicators, and a description of +which indicators are physically present. + + + + +The special keycodes component named "computed" indicates that XKB should +assign unused keycodes to any unknown keys referenced by name by any of the +other components. The computed keycodes component is useful primarily when +browsing keymaps because it makes it possible to use the symbols and geometry +components without having to find a set of keycodes that includes keycode +definitions for all of the keys listed in the two components. + + + + +XKB defines no hints that are specific to the keycodes component. + + + + +The Types Component + + +The +types + component of a keyboard mapping specifies the key types that can be associated +with the various keyboard keys. It affects the +types + symbolic name and the list of types associated with the keyboard (see +Key Types). The types component +of a keyboard mapping can also optionally contain real modifier bindings and +symbolic names for one or more virtual modifiers. + + + + +The special types component named "canonical" always contains the types and +definitions listed in Canonical Key Types of this document. + + + + +XKB defines no hints that are specific to the types component. + + + + + +The Compatibility Map Component + + +The +compatibility map + component of a keyboard mapping primarily specifies the rules used to assign +actions to keysyms. It affects the +compat + symbolic name, the symbol compatibility map and the group compatibility map. +The compat component might also specify maps for some indicators and the real +modifier bindings and symbolic names of some virtual modifiers. + + + + +XKB defines no hints that are specific to the compatibility map component. + + + + + +The Symbols Component + + +The +symbols + component of a keyboard mapping specifies primarily the symbols bound to each +keyboard key. It affects the +symbols + symbolic name, a key symbol mapping for each key, they keyboard modifier +mapping, and the symbolic names for the keyboard symbol groups. Optionally, the + +symbols + component can contain explicit actions and behaviors for some keys, or the +real modifier bindings and symbolic names for some virtual modifiers. + + + + +XKB defines the following additional hints for the symbols component: + + + + + + + + + + Flag + Meaning + + + + + +LC_AlphanumericKeys + + Indicates a symbol component that contains bindings primarily for an +alphanumeric section of the keyboard. + + + +LC_ModifierKeys + + Indicates a symbol component that contains bindings primarily for +modifier keys. + + + +LC_KeypadKeys + + Indicates a symbol component that contains bindings primarily for +numeric keypad keys. + + + LC_FunctionKeys + Indicates a symbol component that contains bindings primarily for +function keys. + + + LC_AlternateGroup + Indicates a symbol component that contains bindings for an alternate +keyboard group. + + + + + + +These hints only apply to partial symbols components; full symbols components +are assumed to specify all of the pieces listed above. + + +The alphanumeric, modifier, keypad or function keys hints should +describe the primary intent of the component designer and should not simply an +exhaustive list of the kinds of keys that are affected. For example, national +keyboard layouts affect primarily alphanumeric keys, but many affect a few +modifier keys too; such mappings should set only +LC_AlphanumericKeys + hint. In general, symbol components should set only one of those four flags +(though +LC_AlternateGroup + may be combined with any of the other flags). + + + +The Geometry Component + + +The +geometry + component of a keyboard mapping specifies primarily the geometry of the +keyboard. It contains the geometry symbolic name and the keyboard geometry +description. The geometry component might also contain aliases for some keys or +symbolic names for some indicators and might affect the set of indicators that +are physically present. Key aliases defined in the geometry component of a +keyboard mapping override those defined in the keycodes component. + + + + +XKB defines no hints that are specific to the geometry component. + + + + + + +Complete Keymaps + + +The X server also reports a set of fully specified keymaps. The keymaps +specified in this list are usually assembled from the components stored in the +rest of the database and typically represent the most commonly used keymaps for +a particular system. + + + + +XKB defines no hints that are specific to complete keymaps. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch14.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch14.xml new file mode 100644 index 0000000000000000000000000000000000000000..6a2f45a0bf24cd517277c2997c8317b013647f08 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch14.xml @@ -0,0 +1,94 @@ + +Replacing the Keyboard "On-the-Fly" + + +XKB supports the +XkbNewKeyboardNotify + event, which reports a change in keyboard geometry or the range of supported +keycodes. The server can generate an +XkbNewKeyboardNotify + event when it detects a new keyboard, or in response to an +XkbGetKeyboardByName + request (see Using the Server’s +Database of Keyboard Components) which loads a new keyboard description. + + + + +When a client opens a connection to the X server, the server reports the +minimum and maximum keycodes. If the range of supported keycodes is changed, +XKB keeps track of the minimum and maximum keycodes that were reported to each +client and filters out any events that fall outside of that range. Note that +these events are simply ignored; they are not delivered to some other client. + + + + +When the server sends an +XkbNewKeyboardNotify + event to a client to inform it of the new keycode range, XKB resets the stored +range of legal keycodes to the keycode range reported in the event. Non-XKB +clients and XKB-aware clients that do not request +XkbNewKeyboardNotify + events never receive events from keys that fall outside of the legal range +that XKB maintains for that client. + + + + +When a client requests +XkbNewKeyboardNotify + events, the server compares the range of keycodes for the current keyboard to +the range of keycodes that are valid for the client. If they are not the same, +the server immediately sends that client an +XkbNewKeyboardNotify + event. Even if the "new" keyboard is not new to the server, it is new to this +particular client. + + + + +In addition to filtering out-of-range key events, XKB: + + + + + Adjusts core protocol +MappingNotify + events to refer only to keys that match the stored legal range. + + + + Reports keyboard mappings for keys that match the stored legal range to +clients that issue a core protocol +GetKeyboardMapping + request. + + + + Reports modifier mappings only for keys that match the stored legal +range to clients that issue a core protocol +GetModifierMapping + request. + + + + Restricts the core protocol +ChangeKeyboardMapping + and +SetModifierMapping + requests to keys that fall inside the stored legal range. + + + + + +In short, XKB does everything possible to hide the fact that the range of legal +keycodes has changed from clients non-XKB clients, which cannot be expected to +deal with it. The corresponding XKB events and requests do +not + pay attention to the legal keycode range in the same way because XKB makes it +possible for clients to track changes to the keycode range for a device and +respond to them. + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch15.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch15.xml new file mode 100644 index 0000000000000000000000000000000000000000..d3e47d0f75742dc6de6a0c47e578345391e488cc --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch15.xml @@ -0,0 +1,233 @@ + +Interactions Between XKB and the X Input Extension + + +All XKB interactions with the input extension are optional; implementors are +free to restrict the effects of the X Keyboard Extension to the core keyboard +device. The +XkbGetExtensionDeviceInfo + request reports whether or not an XKB implementation supports a particular +capability for input extension devices. + + + + +XKB recognizes the following interactions with the X Input Extension: + + + + + + + + + + Name + Capability + + + + + XI_Keyboards + If set, applications can use all XKB requests and events with +extension keyboards. + + + XI_ButtonActions + If set, clients can assign key actions to buttons, even on input +extension devices that are not keyboards. + + + XI_IndicatorNames + If set, clients can assign names to indicators on non-keyboard +extension devices. + + + XI_IndicatorMaps + If set, clients can assign indicator maps to indicators on +non-keyboard extension devices. + + + XI_IndicatorState + If set, clients can change the state of device indicators using the + +XkbSetExtensionDeviceInfo + request. + + + + + + +Attempts to use an XKB feature with an extension device fail with a +Keyboard + error if the server does not support the +XkbXI_Keyboards + optional feature. If a capability particular capability other than +XkbXI_Keyboards + is not supported, attempts to use it fail silently. The replies for most +requests that can use one of the other optional features include a field to +report whether or not the request was successful, but such requests do not +cause an error condition. + + + + +Clients can also request an +XkbExtensionDeviceNotify + event. This event notifies interested clients of changes to any of the +supported XKB features for extension devices, or if a request from the client +that is receiving the event attempted to use an unsupported feature. + + + +Using XKB Functions with Input Extension Keyboards + + +All XKB requests and events include a device identifier which can refer to an +input extension +KeyClass + device, if the implementation allows XKB to control extension devices. If the +implementation does not support XKB manipulation of extension devices, the +device identifier is ignored but it must be either +0 + or +UseCoreKbd +. + + + + +Implementations which do not support the use of XKB functions with extension +keyboards must not set the +XkbXI_Keyboards + flag. Attempts to use XKB features on an extension keyboard with an +implementation that does not support this feature yield a +Keyboard + error. + + + + + +Pointer and Device Button Actions + + +The XKB extension optionally allows clients to assign any key action (see +Key Actions) to core +pointer or input extension device buttons. This makes it possible to control +the keyboard or generate keyboard key events from extension devices or from the +core pointer. + + + + +XKB implementations are required to support actions for the buttons of the core +pointer device, but support for actions on extension devices is optional. +Implementations which do not support button actions for extension devices must +not set the +XkbXI_ButtonActions + flag. + + + + +Attempts to query or assign button actions with an implementation that does not +support this feature report failure in the request reply and might cause the +server to send an +XkbExtensionDeviceNotify + event to the client which issued the request that failed. Such requests never +cause an error condition. + + + + + +Indicator Maps for Extension Devices + + +The XKB extension allows applications to assign indicator maps to the +indicators of non-keyboard extension devices. If supported, maps can be +assigned to all extension device indicators, whether they are part of a +keyboard feedback or part of an indicator feedback. + + + + +Implementations which do not support indicator maps for extension devices must +not set the +XkbXI_IndicatorMaps + flag. + + + + +Attempts to query or assign indicator maps with an implementation that does not +support this feature report failure in the request reply and might cause the +server to send an +XkbExtensionDeviceNotify + event to the client which issued the request that failed. Such requests never +cause an error condition. + + + + +If this feature is supported, the maps for the default indicators on the core +keyboard device are visible both as extension indicators and as the core +indicators. Changes made with +XkbSetDeviceInfo + are visible via +XkbGetIndicatorMap + and changes made with +XkbSetIndicatorMap + are visible via +XkbGetDeviceInfo +. + + + + + +Indicator Names for Extension Devices + + +The XKB extension allows applications to assign symbolic names to the +indicators of non-keyboard extension devices. If supported, symbolic names can +be assigned to all extension device indicators, whether they are part of a +keyboard feedback or part of an indicator feedback. + + + + +Implementations which do not support indicator maps for extension devices must +not set the +XkbXI_IndicatorMaps + flag. + + + + +Attempts to query or assign indicator names with an implementation that does +not support this feature report failure in the request reply and might cause +the server to send an +XkbExtensionDeviceNotify + event to the client which issued the request that failed. Such requests never +cause an error condition. + + + + +If this feature is supported, the names for the default indicators on the core +keyboard device are visible both as extension indicators and as the core +indicators. Changes made with +XkbSetDeviceInfo + are visible via +XkbGetNames + and changes made with +XkbSetNames + are visible via +XkbGetDeviceInfo +. + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/ch16.xml b/miniconda3/envs/ladir/share/doc/kbproto/ch16.xml new file mode 100644 index 0000000000000000000000000000000000000000..6044843c46cebdd1f39461c9aaf31246d28df60a --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/ch16.xml @@ -0,0 +1,9427 @@ + + +XKB Protocol Requests + + +This document uses the syntactic conventions and common types defined by the +specification of the core X protocol with a number of additions, which are +detailed below. + + + +Errors + + +If a client attempts to use any other XKB request except +XkbUseExtension + before the extension is properly initialized, XKB reports an +Access + error and ignores the request. XKB is properly initialized once +XkbUseExtension + reports that the client has asked for a supported or compatible version of the +extension. + + + + +Keyboard Errors + + +In addition to all of the errors defined by the core protocol, the X Keyboard +Extension defines a single error, +Keyboard +, which indicates that some request specified an illegal device identifier or +an extension device that is not a member of an appropriate. Unless otherwise +noted, any request with an argument of type KB_DEVICESPEC can cause +Keyboard + errors if an illegal or inappropriate device is specified. + + + + +When the extension reports a Keyboard error, the most significant byte of the + +resource_id + is a further refinement of the error cause, as defined in the table below. The +least significant byte contains the device, class, or feedback id as indicated: + + + + + + + + + + + + high-order byte + value + meaning + low-order byte + + + + + XkbErr_BadDevice + 0xff + device not found + device id + + + XkbErr_BadClass + 0xfe + device found, but is the wrong class + class id + + + XkbErr_BadId + 0xfd + device found, class ok, but device does not have a feedback with the +indicated id + feedback id + + + + + + + +Side-Effects of Errors + + +With the exception of +Alloc + or +Implementation + errors, which might result in an inconsistent internal state, no XKB request +that reports an error condition has any effect. Unless otherwise stated, +requests which update some aspect of the keyboard description will not apply +only part of a request — if part of a request fails, the whole thing is +ignored. + + + + + + +Common Types + + +The following types are used in the request and event definitions in subsequent +sections: + + + + + + + + + + Name + Value + + + + + LISTofITEMs + The type LISTofITEMs is special. It is similar to the +LISTofVALUE defined by the core protocol, but the elements of a LISTofITEMs are +not necessarily all the same size. The use of a BITMASK to indicate which +members are present is optional for a LISTofITEMs — it is possible for the +set of elements to be derived from one or more fields of the request. + + + KB_DEVICESPEC + 8 bit unsigned integer, +UseCoreKbd, or UseCorePtr + + + + KB_LEDCLASSSPEC + { +KbdFeedbackClass +, +LedFeedbackClass +, +DfltXIClass +, +AllXIClasses +, +XINone + } + + + KB_BELLCLASSSPEC + { +KbdFeedbackClass +, +BellFeedbackClass +, +DfltXIClass +, +AllXIClasses + } + + + KB_IDSPEC + 8 bit unsigned integer or +DfltXIId + + + + KB_VMODMASK + CARD16, each bit corresponds to a virtual modifier + + + KB_GROUPMASK + { +Group1 +, +Group2 +, +Group3 +, +Group4 + } + + + KB_GROUPSWRAP + { +WrapIntoRange +, +ClampIntoRange +, +RedirectIntoRange + } + + + KB_GROUPINFO + { groupsWrap: KB_GROUPSWRAP +redirectGroup: 1…4, +numGroups: 1…4 } + + + KB_NKNDETAILSMASK + { +NKN_Keycodes +, NKN_Geometry, +NKN_DeviceID + } + + + KB_STATEMASK + KEYBUTMASK or KB_GROUPMASK + + + KB_STATEPARTMASK + { +ModifierState +, +ModifierBase +, +ModifierLatch +, +ModifierLock +, +GroupState +, +GroupBase +, +GroupLatch +, +GroupLock +, +CompatState +, +GrabMods +, +CompatGrabMods +, +LookupMods +, +CompatLookupMods +, +PointerButtons + } + + + KB_BOOLCTRLMASK + { +RepeatKeys +, +SlowKeys +, +BounceKeys +, +StickyKeys +, +MouseKeys +, +MouseKeysAccel +, +AccessXKeys +, +AccessXTimeout +, +AccessXFeedback +, +AudibleBell +, +Overlay1 +, +Overlay2 +, +IgnoreGroupLock + } + + + KB_CONTROLSMASK + { +GroupsWrap, InternalMods +, +IgnoreLockMods +, +PerKeyRepeat +, +ControlsEnabled + } or KB_BOOLCTRLMASK + + + KB_MAPPARTMASK + { +KeyTypes +, +KeySyms +, +ModifierMap +, +ExplicitComponents +, +KeyActions +, +KeyBehaviors +, +VirtualMods +, +VirtualModMap +} + + + KB_CMDETAILMASK + { +SymInterp +, +GroupCompat + } + + + KB_NAMEDETAILMASK + { +KeycodesName +, +GeometryName +, +SymbolsName +, + +PhysSymbolsName +, +TypesName +, +CompatName +, +KeyTypeNames +, +KTLevelNames +, +IndicatorNames +, +KeyNames +, +KeyAliases +, +VirtualModNames +, +GroupNames +, +RGNames +} + + + KB_AXNDETAILMASK + { +AXN_SKPress +, +AXN_SKAccept +, +AXN_SKReject +, +AXN_SKRelease, AXN_BKAccept, AXN_BKReject, AXN_AXKWarning +} + + + KB_AXSKOPTSMASK + { +AX_TwoKeys +, +AX_LatchToLock + } + + + KB_AXFBOPTSMASK + { +AX_SKPressFB +, +AX_SKAcceptFB +, +AX_FeatureFB +, +AX_SlowWarnFB +, +AX_IndicatorFB +, +AX_StickyKeysFB +, +AX_SKReleaseFB +, + AX_SKRejectFB +, +AX_BKRejectFB +, +AX_DumbBellFB + } + + + KB_AXOPTIONSMASK + KB_AXFBOPTSMASK or KB_AXSKOPTSMASK + + + KB_GBNDETAILMASK + { +GBN_Types +, +GBN_CompatMap +, +GBN_ClientSymbols +, +GBN_ServerSymbols +, +GBN_IndicatorMap +, +GBN_KeyNames +, +GBN_Geometry +, +GBN_OtherNames + } + + + KB_BELLDETAILMASK + { +XkbAllBellNotifyEvents + } + + + KB_MSGDETAILMASK + { +XkbAllActionMessages + } + + + KB_EVENTTYPE + { +XkbNewKeyboardNotify +, +XkbMapNotify +, +XkbStateNotify +, +XkbControlsNotify +, +XkbIndicatorStateNotify +, +XkbIndicatorMapNotify +, +XkbNamesNotify +, +XkbCompatMapNotify +, +XkbBellNotify +, +XkbActionMessage +, +XkbAccessXNotify +, +XkbExtensionDeviceNotify + } + + + KB_ACTION + [ type: CARD8 +data: LISTofCARD8 ] + + + KB_BEHAVIOR + [ type: CARD8, data: CARD 8 ] + + + KB_MODDEF + [ mask: KEYMASK, +mods: KEYMASK, +vmods: KB_VMODMASK ] + + + KB_KTMAPENTRY + [ active: BOOL, +level: CARD8, +mods: KB_MODDEF ] + + + KB_KTSETMAPENTRY + [ level: CARD8, +mods: KB_MODDEF ] + + + KB_KEYTYPE + [ mods: KB_MODDEF, +numLevels: CARD8, +map: LISTofKB_KTMAPENTRY, +preserve: LISTofKB_MODDEF ] + + + KB_SETKEYTYPE + [ realMods: KEYMASK, +vmods: CARD16, +numLevels: CARD8, +map: LISTofKB_KTSETMAPENTRY, +preserve: LISTofKB_MODDEF ] + + + KB_KEYSYMMAP + [ ktIndex: LISTofCARD8, width: CARD8 + numGroups: 0…4, + groupsWrap: KB_GROUPSWRAP, + redirectGroup: 0…3, + syms: LISTofKEYSYM ] + + + KB_KEYVMODMAP + [ key: KEYCODE, vmods: CARD16 ] + + + KB_KEYMODMAP + [ key: KEYCODE, mods: KEYMASK ] + + + KB_EXPLICITMASK + { +ExplicitKeyType1 +, +ExplicitKeyType2 +, +ExplicitKeyType3 +, +ExplicitKeyType4 +, +ExplicitInterpret +, +ExplicitAutoRepeat +, +ExplicitBehavior +, +ExplicitVModMap + } + + + KB_INDICATORMASK + CARD32, each bit corresponds to an indicator + + + KB_IMFLAGS + { +IM_NoExplicit +, +IM_NoAutomatic +, +IM_LEDDrivesKB + } + + + KB_IMMODSWHICH + { +IM_UseNone +, +IM_UseBase +, +IM_UseLatched +, +IM_UseLocked +, +IM_UseEffective +, +IM_UseCompat + } + + + KB_IMGROUPSWHICH + { +IM_UseNone +, +IM_UseBase +, +IM_UseLatched +, +IM_UseLocked +, +IM_UseEffective + } + + + KB_INDICATORMAP + [ flags: CARD8, +mods: KB_MODDEF, +whichMods: +groups: KB_GROUPMASK, +whichGroups: +ctrls: KB_BOOLCTRLMASK ] + + + KB_SYMINTERPMATCH + { +SI_NoneOf +, +SI_AnyOfOrNone +, +SI_AnyOf +, +SI_AllOf +, +SI_Exactly + } + + + KB_SYMINTERP + [ sym: KEYSYM, + mods; KEYMASK, + levelOneOnly: BOOL, + match: KB_SYMINTERPMATCH, + virtualMod: CARD8, + autoRepeat: BOOL, + lockingKey: BOOL ] + + + KB_PCFMASK + { +PCF_DetectableAutorepeat +, +PCF_GrabsUseXkbState +, +PCF_AutoResetControls +, +PCF_LookupStateWhenGrabbed +, +PCF_SendEventUsesXKBState + } + + + KB_LCFLAGSMASK + { +LC_Hidden +, +LC_Default +, +LC_Partial + } + + + KB_LCSYMFLAGSMASK + { +LC_AlphanumericKeys +, +LC_ModifierKeys +, +LC_KeypadKeys +, +LC_FunctionKeys +, +LC_AlternateGroup + } + + + + + + +These types are used by the +XkbGetGeometry + and +XkbSetGeometry + requests: + + + + + + + + + + Name + Value + + + + + KB_PROPERTY + [ name, value: STRING8 ] + + + KB_POINT + [ x, y: CARD16 ] + + + KB_OUTLINE + [ cornerRadius: CARD8, points: LISTofKB_POINT ] + + + KB_SHAPE + [ name: ATOM, outlines: LISTofKB_OUTLINE + primaryNdx, approxNdx: CARD8 ] + + + KB_KEYNAME + [ name: LISTofCHAR ] + + + KB_KEYALIAS + [ real: LISTofCHAR, alias: LISTofCHAR ] + + + KB_KEY + [ name: KB_KEYNAME, gap: INT16, + shapeNdx, colorNdx: CARD8 ] + + + KB_ROW + [ top, left: INT16, vertical: BOOL, keys LISTofKB_KEY ] + + + KB_OVERLAYKEY + [ over, under: KB_KEYNAME ] + + + KB_OVERLAYROW + [ rowUnder: CARD8, keys: LISTofKB_OVERLAYKEY ] + + + KB_OVERLAY + [ sectionUnder: CARD8, +rows: LISTofKB_OVERLAYROW ] + + + KB_SHAPEDOODAD + [ name: ATOM, priority: CARD8, top, left: INT16, + type: { SolidDoodad, OutlineDoodad }, + angle: INT16, width, height: CARD16 + colorNdx, shapeNdx: CARD8 ] + + + KB_TEXTDOODAD + [ name: ATOM, priority: CARD8, top, left: INT16, + angle: INT16, width, height: CARD16, + colorNdx: CARD8, text: STRING8, font: STRING8 ] + + + KB_INDICATORDOODAD + [ name: ATOM, priority: CARD8, top, left: INT16, +angle: INT16, +shapeNdx, onColorNdx, offColorNdx: CARD8 ] + + + KB_LOGODOODAD + [ name: ATOM, priority: CARD8, top, left: INT16, + angle: INT16, colorNdx, shapeNdx: CARD8, + logoName: STRING8 ] + + + KB_DOODAD + KB_SHAPEDOODAD, or KB_TEXTDOODAD, or KB_INDICATORDOODAD, or +KB_LOGODOODAD + + + KB_SECTION + [ name: ATOM, + top, left, angle: INT16, + width, height: CARD16, + priority: CARD8, + rows: LISTofKB_ROW, + doodads: LISTofKB_DOODAD, + overlays: LISTofKB_OVERLAY ] + + + + + + +These types are used by +XkbGetDeviceInfo + and +XkbSetDeviceInfo +: + + + + + + + + + + Name + Value + + + + + KB_XIDEVFEATUREMASK + { +XI_ButtonActions +, +XI_IndicatorNames +, +XI_IndicatorMaps +, +XI_IndicatorState + } + + + KB_XIFEATUREMASK + { KB_XIDEVFEATURES or +XI_Keyboards + + + + KB_XIDETAILMASK + { KB_XIFEATURES or +XI_UnsupportedFeature + +} + + + + KB_DEVICELEDINFO + [ ledClass: KB_LEDCLASSSPEC, +ledID: KB_IDSPEC, +physIndicators: CARD32, +state: CARD32, +names: LISTofATOM, +maps: LISTofKB_INDICATORMAP ] + + + + + + + +Requests + + +This section lists all of the requests supported by the X Keyboard Extension, +separated into categories of related requests. + + + + +Initializing the X Keyboard Extension + + + + + + + + + XkbUseExtension + + + + + wantedMajor, wantedMinor: CARD16 + + + +supported: BOOL + + + + +serverMajor, serverMinor: CARD16 + + + + + + +This request enables XKB extension capabilities for the client that issues the +request; the +wantedMajor + and +wantedMinor + fields specify the extension version in use by the requesting client. The + +supported + field is +True + if the server supports a compatible version, +False + otherwise. The +serverMajor + and +serverMinor + fields return the actual version supported by the server. + + + + +Until a client explicitly and successfully requests the XKB extension, an XKB +capable server reports compatibility state in all core protocol events and +requests. Once a client asks for XKB extension semantics by issuing this +request, the server reports the extended XKB keyboard state in some core +protocol events and requests, as described in the overview section of this +specification. + + + + +Clients should issue an +XkbUseExtension + request before using any other extension requests. + + + + + +Selecting Events + + + + + + + + + XkbSelectEvents + + + + + deviceSpec: KB_DEVICESPEC + + + +affectWhich, clear, selectAll: KB_EVENTTYPE + + + +affectMap, map: KB_MAPPARTMASK + + + +details: LISTofITEMs + + + + Errors: +Keyboard +, +Match +, +Value + + + + + + + + +This request updates the event masks of the keyboard indicated by +deviceSpec + for this client. If +deviceSpec + specifies an illegal device, a +Keyboard + error results. + + + + +The +affectMap + and +map + fields specify changes to the event details mask for the +XkbMapNotify + event. If any map components are set in +map + but not in +affectMap +, a +Match + error results. Otherwise, any map components that are set in +affectMap + are set or cleared in the map notify details mask, depending on the value of +the corresponding field in +map +. + + + + +The +affectWhich +, +clear +, and +selectAll + fields specify changes to any other event details masks. If any event types +are set in both +clear + and +selectAll +, a +Match + error results; if any event types are specified in either +clear + or +selectAll + but not in +affectWhich +, a +Match + error results. Otherwise, the detail masks for any event types specified in +the +affectWhich + field of this request are changed as follows: + + + + + If the event type is also set in +clear +, the detail mask for the corresponding event is set to +0 + or +False +, as appropriate. + + + + If the event type is also set in +selectAll +, the detail mask for the corresponding event is set to include all legal +detail values for that type. + + + + If the event type is not set in either +clear + or +selectAll +, the corresponding element of +details + lists a set of explicit changes to the details mask for the event, as +described below. + + + + + +Each entry of the +details + list specifies changes to the event details mask for a single type of event, +and consists of an +affects + mask and a +values + mask. All details that are specified in +affects + are set to the corresponding value from +values +; if any details are listed in +values + but not in +affects +, a +Match + error results. + + + + +The details list contains entries only for those event types, if any, that are +listed in the +affectWhich + mask and not in either +clear + or +selectAll +. When present, the items of the +details + list appear in the following order: + + + + + + + + + + + Event Type + Legal Details + Type + + + + + +XkbNewKeyboardNotify + + +KB_NKNDETAILSMASK + + +CARD16 + + + + +XkbStateNotify + + +KB_STATEPARTMASK + + +CARD16 + + + + +XkbControlsNotify + + +KB_CONTROLMASK + + +CARD32 + + + + +XkbIndicatorMapNotify + + +KB_INDICATORMASK + + +CARD32 + + + + +XkbIndicatorStateNotify + + +KB_INDICATORMASK + + +CARD32 + + + + +XkbNamesNotify + + +KB_NAMEDETAILMASK + + +CARD16 + + + + +XkbCompatMapNotify + + +KB_CMDETAILMASK + + +CARD8 + + + + +XkbBellNotify + + +KB_BELLDETAILMASK + + +CARD8 + + + + +XkbActionMessage + + +KB_MSGDETAILMASK + + +CARD8 + + + + +XkbAccessXNotify + + +KB_AXNDETAILMASK + + +CARD16 + + + + +XkbExtensionDeviceNotify + + +KB_XIDETAILMASK + + +CARD16 + + + + + + + +Detail masks for event types that are not specified in +affectWhich + are not changed. + + + + +If any components are specified in a client’s event masks, the X server sends +the client an appropriate event whenever any of those components change state. +Unless explicitly modified, all event detail masks are empty. Events describes all XKB events +and the conditions under which the server generates them. + + + + + +Generating Named Keyboard Bells + + + + + + + + + XkbBell + + + + + deviceSpec: KB_DEVICESPEC + + + +bellClass: KB_BELLCLASSSPEC + + + +bellID: KB_IDSPEC + + + +percent: INT8 + + + +forceSound: BOOL + + + +eventOnly: BOOL + + + +pitch, duration: INT16 + + + +name: ATOM + + + +window: WINDOW + + + + Errors: +Keyboard +, +Value +, +Match + + + + + + + + +This request generates audible bells and/or +XkbBellNotify + events for the bell specified by the +bellClass + and +bellID + on the device specified by +deviceSpec + at the specified +pitch +, +duration + and volume ( +percent +). If deviceSpec specifies a device that does not have a bell or keyboard +feedback, a +Keyboard + error results. + + + + +If both +forceSound + and +eventOnly + are set, this request yields a +Match + error. Otherwise, if +forceSound + is +True +, this request always generates a sound and never generates an event; if + +eventOnly + is +True +, it causes an event but no sound. If neither +forceSound + nor +eventOnly + are +True +, this request always generates an event; if the keyboard’s global +AudibleBell + control is enabled, it also generates a sound. + + + + +Any bell event generated by this request contains all of the information about +the bell that was requested, including the symbolic name specified by +name + and the event window specified by window. The +name + and +window + are not directly interpreted by XKB, but they must have the value +None + or specify a legal Atom or Window, respectively. +XkbBellNotify + events generated in response to core protocol or X input extension bell +requests always report +None + as their +name +. + + + + +The +bellClass +, +bellID +, and +percent + fields are interpreted as for the X input extension +DeviceBell + request. If +pitch + and +duration + are zero, the server uses the corresponding values for that bell from the core +protocol or input extension, otherwise +pitch + and +duration + are interpreted as for the core protocol +ChangeKeyboardControl + request; if they do not include legal values, a +Value + error results. The +window + field must specify a legal Window or have the value +None +, or a +Value + error results. The name field must specify a legal Atom or have the value + +None +, or an +Atom + error results. If an error occurs, this request has no other effect (i.e. does +not cause a sound or generate an event). + + + + +The +pitch +, +volume +, and +duration + are suggested values for the bell, but XKB does not require the server to +honor them. + + + + + +Querying and Changing Keyboard State + + + + + + + + + XkbGetState + + + + + deviceSpec: KB_DEVICESPEC + + + + +deviceID: CARD8 + + + + +mods, baseMods, latchedMods, lockedMods: KEYMASK + + + + +group, lockedGroup: KB_GROUP + + + + +baseGroup, latchedGroup: INT16 + + + + +compatState: KEYMASK + + + + +grabMods, compatGrabMods: KB_GROUP + + + + +lookupMods, compatLookupMods: KEYMASK + + + + +ptrBtnState: BUTMASK + + + Errors: +Keyboard + + + + + + + + +This request returns a detailed description of the current state of the +keyboard specified by +deviceSpec +. + + + + +The +deviceID + return value contains the input extension identifier for the specified device, +or +0 + if the server does not support the input extension. + + + + +The +baseMods + return value reports the modifiers that are set because one or more modifier +keys are logically down. The +latchedMods + and +lockedMods + return values report the modifiers that are latched or locked respectively. +The +mods + return value reports the effective modifier mask which results from the +current combination of base, latched and locked modifiers. + + + + +The +baseGroup + return value reports the group state selected by group shift keys that are +logically down. The +latchedGroup + and +lockedGroup + return values detail the effects of latching or locking group shift keys and + +XkbLatchLockState + requests. The +group + return value reports the effective keyboard group which results from the +current combination of base, latched and locked group values. + + + + +The +lookupMods + return value reports the lookup modifiers, which consist of the current +effective modifiers minus any server internal modifiers. The +grabMods + return value reports the grab modifiers, which consist of the lookup modifiers +minus any members of the ignore locks mask that are not either latched or +logically depressed. Keyboard +State describes the lookup modifiers and grab modifiers in more detail. + + + + +The +ptrBtnState + return value reports the current logical state of up to five buttons on the +core pointer device. + + + + +The +compatState + return value reports the compatibility state that corresponds to the effective +keyboard group and modifier state. The +compatLookupMods + and +compatGrabMods + return values report the core protocol compatibility states that correspond to +the XKB lookup and grab state. All of the compatibility states are computed by +applying the group compatibility mapping to the corresponding XKB modifier and +group states, as described in +Group Compatibility Map. + + + + + + + + + + + XkbLatchLockState + + + + + deviceSpec: KB_DEVICESPEC + + + +affectModLocks, modLocks: KEYMASK + + + +lockGroup: BOOL + + + +groupLock: KB_GROUP + + + +affectModLatches,modLatches: KEYMASK + + + +latchGroup: BOOL + + + +groupLatch: INT16 + + + + Errors: +Keyboard +, +Value + + + + + + + + +This request locks or latches keyboard modifiers and group state for the device +specified by +deviceSpec +. If +deviceSpec + specifies an illegal or non-keyboard device, a +Keyboard + error occurs. + + + + +The locked state of any modifier specified in the +affectModLocks + mask is set to the corresponding value from +modLocks +. If +lockGroup + is +True +, the locked keyboard group is set to the group specified by +groupLock +. If any modifiers are set in +modLocks + but not +affectModLocks +, a +Match + error occurs. + + + + +The latched state of any modifier specified in the +affectModLatches + mask is set to the corresponding value from +modLatches +. If +latchGroup + is +True +, the latched keyboard group is set to the group specified by +groupLatch +. if any modifiers are set in +modLatches + but not in +affectModLatches +, a +Match + error occurs. + + + + +If the locked group exceeds the maximum number of groups permitted for the +specified keyboard, it is wrapped or truncated back into range as specified by +the global +GroupsWrap + + +control. No error results from an out-of-range group specification. + + + + +After changing the locked and latched modifiers and groups as specified, the X +server recalculates the effective and compatibility keyboard state and +generates +XkbStateNotify + events as appropriate if any state components have changed. Changing the +keyboard state might also turn indicators on or off which can cause +XkbIndicatorStateNotify + events as well. + + + + +If any errors occur, this request has no effect. + + + + + +Querying and Changing Keyboard Controls + + + + + + + + + XkbGetControls + + + + + deviceSpec: KB_DEVICESPEC + + + + +deviceID: CARD8 + + + + +mouseKeysDfltBtn: CARD8 + + + + +numGroups: CARD8 + + + + +groupsWrap: KB_GROUPINFO + + + + +internalMods,ignoreLockMods: KB_MODDEF + + + + +repeatDelay,repeatInterval: CARD16 + + + + +slowKeysDelay, debounceDelay: CARD16 + + + + +mouseKeysDelay, mouseKeysInterval: CARD16 + + + + +mouseKeysTimeToMax, mouseKeysMaxSpeed: CARD16 + + + + +mouseKeysCurve: INT16 + + + + +accessXOptions: KB_AXOPTIONMASK + + + + +accessXTimeout: CARD16 + + + + +accessXTimeoutOptionsMask, accessXTimeoutOptionValues: CARD16 + + + + +accessXTimeoutMask,accessXTimeoutValues: CARD32 + + + + +enabledControls: KB_BOOLCTRLMASK + + + + +perKeyRepeat: LISTofCARD8 + + + + Errors: +Keyboard + + + + + + + + +This request returns the current values and status of all controls for the +keyboard specified by +deviceSpec +. If +deviceSpec + specifies an illegal device a +Keyboard + error results. On return, the +deviceID + specifies the identifier of the requested device or zero if the server does +not support the input extension. + + + + +The +numGroups + return value reports the current number of groups, and +groupsWrap + reports the treatment of out-of-range groups, as described in Key Symbol Map. The +internalMods + and +ignoreLockMods + return values report the current values of the server internal and ignore +locks modifiers as described in +Keyboard State. Both are modifier definitions ( +Modifier Definitions) which +report the real modifiers, virtual modifiers, and the resulting combination of +real modifiers that are bound to the corresponding control. + + + + +The +repeatDelay +, +repeatInterval +, +slowKeysDelay + and +debounceDelay + fields report the current values of the for the autorepeat delay, autorepeat +interval, slow keys delay and bounce keys timeout, respectively. The +mouseKeysDelay +, +mouseKeysInterval +, +mouseKeysTimeToMax + and +mouseKeysMaxSpeed + and +mouseKeysCurve + return values report the current acceleration applied to mouse keys, as +described in The MouseKeysAccel +Control. All times are reported in milliseconds. + + + + +The +mouseKeysDfltBtn + return value reports the current default pointer button for which events are +synthesized by the mouse keys server actions. + + + + +The +accessXOptions + return value reports the current settings of the various AccessX options flags +which govern the behavior of the +StickyKeys + control and of AccessX feedback. + + + + +The +accessXTimeout + return value reports the length of time, in seconds, that the keyboard must +remain idle before AccessX controls are automatically changed; an +accessXTimeout + of +0 + indicates that AccessX controls are not automatically changed. The +accessXTimeoutMask + specifies the boolean controls to be changed if the AccessX timeout expires; +the +accessXTimeoutValues + field specifies new values for all of the controls in the timeout mask. The + +accessXTimeoutOptionsMask + field specifies the AccessX options to be changed when the AccessX timeout +expires; the +accessXTimeoutOptionValues + return value reports the values to which they will be set. + + + + +The +enabledControls + return value reports the current state of all of the global boolean controls. + + + + +The +perKeyRepeat + array consists of one bit per key and reports the current autorepeat behavior +of each keyboard key; if a bit is set in +perKeyRepeat +, the corresponding key repeats if it is held down while global keyboard +autorepeat is enabled. This array parallels the core protocol and input +extension keyboard controls, if the autorepeat behavior of a key is changed via +the core protocol or input extension, those changes are automatically reflected +in the +perKeyRepeat + array. + + + + + + + + + + + XkbSetControls + + + + + deviceSpec: KB_DEVICESPEC + + + +affectInternalRealMods, internalRealMods: KEYMASK + + + +affectInternalVirtualMods,internalVirtualMods: KB_VMODMASK + + + +affectIgnoreLockRealMods,ignoreLockRealMods: KB_MODMASK + + + +affectIgnoreLockVirtualMods,ignoreLockVirtualMods: KB_VMODMASK + + + +mouseKeysDfltBtn: CARD8 + + + +groupsWrap: KB_GROUPINFO + + + +accessXOptions: CARD16 + + + +affectEnabledControls: KB_BOOLCTRLMASK + + + +enabledControls: KB_BOOLCTRLMASK + + + +changeControls: KB_CONTROLMASK + + + +repeatDelay,repeatInterval: CARD16 + + + +slowKeysDelay, debounceDelay: CARD16 + + + +mouseKeysDelay, mouseKeysInterval: CARD16 + + + +mouseKeysTimeToMax, mouseKeysMaxSpeed: CARD16 + + + +mouseKeysCurve: INT16 + + + +accessXTimeout: CARD16 + + + +accessXTimeoutMask, accessXTimeoutValues: KB_BOOLCTRLMASK + + + +accessXTimeoutOptionsMask,accessXTimeoutOptionsValues: CARD16 + + + +perKeyRepeat: LISTofCARD8 + + + + Errors: + Keyboard +, +Value + + + + + + + + +This request sets the keyboard controls indicated in +changeControls + for the keyboard specified by +deviceSpec +. Each bit that is set in +changeControls + indicates that one or more of the other request fields should be applied, as +follows: + + + + + + + + + + Bit in changeControls + Field(s) to be Applied + + + + + +XkbRepeatKeysMask + + +repeatDelay +, +repeatInterval + + + + +XkbSlowKeysMask + + +slowKeysDelay + + + + +XkbStickyKeysMask + + +accessXOptions + (only the +XkbAX_TwoKeys + + +and the +XkbAX_LatchToLock + options are affected) + + + +XkbBounceKeysMask + + +debounceDelay + + + + +XkbMouseKeysMask + + +mouseKeysDfltBtn + + + + +XkbMouseKeysAccelMask + + +mouseKeysDelay +, +mouseKeysInterval +, +mouseKeysCurve +, +mouseKeysTimeToMax +, +mouseKeysMaxSpeed + + + + +XkbAccessXKeysMask + + +accessXOptions (all options) + + + + +XkbAccessXTimeoutMask + + +accessXTimeout +, +accessXTimeoutMask +, +accessXTimeoutValues +, +accessXTimeoutOptionsMask +, +accessXTimeoutOptionsValues + + + + XkbAccessXFeedbackMask + +accessXOptions + (all options except those affected by the +XkbStickyKeysMask + bit) + + + +XkbGroupsWrapMask + + +groupsWrap + + + + +XkbInternalModsMask + + +affectInternalRealMods +, +internalRealMods +, +affectInternalVirtualMods +, +internalVirtualMods + + + + +XkbIgnoreLockModsMask + + +affectIgnoreLockRealMods +, +ignoreLockRealMods +, +affectIgnoreLockVirtualMods +, +ignoreLockVirtualMods + + + + +XkbPerKeyRepeatMask + + +perKeyRepeat + + + + +XkbControlsEnabledMask + + +affectEnabledControls +, +enabledControls + + + + + + + +If any other bits are set in +changeControls +, a +Value + error results. If any of the bits listed above are not set in +changeControls +, the corresponding fields must have the value +0 +, or a +Match + error results. + + + + +If applied, +repeatDelay + and +repeatInterval + change the autorepeat characteristics of the keyboard, as described in +The RepeatKeys Control. If +specified, +repeatDelay + and +repeatInterval + must both be non-zero or a +Value + error results. + + + + +If applied, the +slowKeysDelay + field specifies a new delay for the +SlowKeys + control, as defined in The +SlowKeys Control. If specified, +slowKeysDelay + must be non-zero, or a +Value + error results. + + + + +If applied, the +debounceDelay + field specifies a new delay for the +BounceKeys + control, as described in The +BounceKeys Control. If present, the +debounceDelay + must be non-zero or a +Value + error results. + + + + +If applied, the +mouseKeysDfltBtn + field specifies the core pointer button for which events are generated +whenever a +SA_PtrBtn + or +SA_LockPtrBtn + key action is activated. If present, +mouseKeysDfltBtn + must specify a legal button for the core pointer device, or a +Value + error results. Key +Actions describes the +SA_PtrBtn + and +SA_LockPtrBtn + actions in more detail. + + + + +If applied, the +mouseKeysDelay +, +mouseKeysInterval +, +mouseKeysTimeToMax +, +mouseKeysMaxSpeed + and +mouseKeysCurve + fields change the rate at which the pointer moves when a key which generates a + +SA_MovePtr + action is held down. The +MouseKeysAccel Control describes these +MouseKeysAccel + parameters in more detail. If defined, the +mouseKeysDelay +, +mouseKeysInterval +, +mouseKeysTimeToMax + and +mouseKeysMaxSpeed + values must all be greater than zero, or a +Value + error results. The +mouseKeysCurve + value must be greater than +-1000 + or a +Value + error results. + + + + +If applied, the +accessXOptions + field sets the AccessX options, which are described in detail in +The AccessXKeys Control. If +either one of +XkbStickyKeysMask + and +XkbAccessXFeedbackMask + are set in +changeControls + and +XkbAccessXKeysMask + is not, only a subset of the AccessX options are changed, as described in the +table above; if both are set or if the +AccessXKeys + bit is set in +changeControls +, all of the AccessX options are updated. Any bit in +accessXOptions + whose interpretation is undefined must be zero, or a +Value + error results. + + + + +If applied, the +accessXTimeout +, +accessXTimeoutMask +, +accessXTimeoutValues +, +accessXTimeoutOptionsMask + and +accessXTimeoutOptionsValues + fields change the behavior of the AccessX Timeout control, as described in +The AccessXTimeout +Control. The +accessXTimeout + must be greater than zero, or a +Value + error results. The +accessXTimeoutMask + or +accessXTimeoutValues + fields must specify only legal boolean controls, or a +Value + error results. The +accessXTimeoutOptionsMask + and +accessXTimeoutOptionsValues + fields must contain only legal AccessX options or a +Value + error results. If any bits are set in either values field but not in the +corresponding mask, a +Match + error results. + + + + +If present, the +groupsWrap + field specifies the treatment of out-of-range keyboard groups, as described in +Key Symbol Map. If the + +groupsWrap + field does not specify a legal treatment for out-of-range groups, a +Value + error results. + + + + +If present, the +affectInternalRealMods + field specifies the set of real modifiers to be changed in the internal +modifier definition and the +internalRealMods + field specifies new values for those modifiers. The +affectInternalVirtualMods + and +internalVirtualMods + fields update the virtual modifier component of the modifier definition that +describes the internal modifiers in the same way. If any bits are set in either +values field but not in the corresponding mask field, a +Match + error results. + + + + +If present, the +affectIgnoreLockRealMods + field specifies the set of real modifiers to be changed in the ignore locks +modifier definition and the +ignoreLockRealMods + field specifies new values for those modifiers. The +affectIgnoreLockVirtualMods + and +ignoreLockVirtualMods + fields update the virtual modifier component of the ignore locks modifier +definition in the same way. If any bits are set in either values field but not +in the corresponding mask field, a +Match + error results. + + + + +If present, the +perKeyRepeat + array specifies the repeat behavior of the individual keyboard keys. The +corresponding core protocol or input extension per-key autorepeat information +is updated to reflect any changes specified in +perKeyRepeat +. If the bits that correspond to any out-of-range keys are set in +perKeyRepeat +, a +Value + error results. + + + + +If present, the +affectEnabledControls + and +enabledControls + field enable and disable global boolean controls. Any controls set in both +fields are enabled; any controls that are set in +affectEnabledControls + but not in +enabledControls + are disabled. Controls that are not set in either field are not affected. If +any controls are specified in +enabledControls + but not in +affectEnabledControls +, a +Match + error results. If either field contains anything except boolean controls, a + +Value + error results. + + + + + +Querying and Changing the Keyboard Mapping + + + + + + + + + XkbGetMap + + + + + deviceSpec: KB_DEVICESPEC + + + +full, partial: KB_MAPPARTMASK + + + +firstType, nTypes: CARD8 + + + +firstKeySym, firstKeyAction: KEYCODE + + + +nKeySyms, nKeyActions: CARD8 + + + +firstKeyBehavior,firstKeyExplicit: KEYCODE + + + +nKeyBehaviors,nKeyExplicit: CARD8 + + + +firstModMapKey,firstVModMapKey: KEYCODE + + + +nModMapKeys, nVModMapKeys: CARD8 + + + +virtualMods: KB_VMODMASK + + + + +deviceID: CARD8 + + + + +minKeyCode, maxKeyCode: KEYCODE + + + + +present: KB_MAPPARTMASK + + + + +firstType, nTypes, nTotalTypes: CARD8 + + + + +firstKeySym, firstKeyAction: KEYCODE + + + + +nKeySyms, nKeyActions: CARD8 + + + + +totalSyms, totalActions: CARD16 + + + + +firstKeyBehavior, firstKeyExplicit: KEYCODE + + + + +nKeyBehaviors, nKeyExplicit: CARD8 + + + + +totalKeyBehaviors, totalKeyExplicit: CARD8 + + + + +firstModMapKey, firstVModMapKey: KEYCODE + + + + +nModMapKeys, nVModMapKeys: CARD8 + + + + +totalModMapKeys, totalVModMapKeys: CARD8 + + + + +virtualMods: KB_VMODMASK + + + + +typesRtrn: LISTofKB_KEYTYPE + + + + +symsRtrn: LISTofKB_KEYSYMMAP + + + + +actsRtrn: { count: LISTofCARD8, acts: LISTofKB_ACTION } + + + + +behaviorsRtrn: LISTofKB_SETBEHAVIOR + + + + +vmodsRtrn: LISTofSETofKEYMASK + + + + +explicitRtrn: LISTofKB_SETEXPLICIT + + + + +modmapRtrn: LISTofKB_KEYMODMAP + + + + +vmodMapRtrn: LISTofKB_KEYVMODMAP + + + + +Errors: +Keyboard +, +Value +, +Match +, +Alloc + + + + + + + +This request returns the indicated components of the server and client maps of +the keyboard specified by +deviceSpec +. The +full + mask specifies the map components to be returned in full; the +partial + mask specifies the components for which some subset of the legal elements are +to be returned. The server returns a +Match + error if any component is specified in both +full + and +partial +, or a +Value + error if any undefined bits are set in either +full + or +partial +. + + + + +Each bit in the +partial + mask controls the interpretation of one or more of the other request fields, +as follows: + + + + + + + + + + + Bit in the Partial Mask + Type + Corresponding Field(s) + + + + + +XkbKeyTypesMask + + key types + +firstType +, +nTypes + + + + +XkbKeySymsMask + + keycodes + +firstKeySym +, +nKeySyms + + + + +XkbKeyActionsMask + + keycodes + +firstKeyAction +, +nKeyActions + + + + +XkbKeyBehaviorsMask + + keycodes + +firstKeyBehavior +, +nKeyBehaviors + + + + +XkbExplicitComponentsMask + + keycodes + +firstKeyExplicit +, +nKeyExplicit + + + + +XkbModifierMapMask + + keycodes + +firstModMapKey +, +nModMapKeys + + + + +XkbVirtualModMapMask + + keycodes + +firstVModMapKey +, +nVModMapKeys + + + + +XkbVirtualModsMask + + virtual modifiers + +virtualMods + + + + + + + +If any of these keyboard map components are specified in +partial +, the corresponding values must specify a valid subset of the requested +components or this request reports a +Value + error. If a keyboard map component is not specified in +partial +, the corresponding fields must contain zeroes, or a +Match + error results. + + + + +If any error is generated, the request aborts and does not report any values. + + + + +On successful return, the +deviceID + field reports the X input extension device ID of the keyboard for which +information is being returned, or +0 + if the server does not support the X input extension. The +minKeyCode + and +maxKeyCode + return values report the minimum and maximum keycodes that are legal for the +keyboard in question. + + + + +The +present + return value lists all of the keyboard map components contained in the reply. +The bits in +present + affect the interpretation of the other return values as follows: + + + + +If +XkbKeyTypesMask + is set in +present +: + + + + + +firstType + and +nTypes + specify the types reported in the reply. + + + + +nTotalTypes + reports the total number of types defined for the keyboard + + + + +typesRtrn + has +nTypes + elements of type KB_KEYTYPE which describe consecutive key types starting from + +firstType +. + + + + + +If +XkbKeySymsMask + is set in +present +: + + + + + +firstKeySym + and +nKeySyms + specify the subset of the keyboard keys for which symbols will be reported. + + + + +totalSyms + reports the total number of keysyms bound to the keys returned in this reply. + + + + +symsRtrn + has +nKeySyms + elements of type KB_KEYSYMMAP, which describe the symbols bound to consecutive +keys starting from +firstKeySym +. + + + + + +If +XkbKeyActionsMask + is set in +present +: + + + + + +firstKeyAction + and +nKeyActions + specify the subset of the keys for which actions are reported. + + + + +totalActions + reports the total number of actions bound to the returned keys. + + + + The +count +field of the +actsRtrn + return value has +nKeyActions + entries of type CARD8, which specify the number of actions bound to +consecutive keys starting from +firstKeyAction +. The +acts + field of +actsRtrn + has +totalActions + elements of type KB_ACTION and specifies the actions bound to the keys. + + + + + +If +XkbKeyBehaviorsMask + is set in +present +: + + + + + The +firstKeyBehavior + and +nKeyBehaviors + return values report the range of keyboard keys for which behaviors will be +reported. + + + + The +totalKeyBehaviors + return value reports the number of keys in the range to be reported that have +non-default values. + + + + The +behaviorsRtrn + value has +totalKeyBehaviors + entries of type KB_BEHAVIOR. Each entry specifies a key in the range for which +behaviors are being reported and the behavior associated with that key. Any +keys in that range that do not have an entry in +behaviorsRtrn + have the default behavior, +KB_Default +. + + + + + +If +XkbExplicitComponentsMask + is set in +present +: + + + + + The +firstKeyExplicit + and +nKeyExplicit + return values report the range of keyboard keys for which the set of explicit +components is to be returned. + + + + The +totalKeyExplicit + return value reports the number of keys in the range specified by +firstKeyExplicit + and +nKeyExplicit + that have one or more explicit components. + + + + The +explicitRtrn + return value has +totalKeyExplicit + entries of type KB_KEYEXPLICIT. Each entry specifies the a key in the range +for which explicit components are being reported and the explicit components +that are bound to it. Any keys in that range that do not have an entry in + +explicitRtrn + have no explicit components. + + + + + +If +XkbModifierMapMask + is set in +present +: + + + + + The +firstModMapKey + and +nModMapKeys + return values report the range of keyboard keys for which the modifier map is +to be reported. + + + + The +totalModMapKeys + return value reports the number of keys in the range specified by +firstModMapKey + and +nModMapKeys + that are bound with to one or more modifiers. + + + + The +modmapRtrn + return value has +totalModMapKeys + entries of type KB_KEYMODMAP. Each entry specifies the a key in the range for +which the modifier map is being reported and the set of modifiers that are +bound to that key. Any keys in that range that do not have an entry in + +modmapRtrn + are not associated with any modifiers by the modifier mapping. + + + + + +If +XkbVirtualModMapMask + is set in +present +: + + + + + The +firstVModMapKey + and +nVModMapKeys + return values report the range of keyboard keys for which the virtual modifier +map is to be reported. + + + + The +totalVModMapKeys + return value reports the number of keys in the range specified by +firstVModMapKey + and +nVModMapKeys + that are bound with to or more virtual modifiers. + + + + The +vmodmapRtrn + return value has +totalVModMapKeys + entries of type KB_KEYVMODMAP. Each entry specifies the a key in the range for +which the virtual modifier map is being reported and the set of virtual +modifiers that are bound to that key. Any keys in that range that do not have +an entry in +vmodmapRtrn + are not associated with any virtual modifiers, + + + + + +If +XkbVirtualModsMask + is set in +present +: + + + + + The +virtualMods + return value is a mask with one bit per virtual modifier which specifies the +virtual modifiers for which a set of corresponding real modifiers is to be +returned. + + + + The +vmodsRtrn + return value is a list with one entry of type KEYBUTMASK for each virtual +modifier that is specified in +virtualMods +. The entries in +vmodsRtrn + contain the real modifier bindings for the specified virtual modifiers, +beginning with the lowest-numbered virtual modifier that is present in + +virtualMods + and proceeding to the highest. + + + + + +If any of these bits are not set in +present +, the corresponding numeric fields all have the value zero, and the +corresponding lists are all of length zero. + + + + + + + + + + + XkbSetMap + + + + + deviceSpec: KB_DEVICESPEC + + + +flags: { +SetMapResizeTypes, SetMapRecomputeActions +} + + + +present: KB_MAPPARTMASK + + + +minKeyCode, maxKeyCode: KEYCODE + + + +firstType, nTypes: CARD8 + + + +firstKeySym, firstKeyAction: KEYCODE + + + +nKeySyms, nKeyActions: CARD8 + + + +totalSyms, totalActions: CARD16 + + + +firstKeyBehavior, firstKeyExplicit: KEYCODE + + + +nKeyBehaviors, nKeyExplicit: CARD8 + + + +totalKeyBehaviors, totalKeyExplicit: CARD8 + + + +firstModMapKey, firstVModMapKey: KEYCODE + + + +nModMapKeys, nVModMapKeys: CARD8 + + + +totalModMapKeys, totalVModMapKeys: CARD8 + + + +virtualMods: VMODMASK + + + +types: LISTofKB_KEYTYPE + + + +syms: LISTofKB_KEYSYMMAP + + + +actions: { count: LISTofCARD8, actions: LISTofKB_ACTION } + + + +behaviors: LISTofKB_BEHAVIOR + + + +vmods: LISTofKEYMASK + + + +explicit: LISTofKB_EXPLICIT + + + +modmap: LISTofKB_KEYMODMAP + + + +vmodmap: LISTofKB_KEYVMODMAP + + + + Errors: +Keyboard +, +Value +, +Match +, +Alloc + + + + + + + + +This request changes the indicated parts of the keyboard specified by +deviceSpec +. With XKB, the effect of a key release is independent of the keyboard mapping +at the time of the release, so this request can be processed regardless of the +logical state of the modifier keys at the time of the request. + + + + +The +present + field specifies the keyboard map components contained to be changed. The bits +in +present + affect the interpretation of the other fields as follows: + + + + +If +XkbKeyTypesMask + is set in +present +, +firstType + and +nTypes + specify a subset of the key types bound to the keyboard to be changed or +created. The index of the first key type to be changed must be less than or +equal to the unmodified length of the list of key types or a +Value + error results. + + + + +If +XkbKeyTypesMask + is set in +present + and +SetMapResizeTypes + is set in +flags +, the server resizes the list of key types bound to the keyboard so that the +last key type specified by this request is the last element in the list. If the +list of key types is shrunk, any existing key definitions that use key types +that eliminated are automatically assigned key types from the list of canonical +key types as described in +Assigning Types To Groups of Symbols for a Key. The list of key types +bound to a keyboard must always include the four canonical types and cannot +have more than +XkbMaxTypesPerKey + (32) types; any attempt to reduce the number of types bound to a keyboard +below four or above +XkbMaxTypesPerKey + causes a +Value + error. Symbolic names for newly created key types or levels within a key type +are initialized to +None +. + + + + +If +XkbKeyTypesMask + is set in +present +, the types list has +nTypes + entries of type KB_KEYTYPE.Each key type specified in +types + must be valid or a +Value + error results. To be valid a key type definition must meet the following +criteria: + + + + + The +numLevels + for the type must be greater than zero. + + + + If the key type is +ONE_LEVEL + (i.e. index zero in the list of key types), +numLevels + must be one. + + + + If the key type is +TWO_LEVEL + or +KEYPAD +, or +ALPHABETIC + (i.e. index one, two, or three in the lest of key types) group width must be +two. + + + + + +Each key type in types must also be internally consistent, or a Match error +results. To be internally consistent, a key type definition must meet the +following criteria: + + + + + Each map entry must specify a resulting level that is legal for the +type. + + + + Any real or virtual modifiers specified in any of the map entries must +also be specified in the +mods + for the type. + + + + + +If +XkbKeySymsMask + is set in +present +, +firstKeySym + and +nKeySyms + specify a subset of the keyboard keys to which new symbols are to be assigned +and +totalSyms + specifies the total number of symbols to be assigned to those keys. If any of +the keys specified by +firstKeySym + and +nKeySyms + are not legal, a +Match + error results. The +syms + list has +nKeySyms + elements of type KB_KEYSYMMAP. Each key in the resulting key symbol map must +be valid and internally consistent or a +Value + error results. To be valid and internally consistent, a key symbol map must +meet the following criteria: + + + + + The key type indices must specify legal result key types. + + + + The number of groups specified by +groupInfo + must be in the range +0…4 +. + + + + The +width + of the key symbol map must be equal to +numLevels + of the widest key type bound to the key. + + + + The number of symbols, +nSyms +, must equal the number of groups times +width +. + + + + + +If +XkbKeyActionsMask + is set in +present +, +firstKeyAction + and +nKeyActions + specify a subset of the keyboard keys to which new actions are to be assigned +and +totalActions + specifies the total number of actions to be assigned to those keys. If any of +the keys specified by +firstKeyAction + and +nKeyActions + are not legal, a +Match + error results. The +count + field of the +actions + return value has +nKeyActions + elements of type CARD8; each element of +count + specifies the number of actions bound to the corresponding key. The +actions + list in the +actions + field has +totalActions + elements of type KB_ACTION. These actions are assigned to each target key in +turn, as specified by +count +. The list of actions assigned to each key must either be empty or have exactly +as many actions as the key has symbols, or a +Match + error results. + + + + +If +XkbKeyBehaviorsMask + is set in +present +, +firstKeyBehavior + and +nKeyBehaviors + specify a subset of the keyboard keys to which new behaviors are to be +assigned, and +totalKeyBehaviors + specifies the total number of keys in that range to be assigned non-default +behavior. If any of the keys specified by +firstKeyBehavior + and +nKeyBehaviors + are not legal, a +Match + error results. The +behaviors + list has +totalKeyBehaviors + elements of type KB_BEHAVIOR; each entry of +behaviors + specifies a key in the specified range and a new behavior for that key; any +key that falls in the range specified by +firstBehavior + and +nBehaviors + for which no behavior is specified in +behaviors + is assigned the default behavior, +KB_Default +. The new behaviors must be legal, or a +Value + error results. To be legal, the behavior specified in the +XkbSetMap + request must: + + + + + Specify a key in the range indicated by +firstKeyBehavior + and +nKeyBehaviors +. + + + + Not specify the +permanent + flag; permanent behaviors cannot be set or changed using the +XkbSetMap + request. + + + + If present, the +KB_Overlay1 + and +KB_Overlay2 + behaviors must specify a keycode for the overlay key that is valid for the +current keyboard. + + + + If present, the +KB_RadioGroup + behavior must specify a legal index (0…31) for the radio group to which the +key belongs. + + + + + +Key behaviors that are not recognized by the server are accepted but ignored. +Attempts to replace a "permanent" behavior are silently ignored; the behavior +is not replaced, but not error is generated and any other components specified +in the +XkbSetMap + request are updated, as appropriate. + + + + +If +XkbVirtualModsMask + is set in +present +, +virtualMods + is a mask which specifies the virtual modifiers to be rebound. The +vmods + list specifies the real modifiers that are bound to each of the virtual +modifiers specified in +virtualMods +, starting from the lowest numbered virtual modifier and progressing upward. +Any virtual modifier that is not specified in +virtualMods + has no corresponding entry in +vmods +, so the +vmods + list has one entry for each bit that is set in +virtualMods +. + + + + +If +XkbExplicitComponentsMask + is set in +present +, +firstKeyExplicit + and +nKeyExplicit + specify a subset of the keyboard keys to which new explicit components are to +be assigned, and +totalKeyExplicit + specifies the total number of keys in that range that have at least one +explicit component. The +explicit + list has +totalKeyExplicit + elements of type KB_KEYEXPLICIT; each entry of +explicit + specifies a key in the specified range and a new set of explicit components +for that key. Any key that falls in the range specified by +firstKeyExplicit + and +nKeyExplicit + that is not assigned some value in +explicit + has no explicit components. + + + + +If +XkbModifierMapMask + is set in +present +, +firstModMapKey + and +nModMapKeys + specify a subset of the keyboard keys for which new modifier mappings are to +be assigned, and +totalModMapKeys + specifies the total number of keys in that range to which at least one +modifier is bound. The +modmap + list has +totalModMapKeys + elements of type KB_KEYMODMAP; each entry of +modmap + specifies a key in the specified range and a new set of modifiers to be +associated with that key. Any key that falls in the range specified by + +firstModMapKey + and +nModMapKeys + that is not assigned some value in +modmap + has no associated modifiers. + + + + +If the modifier map is changed by the +XkbSetMap + request, any changes are also reflected in the core protocol modifier mapping. +Changes to the core protocol modifier mapping are reported to XKB-unaware +clients via +MappingNotify + events and can be retrieved with the core protocol +GetModifierMapping + request. + + + + +If +XkbVirtualModMapMask + is set in +present +, +firstVModMapKey + and +nVModMapKeys + specify a subset of the keyboard keys for which new modifier mappings are to +be assigned, and +totalVModMapKeys + specifies the total number of keys in that range to which at least one virtual +modifier is bound. The +vmodmap + list has +totalVModMapKeys + elements of type KB_KEYVMODMAP; each entry of +vmodmap + specifies a key in the specified range and a new set of virtual modifiers to +be associated with that key. Any key that falls in the range specified by + +firstVModMapKey + and +nVModMapKeys + that is not assigned some value in +vmodmap + has no associated virtual modifiers. + + + + +If the resulting keyboard map is legal, the server updates the keyboard map. +Changes to some keyboard components have indirect effects on others: + + + + +If the +XkbSetMapRecomputeActions + bit is set in +flags +, the actions associated with any keys for which symbol or modifier bindings +were changed by this request are recomputed as described in +Assigning Actions To Keys. Note +that actions are recomputed +after +any actions specified in this request are bound to keys, so the actions +specified in this request might be clobbered by the automatic assignment of +actions to keys. + + + + +If the group width of an existing key type is changed, the list of symbols +associated with any keys of the changed type might be resized accordingly. If +the list increases in size, any unspecified new symbols are initialized to + +NoSymbol +. + + + + +If the list of actions associated with a key is not empty, changing the key +type of the key resizes the list. Unspecified new actions are calculated by +applying any keyboard symbol interpretations to the corresponding symbols. + + + + +The number of groups global to the keyboard is always equal to the largest +number of groups specified by any of the key symbol maps. Changing the number +of groups in one or more key symbol maps may change the number of groups global +to the keyboard. + + + + +Assigning key behavior +KB_RadioGroup + to a key adds that key as a member of the specified radio group. Changing a +key with the existing behavior +KB_RadioGroup + removes that key from the group. Changing the elements of a radio group can +cause synthetic key press or key release events if the key to be added or +removed is logically down at the time of the change. + + + + +Changing a key with behavior +KB_Lock + causes a synthetic key release event if the key is logically but not +physically down at the time of the change. + + + + +This request sends an +XkbMapNotify + event which reflects both explicit and indirect map changes to any interested +clients. If any symbolic names are changed, it sends a +XkbNamesNotify + reflecting the changes to any interested clients. XKB-unaware clients are +notified of keyboard changes via core protocol +MappingNotify + events. + + + + +Key press and key release events caused by changing key behavior may cause +additional +XkbStateNotify + or +XkbIndicatorStateNotify + events. + + + + + +Querying and Changing the Compatibility Map + + + + + + + + + XkbGetCompatMap + + + + + deviceSpec: KB_DEVICESPEC + + + +groups: KB_GROUPMASK + + + +getAllSI: BOOL + + + +firstSI, nSI: CARD16 + + + + +deviceID: CARD8 + + + + +groupsRtrn: KB_GROUPMASK + + + + +firstSIRtrn, nSIRtrn, nTotalSI: CARD16 + + + + +siRtrn: LISTofKB_SYMINTERP + + + + +groupRtrn: LISTofKB_MODDEF + + + Errors: +Keyboard +, +Match +, +Alloc + + + + + + + + +This request returns the listed compatibility map components for the keyboard +specified by +deviceSpec +. If +deviceSpec + does not specify a valid keyboard device, a +Keyboard + Error results. On return, +deviceID + reports the input extension identifier of the keyboard device or +0 + if the server does not support the input extension. + + + + +If +getAllSI + is +False +, +firstSI + and +nSI + specify a subset of the symbol interpretations to be returned; if used, + +nSI + must be greater than +0 + and all of the elements specified by +firstSI + and +nSI + must be defined or a +Value + error results. If +getAllSyms + is +True +, the server ignores +firstSym + and +nSyms + and returns all of the symbol interpretations defined for the keyboard. + + + + +The +groups + mask specifies the groups for which compatibility maps are to be returned. + + + + +The +nTotalSI + return value reports the total number of symbol interpretations defined for +the keyboard. On successful return, the +siRtrn + return list contains the definitions for +nSIRtrn + symbol interpretations beginning at +firstSIRtrn +. + + + + +The +groupRtrn + return values report the entries in the group compatibility map for any groups +specified in the +groupsRtrn + return value. + + + + + + + + + + + XkbSetCompatMap + + + + + deviceSpec: KB_DEVICESPEC + + + +recomputeActions: BOOL + + + +truncateSI: BOOL + + + +groups: KB_GROUPMASK + + + +firstSI, nSI: CARD16 + + + +si: LISTofKB_SYMINTERPRET + + + +groupMaps: LISTofKB_MODDEF + + + + Errors: +Keyboard +, +Match +, +Value +, +Alloc + + + + + + + + +This request changes a specified subset of the compatibility map of the +keyboard indicated by +deviceSpec +. If +deviceSpec + specifies an invalid device, a +Keyboard + error results and nothing is changed. + + + + +The +firstSI + and +nSI + fields specify a subset of the keyboard symbol interpretations to be changed. +The +si + list specifies new values for each of the interpretations in that range. + + + + +The first symbol interpretation to be changed, +firstSI +, must be less than or equal to the unchanged length of the list of symbol +interpretations, or a +Value + error results. If the resulting list would be larger than the unchanged list, +it server list of symbol interpretations is automatically increased in size. +Otherwise, if +truncateSyms + is +True +, the server deletes any symbol interpretations after the last element changed +by this request, and reduces the length of the list accordingly. + + + + +The +groupMaps + fields contain new definitions for a subset of the group compatibility map; + +groups + specifies the group compatibility map entries to be updated from +groupMaps +. + + + + + All changed compatibility maps and symbol interpretations must either ignore +group state or specify a legal range of groups, or a +Value + error results. + + + + +If the +recomputeActions + field is +True +, the server regenerates recalculates the actions bound to all keyboard keys by +applying the new symbol interpretations to the entire key symbol map, as +described in Assigning Actions To +Keys. + + + + + +Querying and Changing Indicators + + + + + + + + + XkbGetIndicatorState + + + + + deviceSpec: KB_DEVICESPEC + + + +deviceID: CARD8 +state: KB_INDICATORMASK + + + + Errors: +Keyboard + + + + + + + + +This request reports the current state of the indicators for the keyboard +specified by +deviceSpec +. If +deviceSpec + does not specify a valid keyboard, a +Keyboard + error results. + + + + +On successful return, the +deviceID + field reports the input extension identifier of the keyboard or +0 + if the server does not support the input extension. The +state + return value reports the state of each of the thirty-two indicators on the +specified keyboard. The least-significant bit corresponds to indicator 0, the +most significant bit to indicator 31; if a bit is set, the corresponding +indicator is lit. + + + + + + + + + + + XkbGetIndicatorMap + + + + + deviceSpec: KB_DEVICESPEC + + + +which: KB_INDICATORMASK + + + + +deviceID: CARD8 + + + + +which: KB_INDICATORMASK + + + + +realIndicators: KB_INDICATORMASK + + + + +nIndicators: CARD8 + + + + +maps: LISTofKB_INDICATORMAP + + + Errors: +Keyboard +, +Value + + + + + + + +This request returns a subset of the maps for the indicators on the keyboard +specified by +deviceSpec +. If +deviceSpec + does not specify a valid keyboard device, a +Keyboard + error results. + + + + +The +which + field specifies the subset to be returned; a set bit in the which field +indicates that the map for the corresponding indicator should be returned. + + + + +On successful return, the +deviceID + field reports the input extension identifier of the keyboard or +0 + if the server does not support the input extension. Any indicators specified +in +realIndicators + are actually present on the keyboard; the rest are virtual indicators. Virtual +indicators do not directly cause any visible or audible effect when they change +state, but they do cause +XkbIndicatorStateNotify + events. + + + + +The +maps + return value reports the requested indicator maps. Indicator maps are +described in Indicator Maps + + + + + + + + + + + XkbSetIndicatorMap + + + + + deviceSpec: KB_DEVICESPEC + + + +which: KB_INDICATORMASK + + + +maps: LISTofKB_INDICATORMAP + + + + Errors: +Keyboard +, +Value + + + + + + + + +This request changes a subset of the maps on the keyboard specified by + +deviceSpec +. If +deviceSpec + does not specify a valid keyboard device, a +Keyboard + error results. + + + + +The +which + field specifies the subset to be changed; the +maps + field contains the new definitions. + + + + +If successful, the new indicator maps are applied immediately. If any +indicators change state as a result of the new maps, the server generates + +XkbIndicatorStateNotify + events as appropriate. + + + + + + + + + + + XkbGetNamedIndicator + + + + + deviceSpec: KB_DEVICESPEC + + + +ledClass: KB_LEDCLASSSPEC + + + +ledID: KB_IDSPEC + + + +indicator: ATOM + + + + +deviceID: CARD8 + + + + +supported: BOOL + + + + +indicator: ATOM + + + + +found: BOOL + + + + +on: BOOL + + + + +realIndicator: BOOL + + + + +ndx: CARD8 + + + + +map: KB_INDICATORMAP + + + + Errors: +Keyboard +, +Atom +, +Value + + + + + + + + +This request returns information about the indicator specified by +ledClass +, +ledID +, and +indicator + on the keyboard specified by +deviceSpec +. The +indicator + field specifies the name of the indicator for which information is to be +returned. + + + + +If +deviceSpec + does not specify a device with indicators, a +Keyboard + error results. If +ledClass + does not have the value +DfltXIClass +, +LedFeedbackClass +, or +KbdFeedbackClass +, a +Value + error results. If +ledID + does not have the value +DfltXIId + or specify the identifier of a feedback of the class specified by +ledClass + on the device specified by +deviceSpec +, a +Match + error results. If +indicator + is not a valid ATOM other than +None +, an +Atom + error results. + + + + +This request is always supported with default class and identifier on the core +keyboard device. If the request specifies a device other than the core keyboard +device or a feedback class and identifier other than the defaults, and the +server does not support indicator names or indicator maps for extension +devices, the +supported + return value is +False + and the values of the other fields in the reply are undefined. If the client +which issued the unsupported request has also selected to do so, it will also +receive an +XkbExtensionDeviceNotify + event which reports the attempt to use an unsupported feature, in this case +one or both of +XkbXI_IndicatorMaps + or +XkbXI_IndicatorNames +. + + + + +Otherwise, +supported + is +True + and the +deviceID + field reports the input extension identifier of the keyboard or +0 + if the server does not support the input extension. The +indicator + return value reports the name for which information was requested and the + +found + return value is +True + if an indicator with the specified name was found on the device. + + + + +If a matching indicator was found: + + + + + The +on + return value reports the state of the indicator at the time of the request. + + + + The +realIndicator + return value is +True + if the requested indicator is actually present on the keyboard or +False + if it is virtual. + + + + The +ndx + return value reports the index of the indicator in the requested feedback. + + + + The +map + return value reports the indicator map used by to automatically change the +state of the specified indicator in response to changes in keyboard state or +controls. + + + + + +If no matching indicator is found, the +found + return value is +False +, and the +on +, +realIndicator +, +ndx +, and +map + return values are undefined. + + + + + + + + + + + XkbSetNamedIndicator + + + + + deviceSpec: KB_DEVICESPEC + + + +ledClass: KB_LEDCLASSSPEC + + + +ledID: KB_IDSPEC + + + +indicator: ATOM + + + +setState: BOOL + + + +on: BOOL + + + +setMap: BOOL + + + +createMap: BOOL + + + +map: KB_SETINDICATORMAP + + + + Errors: +Keyboard +, +Atom +, +Access + + + + + + + + +This request changes various aspects of the indicator specified by +ledClass +, +ledID +, and +indicator + on the keyboard specified by +deviceSpec +. The +indicator + argument specifies the name of the indicator to be updated. + + + + +If +deviceSpec + does not specify a device with indicators, a +Keyboard + error results. If +ledClass + does not have the value +DfltXIClass +, +LedFeedbackClass +, or +KbdFeedbackClass +, a +Value + error results. If +ledID + does not have the value +DfltXIId + or specify the identifier of a feedback of the class specified by +ledClass + on the device specified by +deviceSpec +, a +Match + error results. If +indicator + is not a valid ATOM other than +None +, an +Atom + error results. + + + + +This request is always supported with default class and identifier on the core +keyboard device. If the request specifies a device other than the core keyboard +device or a feedback class and identifier other than the defaults, and the +server does not support indicator names or indicator maps for extension +devices, the +supported + return value is +False + and the values of the other fields in the reply are undefined. If the client +which issued the unsupported request has also selected to do so, it will also +receive an +XkbExtensionDeviceNotify + event which reports the attempt to use an unsupported feature, in this case +one or both of +XkbXI_IndicatorMaps + and +XkbXI_IndicatorNames +. + + + + +Otherwise, +supported + is +True + and the +deviceID + field reports the input extension identifier of the keyboard or +0 + if the server does not support the input extension. The +indicator + return value reports the name for which information was requested and the + +found + return value is +True + if an indicator with the specified name was found on the device. + + + + +If no indicator with the specified name is found on the specified device, and +the +createMap + field is +True +, XKB assigns the specified name to the lowest-numbered indicator that has no +name (i.e. whose name is +None +) and applies the rest of the fields in the request to the newly named +indicator. If no unnamed indicators remain, this request reports no error and +has no effect. + + + + +If no matching indicator is found or new indicator assigned this request +reports no error and has no effect. Otherwise, it updates the indicator as +follows: + + + + +If +setMap +is +True +, XKB changes the map for the indicator (see Indicator Maps) to reflect the +values specified in +map +. + + + + +If +setState + is +True +, XKB attempts to explicitly change the state of the indicator to the state +specified in +on +. The effects of an attempt to explicitly change the state of an indicator +depend on the values in the map for that indicator and are not guaranteed to +succeed. + + + + +If this request affects both indicator map and state, it updates the indicator +map before attempting to change its state, so the success of the explicit +change depends on the indicator map values specified in the request. + + + + +If this request changes the indicator map, it applies the new map immediately +to determine the appropriate state for the indicator given the new indicator +map and the current state of the keyboard. + + + + + +Querying and Changing Symbolic Names + + + + + + + + + XkbGetNames + + + + + deviceSpec: KB_DEVICESPEC + + + +which: KB_NAMEDETAILMASK + + + +deviceID: CARD8 +which: KB_NAMESMASK +minKeyCode, maxKeyCode: KEYCODE +nTypes: CARD8 +nKTLevels: CARD16 +groupNames: KB_GROUPMASK +virtualMods: KB_VMODMASK +firstKey: KEYCODE +nKeys: CARD8 +indicators: KB_INDICATORMASK +nRadioGroups, nKeyAliases: CARD8 +present: KB_NAMEDETAILMASK +valueList: LISTofITEMs + + + + Errors: +Keyboard +, +Value + + + + + + + + +This request returns the symbolic names for various components of the keyboard +mapping for the device specified by +deviceSpec +. The +which + field specifies the keyboard components for which names are to be returned. If + +deviceSpec + does not specify a valid keyboard device, a +Keyboard + error results. If any undefined bits in +which + are non-zero, a +Value + error results. + + + + +The +deviceID + return value contains the X Input Extension device identifier of the specified +device or +0 + if the server does not support the input extension. The +present + and +valueList + return values specify the components for which names are being reported. If a +component is specified in +present +, the corresponding element is present in the +valueList +, otherwise that component has length +0 +. The components of the +valueList + appear in the following order, when present:. + + + + + + + + + + + Component + Size + Type + + + + + +XkbKeycodesName + + 1 + ATOM + + + +XkbGeometryName + + 1 + ATOM + + + +XkbSymbolsName + + 1 + ATOM + + + +XkbPhysSymbolsName + + 1 + ATOM + + + +XkbTypesName + + 1 + ATOM + + + +XkbCompatName + + 1 + ATOM + + + +XkbKeyTypeNames + + +nTypes + + LISTofATOM + + + +XkbKTLevelNames + + +nTypes +, + +nKTLevels + + { count: LISTofCARD8, + names: LISTofATOM } + + + +XkbIndicatorNames + + One per bit set in +indicators + + LISTofATOM + + + +XkbVirtualModNames + + One per bit set in +virtualMods + + LISTofATOM + + + +XkbGroupNames + + One per bit set in +groupNames + + LISTofATOM + + + +XkbKeyNames + + +nKeys + + LISTofKB_KEYNAME + + + +XkbKeyAliases + + +nKeyAliases + + LISTofKB_KEYALIAS + + + +XkbRGNames + + +nRadioGroups + + LISTofATOM + + + + + + +If type names are reported, the +nTypes + return value reports the number of types defined for the keyboard, and the +list of key type names in +valueList + has +nTypes + elements. + + + + +If key type level names are reported, the list of key type level names in the + +valueList + has two parts: The +count + array has +nTypes + elements, each of which reports the number of level names reported for the +corresponding key type. The +names + array has +nKTLevels + atoms and reports the names of each type sequentially. The +nKTLevels + return value is always equal to the sum of all of the elements of the + +count + array. + + + + +If indicator names are reported, the +indicators + mask specifies the indicators for which names are defined; any indicators not +specified in +indicators + have the name +None +. The list of indicator names in +valueList + contains the names of the listed indicators, beginning with the +lowest-numbered indicator for which a name is defined and proceeding to the +highest. + + + + +If virtual modifier names are reported, the +virtualMods + mask specifies the virtual modifiers for which names are defined; any virtual +modifiers not specified in +virtualMods + have the name +None +. The list of virtual modifier names in +valueList + contains the names of the listed virtual modifiers, beginning with the +lowest-numbered virtual modifier for which a name is defined and proceeding to +the highest. + + + + +If group names are reported, the +groupNames + mask specifies the groups for which names are defined; any groups not +specified in +groupNames + have the name +None +. The list of group names in +valueList + contains the names of the listed groups, beginning with the lowest-numbered +group for which a name is defined and proceeding to the highest. + + + + +If key names are reported, the +firstKey + and +nKeys + return values specify a range of keys which includes all keys for which names +are defined; any key that does not fall in the range specified by +firstKey + and +nKeys + has the name +NullKeyName +. The list of key names in the +valueList + has +nKeys + entries and specifies the names of the keys beginning at +firstKey +. + + + + +If key aliases are reported, the +nKeyAliases + return value specifies the total number of key aliases defined for the +keyboard. The list of key aliases in +valueList + has +nKeyAliases + entries, each of which reports an alias and the real name of the key to which +it corresponds. + + + + +If radio group names are reported, the +nRadioGroups + return value specifies the number of radio groups on the keyboard for which +names are defined. The list of radio group names in +valueList + reports the names of each group and has +nRadioGroups + entries. + + + + + + + + + + + XkbSetNames + + + + + deviceSpec: KB_DEVICESPEC + + + which: KB_NAMEDETAILMASK + + + +virtualMods: KB_VMODMASK + + + +firstType, nTypes: CARD8 + + + +firstKTLevel, nKTLevels: CARD8 + + + +totalKTLevelNames: CARD16 + + + +indicators: KB_INDICATORMASK + + + +groupNames: KB_GROUPMASK + + + +nRadioGroups: CARD8 + + + +firstKey: KEYCODE + + + +nKeys, nKeyAliases: CARD8 + + + +valueList: LISTofITEMs + + + + Errors: +Keyboard +, +Atom +, +Value +, +Match +, +Alloc + + + + + + + + +This request changes the symbolic names for the requested components of the +keyboard specified by +deviceSpec +. The +which + field specifies the components for which one or more names are to be updated. +If +deviceSpec + does not specify a valid keyboard device, a +Keyboard + error results. If any undefined bits in +which + are non-zero, a +Value + error results. If any error (other than +Alloc + or +Implementation +) occurs, this request returns without modifying any names. + + + + +The +which + and +valueList + fields specify the components to be changed; the type of each +valueList + entry, the order in which components appear in the +valueList + when specified, and the correspondence between components in +which + and the entries in the +valueList + are as specified for the +XkbGetNames + request. + + + + +If keycodes, geometry, symbols, physical symbols, types or compatibility map +names are to be changed, the corresponding entries in the +valueList + must have the value +None + or specify a valid ATOM, else an +Atom + error occurs. + + + + +If key type names are to be changed, the +firstType + and +nTypes + fields specify a range of types for which new names are supplied, and the list +of key type names in +valueList + has +nTypes + elements. Names for types that fall outside of the range specified by + +firstType + and +nTypes + are not affected. If this request specifies names for types that are not +present on the keyboard, a +Match + error results. All of the type names in the +valueList + must be valid ATOMs or have the value +None +, or an +Atom + error results. + + + + +The names of the first four keyboard types are specified by the XKB extension +and cannot be changed; including any of the canonical types in this request +causes an +Access + error, as does trying to assign the name reserved for a canonical type to one +of the other key types. + + + + +If key type level names are to be changed, the +firstKTLevel + and +nKTLevels + fields specify a range of key types for which new level names are supplied, +and the list of key type level names in the +valueList + has two parts: The +count + array has +nKTLevels + elements, each of which specifies the number of levels for which names are +supplied on the corresponding key type; any levels for which no names are +specified are assigned the name +None +. The +names + array has +totalKTLevels + atoms and specifies the names of each type sequentially. The +totalKTLevels + field must always equal the sum of all of the elements of the +count + array. Level names for types that fall outside of the specified range are not +affected. If this request specifies level names for types that are not present +on the keyboard, or if it specifies more names for a type than the type has +levels, a +Match + error results. All specified type level names must be +None + or a valid ATOM or an +Atom + error results. + + + + +If indicator names are to be changed, the +indicators + mask specifies the indicators for which new names are specified; the names for +indicators not specified in +indicators + are not affected. The list of indicator names in +valueList + contains the new names for the listed indicators, beginning with the +lowest-numbered indicator for which a name is defined and proceeding to the +highest. All specified indicator names must be a valid ATOM or +None +, or an +Atom + error results. + + + + +If virtual modifier names are to be changed, the +virtualMods + mask specifies the virtual modifiers for which new names are specified; names +for any virtual modifiers not specified in +virtualMods + are not affected. The list of virtual modifier names in +valueList + contains the new names for the specified virtual modifiers, beginning with the +lowest-numbered virtual modifier for which a name is defined and proceeding to +the highest. All virtual modifier names must be valid ATOMs or +None +, or an +Atom + error results. + + + + +If group names are to be changed, the +groupNames + mask specifies the groups for which new names are specified; the name of any +group not specified in +groupNames + is not changed. The list of group names in +valueList + contains the new names for the listed groups, beginning with the +lowest-numbered group for which a name is defined and proceeding to the +highest. All specified group names must be a valid ATOM or +None +, or an +Atom + error results. + + + + +If key names are to be changed, the +firstKey + and +nKeys + fields specify a range of keys for which new names are defined; the name of +any key that does not fall in the range specified by +firstKey + and +nKeys + is not changed. The list of key names in the +valueList + has +nKeys + entries and specifies the names of the keys beginning at +firstKey +. + + + + +If key aliases are to be changed, the +nKeyAliases + field specifies the length of a new list of key aliases for the keyboard. The +list of key aliases can only be replaced in its entirety; it cannot be +replaced. The list of key aliases in +valueList + has +nKeyAliases + entries, each of which reports an alias and the real name of the key to which +it corresponds. + + + + +XKB does not check key names or aliases for consistency and validity, so +applications should take care not to assign duplicate names or aliases + + + + +If radio group names are to be changed, the +nRadioGroups + field specifies the length of a new list of radio group names for the +keyboard. There is no way to edit the list of radio group names; it can only be +replaced in its entirety. The list of radio group names in +valueList + reports the names of each group and has +nRadioGroups + entries. If the list of radio group names specifies names for more radio +groups than XKB allows (32), a +Match + error results. All specified radio group names must be valid ATOMs or have the +value +None +, or an +Atom + error results. + + + + + +Querying and Changing Keyboard Geometry + + + + + + + + + XkbGetGeometry + + + + + deviceSpec: KB_DEVICESPEC + + + + +name: ATOM + + + +deviceID: CARD8 + + + + +name: ATOM + + + + +found: BOOL + + + + +widthMM, heightMM: CARD16 + + + + +baseColorNdx, labelColorNdx: CARD8 + + + + +properties: LISTofKB_PROPERTY + + + + +colors: LISTofSTRING8 + + + + +shapes: LISTofKB_SHAPE + + + + +sections: LISTofKB_SECTION + + + + +doodads: LISTofKB_DOODAD + + + + +keyAliases: LISTofKB_KEYALIAS + + + Errors: +Keyboard + + + + + + + +This request returns a description of the physical layout of a keyboard. If the + +name + field has the value +None +, or if name is identical to the name of the geometry for the keyboard +specified by +deviceSpec +, this request returns the geometry of the keyboard specified by +deviceSpec +; otherwise, if +name + is a valid atom other than +None +, the server returns the keyboard geometry description with that name in the +server database of keyboard components (see The Server Database of Keyboard +Components) if one exists. If +deviceSpec + does not specify a valid keyboard device, a +Keyboard + error results. If +name + has a value other than +None + or a valid ATOM, an +Atom + error results. + + + + +On successful return, the +deviceID + field reports the X Input extension identifier of the keyboard device +specified in the request, or +0 + if the server does not support the input extension. + + + + +The +found + return value reports whether the requested geometry was available. If + +found + is +False +, no matching geometry was found and the remaining fields in the request reply +are undefined; if +found + is +True +, the remaining fields of the reply describe the requested keyboard geometry. +The interpretation of the components that make up a keyboard geometry is +described in detail in Keyboard +Geometry + + + + + + + + + + + XkbSetGeometry + + + + + deviceSpec: KB_DEVICESPEC + + + +name: ATOM + + + +widthMM, heightMM, CARD16 + + + +baseColorNdx, labelColorNdx: CARD8 + + + +shapes: LISTofKB_SHAPE + + + +sections: LISTofKB_SECTION + + + +properties: LISTofKB_PROPERTY + + + +colors: LISTofSTRING8 + + + +doodads: LISTofKB_DOODAD + + + +keyAliases: LISTofKB_KEYALIAS + + + + Errors: +Keyboard +, +Atom +, +Value + + + + + + + + +This request changes the reported description of the geometry for the keyboard +specified by +deviceSpec +. If deviceSpec does not specify a valid keyboard device, a +Keyboard + error results. + + + + +The +name + field specifies the name of the new keyboard geometry and must be a valid ATOM +or an +Atom + error results. The new geometry is not added to the server database of +keyboard components, but it can be retrieved using the +XkbGetGeometry + request for as long as it is bound to the keyboard. The keyboard geometry +symbolic name is also updated from the name field, and an +XkbNamesNotify + event is generated, if necessary. + + + + +The list of +colors + must include at least two definitions, or a +Value + error results. All color definitions in the geometry must specify a legal +color (i.e. must specify a valid index for one of the entries of the +colors + list) or a +Match + error results. The +baseColorNdx + and the +labelColorNdx + must be different or a +Match + error results. + + + + +The list of +shapes + must include at least one shape definition, or a +Value + error results. If any two shapes have the same name, a +Match + error result. All doodads and keys which specify shape must specify a valid +index for one of the elements of the +shapes + list, or a +Match + error results. + + + + +All section, shape and doodad names must be valid ATOMs or an +Atom + error results; the constant +None + is not permitted for any of these components. + + + + +All doodads must be of a known type; XKB does not support "private" doodad +types. + + + + +If, after rotation, any keys or doodads fall outside of the bounding box for a +section, the bounding box is automatically adjusted to the minimum size which +encloses all of its components. + + + + +If, after adjustment and rotation, the bounding box of any section or doodad +extends below zero on either the X or Y axes, the entire geometry is translated +so that the minimum extent along either axis is zero. + + + + +If, after rotation and translation, any keyboard components fall outside of the +rectangle specified by +widthMM + and +heightMM +, the keyboard dimensions are automatically resized to the minimum bounding box +that surrounds all components. Otherwise, the width and height of the keyboard +are left as specified. + + + + +The +under + field of any overlay key definitions must specify a key that is in the section +that contains the overlay key, or a +Match + error results. This request does not check the value of the +over + field of an overlay key definition, so applications must be careful to avoid +conflicts with actual keys. + + + + +This request does not verify that key names or aliases are unique. It also does +not verify that all key names specified in the geometry are bound to some +keycode or that all keys that are named in the keyboard definition are also +available in the geometry. Applications should make sure that keyboard geometry +has no internal conflicts and is consistent with the other components of the +keyboard definition, but XKB does not check for or guarantee it. + + + + + +Querying and Changing Per-Client Flags + + + + + + + + + XkbPerClientFlags + + + + + deviceSpec: KB_DEVICESPEC + + + +change: KB_PCFMASK + + + +value: KB_PCFMASK + + + +ctrlsToChange: KB_BOOLCTRLMASK + + + +autoCtrls: KB_BOOLCTRLMASK + + + +autoCtrlValues: KB_BOOLCTRLMASK + + + +deviceID: CARD8 +supported: KB_PCFMASK +value: KB_PCFMASK +autoCtrls: KB_BOOLCTRLMASK +autoCtrlValues: KB_BOOLCTRLMASK +where: KB_PCFMASK: + + + + Errors: +Keyboard +, +Value +, +Match +, +Alloc + + + + + + + + +Changes the client specific flags for the keyboard specified by +deviceSpec +. Reports a +Keyboard + error if +deviceSpec + does not specify a valid keyboard device. + + + + +Any flags specified in +change + are set to the corresponding values in +value +, provided that the server supports the requested control. Legal +per-client-flags are: + + + + + + + + + + Flag… + Described in… + + + + + +XkbPCF_DetectableAutorepeat + + Detectable +Autorepeat + + + +XkbPCF_GrabsUseXKBStateMask + + Setting a Passive Grab +for an XKB State + + + +XkbPCF_AutoResetControlsMask + + Automatic Reset of +Boolean Controls + + + +XkbPCF_LookupStateWhenGrabbed + + Effects of XKB on Core +Protocol Events + + + +XkbPCF_SendEventUsesXKBState + + Sending Events to +Clients + + + + + + +If +PCF_AutoResetControls + is set in both +change + and +value +, the client’s mask of controls to be changed is updated from +ctrlsToChange +, +autoCtrls +, and +autoCtrlValues +. Any controls specified in +ctrlsToChange + are modified in the auto-reset controls mask for the client; the corresponding +bits from the +autoCtrls + field are copied into the auto-reset controls mask and the corresponding bits +from +autoCtrlValues + are copied into the auto-reset controls state values. If any controls are +specified in +autoCtrlValues + but not in +autoCtrls +, a +Match + error results. If any controls are specified in +autoCtrls + but not in +ctrlsToChange +, a +Match + error results. + + + + +If +PCF_AutoResetControls + is set in +change + but not in +value +, the client’s mask of controls to be changed is reset to all zeroes (i.e. +the client does not change any controls when it exits). + + + + +This request reports a +Match + error if a bit is set in any of the value masks but not in the control mask +that governs it or a +Value + error if any undefined bits are set in any of the masks. + + + + +On successful return, the +deviceID + field reports the X Input extension identifier of the keyboard, or +0 + if the server does not support the X Input Extension. + + + + +The +supported + return value reports the set of per-client flags that are supported by the +server; in this version of XKB, only the +XkbPCF_DetectableAutorepeat + per-client flag is optional; all other per-client flags must be supported. + + + + +The +value + return value reports the current settings of all per-client flags for the +specified keyboard. The +autoCtrls + return value reports the current set of controls to be reset when the client +exits, while the +autoCtrlValues + return value reports the state to which they should be set. + + + + + +Using the Server’s Database of Keyboard Components + + + + + + + + + XkbListComponents + + + + + deviceSpec: KB_DEVICESPEC + + + +maxNames: CARD16 + + + +keymapsSpec: STRING8 + + + +keycodesSpec: STRING8 + + + +typesSpec: STRING8 + + + +compatMapSpec: STRING8 + + + +symbolsSpec: STRING8 + + + +geometrySpec: STRING8 + + + + +deviceID: CARD8 + + + + +extra: CARD16 + + + + +keymaps,keycodes,types,compatMaps: LISTofKB_COMPONENTNAME + + + + +symbols, geometries: LISTofKB_COMPONENTNAME + + + Where: + + + KB_COMPONENTNAME { hints: CARD8, name: +STRING8 } + + + Errors: +Keyboard +, +Alloc + + + + + + + +This request returns one or more lists of keyboard components that are +available from the X server database of keyboard components for the device +specified by +deviceSpec +. The X server is allowed, but not required or expected, to maintain separate +databases for each keyboard device. A +Keyboard + error results if +deviceSpec + does not specify a valid keyboard device. + + + + +The +maxNames + field specifies the maximum number of component names to be reported, in +total, by this request. + + + + +The +keymapsSpec +, +keycodesSpec +, +typesSpec +, +compatMapSpec +, +symbolsSpec + and +geometrySpec + request fields specify a pattern to be matched against the names of all +components of the corresponding type in the server database of keyboard +components. + + + + +Each pattern uses the ISO Latin-1 encoding and should contain only parentheses, +the wildcard characters "?" and "*" or characters that are permitted in a +component class or member name (see Component Names). Illegal +characters in a pattern are simply ignored; no error results if a pattern +contains illegal characters. + + + + +Comparison is case-sensitive and, in a pattern, the "?" wildcard character +matches any single character except parentheses while the "*" character matches +any number of characters except parentheses. If an implementation accepts +characters other than those required by XKB, whether or not those characters +match either wildcard is also implementation dependent. An empty pattern does +not match any component names. + + + + +On successful return, the +deviceID + return value reports the X Input Extension device identifier of the specified +device, or +0 + if the server does not support the X input extension. The +extra + return value reports the number of matching component names that could not be +returned due to the setting of the +maxNames + field in the request. + + + + +The +keymaps +, +keycodes +, +types +, +compatMaps +, +symbols + and +geometries + return the hints (see Component +Hints) and names of any components from the server database that match +the corresponding pattern. + + + + +The Server Database of Keyboard +Components describes the X server database of keyboard components in +more detail. + + + + + + + + + + + XkbGetKbdByName + + + + + deviceSpec: KB_DEVICESPEC + + + +need, want: KB_GBNDETAILMASK + + + +load: BOOL + + + +keymapsSpec: STRING8 + + + +keycodesSpec, typesSpec: STRING8 + + + +compatMapSpec, symbolsSpec: STRING8 + + + +geometrySpec: STRING8 + + + + +deviceID: CARD8 + + + + +minKeyCode, maxKeyCode: KEYCODE + + + + +loaded, newKeyboard: BOOL + + + + +found, reported: KB_GBNDETAILMASK + + + + +map: optional +XkbGetMap + reply + + + + +compat: optional +XkbGetCompatMap + reply + + + + +indicators: optional +XkbGetIndicatorMap + reply + + + + +names: optional +XkbGetNames + reply + + + + +geometry: optional +XkbGetGeometry + reply + + + + Errors: +Keyboard +, +Access +, +Alloc + + + + + + + + +Assembles and returns a keymap from the current mapping and specified elements +from the server database of keymap components for the keyboard specified by + +deviceSpec +, and optionally replaces the current keyboard mapping with the newly generated +description. If +deviceSpec + does not specify a valid keyboard device, a +Keyboard + error results. + + + + +The +keymapsSpec +, +keycodesSpec +, +typesSpec +, +compatMapSpec +, +symbolsSpec + and +geometrySpec + component expressions (see +Partial Components and Combining Multiple Components) specify the +database components to be used to assemble the keyboard description. + + + + +The +want + field lists the pieces of the keyboard description that the client wants to +have reported for the newly constructed keymap. The +need + field lists all of the pieces that must be reported. If any of the pieces in + +need + cannot be loaded from the specified names, no description of the keyboard is +returned. + + + + +The +want + and +need + fields can include any combinations of these +XkbGetMapByName + (GBN) components: + + + + + + + + + + + XkbGetMapByName Keyboard Component… + Database Component… + Components of Keyboard Description + + + + + +XkbGBN_Types + + types + key types + + + +XkbGBN_CompatMap + + compat + symbol interpretations, group compatibility map + + + +XkbGBN_ClientSymbols + + symbols, types, keycodes + key types, key symbol mappings, modifier mapping + + + +XkbGBN_ServerSymbols + + symbols, types, keycodes + key behaviors, key actions, key explicit components, virtual +modifiers, virtual modifier mapping + + + +XkbGBN_IndicatorMap + + compat + indicator maps, indicator names + + + +XkbGBN_KeyNames + + keycodes + key names, key aliases + + + +XkbGBN_Geometry + + geometry + keyboard geometry + + + +XkbGBN_OtherNames + + all + key types, symbol interpretations, indicator maps, names, +geometry + + + + + + +If either field contains a GBN component that depends on some database +component for which the request does not supply an expression, XKB +automatically substitutes the special pattern "%" which copies the +corresponding component from the current keyboard description, as described in +Partial Components and Combining +Multiple Components. + + + + +The +load + flag asks the server to replace the current keyboard description for +deviceSpec + with the newly constructed keyboard description. If +load + is +True +, the request must include component expressions for all of the database +components; if any are missing, XKB substitutes "%" as described above. + + + + +If all necessary components are both specified and found, the new keyboard +description is loaded. If the new keyboard description has a different geometry +or keycode range than the previous keyboard description, XKB sends +XkbNewKeyboardNotify + events to all interested clients. See +Replacing the Keyboard +"On-the-Fly" for more information about the effects of replacing the +keyboard description on the fly. + + + + +If the range of keycodes changes, clients that have requested +XkbNewKeyboardNotify + events are not sent any other change notification events by this request. +Clients that do not request +XkbNewKeyboardNotify + events are sent other XKB change notification events (e.g. +XkbMapNotify +, +XkbNamesNotify +) as necessary to alert them to as many of the keyboard changes as possible. + + + + +If no error occurs, the request reply reports the GBN components that were +found and sends a description of any of the resulting keyboard that includes +and of the components that were requested. + + + + +The +deviceID + return value reports the X Input extension device identifier of the keyboard +that was used, or +0 + if the server does not support the X input extension. + + + + +The +minKeyCode + and +maxKeyCode + return values report the legal range of keycodes for the keyboard description +that was created. If the resulting keyboard description does not include at +least one of the key names, client symbols or server symbols components, + +minKeyCode + and +maxKeyCode + are both +0 +. + + + + +The +loaded + return value reports whether or not the existing keyboard definition was +replaced with the newly created one. If +loaded + is +True +, the +newKeyboard + return value reports whether or not the new map changed the geometry or range +of keycodes and caused +XkbNewKeyboardNotify + events for clients that have requested them. + + + + +The +found + return value reports the GBN components that were present in the keymap that +was constructed by this request. The +reported + return value lists the subset of those components for which descriptions +follow. if any of the components specified in the +need + field of the request were not found, +reported + is empty, otherwise it contains the intersection of the +found + return value with the union of the +need + and +want + request fields. + + + + +If any of +GBN_Types +, +GBN_ClientSymbols + or +GBN_ServerSymbols + are set in +reported +, the +map + return value has the same format as the reply to an +XkbGetMap + request and reports the corresponding pieces of the newly constructed keyboard +description. + + + + +If +GBN_CompatMap + is set in +reported +, the +compat + return value has the same format as the reply to an +XkbGetCompatMap + request and reports the symbol interpretations and group compatibility map for +the newly constructed keyboard description. + + + + +If +GBN_IndicatorMap + is set in +reported +, the +indicators + return value has the same format as the reply to an +XkbGetIndicatorMap + request and reports the physical indicators and indicator maps for the newly +constructed keyboard description. + + + + +If +GBN_KeyNames + or +GBN_OtherNames + are set in +reported +, the +names + return value has the same format as the reply to an +XkbGetNames + reply and reports the corresponding set of symbolic names for the newly +constructed keyboard description. + + + + +If +GBN_Geometry + is set in +reported +, the +geometry + return value has the same format as the reply to an +XkbGetGeometryMap + request and reports the keyboard geometry for the newly constructed keyboard +description. + + + + + +Querying and Changing Input Extension Devices + + + + + + + + + XkbGetDeviceInfo + + + + + deviceSpec: KB_DEVICESPEC + + + +wanted: KB_XIDEVFEATUREMASK + + + +ledClass: KB_LEDCLASSSPEC + + + +ledID: KB_IDSPEC + + + +allButtons: BOOL + + + +firstButton, nButtons: CARD8 + + + + +deviceID: CARD8 + + + + +present: KB_XIDEVFEATUREMASK + + + + +supported: KB_XIFEATUREMASK + + + + +unsupported: KB_XIFEATUREMASK + + + + +firstBtnWanted: CARD8 + + + + +nBtnsWanted: CARD8 + + + + +firstBtnRtrn: CARD8 + + + + +nBtnsRtrn: CARD8 + + + + +totalBtns: CARD8 + + + + +hasOwnState: BOOL + + + + +dfltKbdFB, dfltLedFB: KB_IDSPEC + + + + +devType: ATOM + + + + +name: STRING + + + + +btnActions: LISTofKB_ACTION + + + + +leds: LISTofKB_DEVICELEDINFO + + + + Errors: +Device +, +Match +, +Access +, +Alloc + + + + + + + + +Reports a subset of the XKB-supplied information about the input device +specified by +deviceSpec +. Unlike most XKB requests, the device specified for +XkbGetDeviceInfo + need not be a keyboard device. Nonetheless, a +Keyboard + error results if +deviceSpec + does not specify a valid core or input extension device. + + + + +The +wanted + field specifies the types of information to be returned, and controls the +interpretation of the other request fields. + + + + +If the server does not support assignment of XKB actions to extension device +buttons, the +allButtons +, +firstButton + and +nButtons + fields are ignored. + + + + +Otherwise, if the +XkbXI_ButtonActions + flag is set in +wanted +, the +allButtons +, +firstButton + and +nButtons + fields specify the device buttons for which actions should be returned. +Setting +allButtons + to +True + requests actions for all device buttons; if +allButtons + is +False +, +firstButton + and +nButtons + specify a range of buttons for which actions are requested. If the device has +no buttons or if +firstButton + and +nButtons + specify illegal buttons, a +Match + error results. If +allButtons + is +True +, +firstButton + and +nButtons + are ignored. + + + + +If the server does not support XKB access to any aspect of the indicators on +extension devices, or if the +wanted + field does not include any of the indicator flags, the +ledClass + and +ledID + fields are ignored. Otherwise, +ledClass + and +ledID + specify one or more feedback(s) for which indicator information is requested. +If +ledClass + or +ledID + have illegal values, a +Value + error results. If they have legal values but do not specify a keyboard or +indicator class feedback for the device in question, a +Match + error results. + + + + +The +ledClass + field can specify either +KbdFeedbackClass +, +LedFeedbackClass +, +XkbDfltXIClass +, or +XkbAllXIClasses +. If at least one keyboard feedback is defined for the specified device, + +XkbDfltXIClass + is equivalent to +KbdFeedbackClass +, otherwise it is equivalent to +LedFeedbackClass +. If +XkbAllXIClasses + is specified, this request returns information about both indicator and +keyboard class feedbacks which match the requested identifier, as described +below. + + + + +The +ledID + field can specify any valid input extension feedback identifier, +XkbDfltXIId +, or +XkbAllXIIds +. The default keyboard feedback is the one that is affected by core protocol +requests; the default led feedback is implementation-specific. If +XkbAllXIIds + is specified, this request returns indicator information about all feedbacks +of the class(es) specified by +ledClass +. + + + + +If no error results, the +deviceID + return value reports the input extension device identifier of the device for +which values are being returned. The +supported + return value reports the set of optional XKB extension device features that +are supported by this implementation (see + +Interactions Between XKB and the X Input +Extension) for the specified device, and the unsupported return value +reports any +unsupported + features. + + + + +If +hasOwnState + is +True +, the device is also a keyboard, and any indicator maps bound to the device use +the current state and control settings for this device to control automatic +changes. If +hasOwnState + is +False +, the state and control settings of the core keyboard device control automatic +indicator changes. + + + + +The +name + field reports the X Input Extension name for the device. The +devType + field reports the X Input Extension device type. Both fields are provided +merely for convenience and are not interpreted by XKB. + + + + +The +present + return value reports the kinds of device information being returned, and +controls the interpretation of the remaining fields. The +present + field consists of the +wanted + field from the original request minus the flags for any unsupported features. + + + + +If +XkbXI_ButtonActions + is set in +present +, the +totalBtns + return value reports the total number of buttons present on the device, + +firstBtnWanted + and +nBtnsWanted + specify the range of buttons for which actions were requested, and the + +firstBtnRtrn + and +nBtnsRtrn +values specify the range of buttons for which actions are reported. The + +actionsRtrn + list has +nButtonsRtrn + entries which contain the actions bound to the specified buttons on the +device. Any buttons for which actions were requested but not returned have the +action +NoAction() +. + + + + +If any indicator information is reported, the leds list contains one element +for each requested feedback. For example, if +ledClass + is +XkbAllXIClasses + and +ledID + is +XkbAllXIIds +, +leds + describes all of the indicators on the device and has one element for each +keyboard or led class feedback defined for the device. If any information at +all is reported about a feedback, the set of physical indicators is also +reported in the +physIndicators + field of the corresponding element of +leds +. + + + + +If the server supports assignment of indicator maps to extension device +indicators, and if the +XkbXI_IndicatorMaps + flag is set in +wanted +, each member of +leds + reports any indicators on the corresponding feedback to which names have been +assigned. Any indicators for which no map is reported have the default map, +which allows explicit changes and does not request any automatic changes. + + + + +If the server supports assignment of indicator names to extension device +indicators, and the +XkbXI_IndicatorNames + flag is set in +wanted +, each member of +leds + reports any indicators on the corresponding feedback to which names have been +assigned. Any indicators for which no name is reported have the name +None +. + + + + +If the server supports XKB access to the state of extension device indicators, +and the +XkbXI_IndicatorState + flag is set in wanted, each member of leds reports the state of the indicators +on the corresponding feedback. + + + + +If any unsupported features are requested, and the requesting client has +selected for them, the server sends the client an +XkbExtensionDeviceNotify + event which indicates that an unsupported feature was requested. This event is +only generated if the client which issued the unsupported request has selected +for it and, if generated, is not sent to any other clients. + + + + + + + + + + + XkbSetDeviceInfo + + + + + deviceSpec: KB_DEVICESPEC + + + +change: KB_XIDEVFEATUREMASK + + + +firstBtn, nBtns: CARD8 + + + +btnActions:LISTofKB_ACTION + + + +leds: LISTofKB_DEVICELEDINFO + + + + Errors: +Device +, +Match +, +Access +, +Alloc + + + + + + + + +Changes a subset of the XKB-supplied information about the input device +specified by +deviceSpec +. Unlike most XKB requests, the device specified for +XkbGetDeviceInfo + need not be a keyboard device. Nonetheless, a +Keyboard + error results if +deviceSpec + does not specify a valid core or input extension device + + + + +The +change + field specifies the features for which new values are supplied, and controls +the interpretation of the other request fields. + + + + +If the server does not support assignment of XKB actions to extension device +buttons, the +firstButton + and +nButtons + fields are ignored. + + + + +Otherwise, if the +XkbXI_ButtonActions + flag is set in +change +, the +firstBtn + and +nBtns + fields specify a range of buttons for which actions are specified in this +request. If the device has no buttons or if +firstBtn + and +nBtns + specify illegal buttons, a +Match + error results. + + + + +Each element of the +leds + list describes the changes for a single keyboard or led feedback. If the + +ledClass + field of any element of +leds + contains any value other than +KbdFeedbackClass +, +LedFeedbackClass + or +XkbDfltXIClass +, a +Value + error results. If the +ledId + field of any element of leds contains any value other than a valid input +extension feedback identifier or +XkbDfltXIId +, a +Value + error results. If both fields are valid, but the device has no matching +feedback, a +Match + error results. + + + + +The fields of each element of +leds + are interpreted as follows: + + + + + If +XkbXI_IndicatorMaps + is set in +change + and the server supports XKB assignment of indicator maps to the corresponding +feedback, the maps for all indicators on the corresponding feedback are taken +from +leds +. If the server does not support this feature, any maps specified in +leds + are ignored. + + + + If +XkbXI_IndicatorNames + is set in +change +, and the server supports XKB assignment of names to indicators for the +corresponding feedback, the names for all indicators on the corresponding +feedback are taken from +leds +. If the server does not support this feature, any names specified in +leds + are ignored. Regardless of whether they are used, any names be a valid Atom or + +None +, or an +Atom + error results. + + + + If +XkbXI_IndicatorState + is set in change, and the server supports XKB changes to extension device +indicator state, the server attempts to change the indicators on the +corresponding feedback as specified by +leds +. Any indicator maps bound to the feedback are applied, so state changes might +be blocked or have side-effects. + + + + + +If any unsupported features are requested, and the requesting client has +selected for them, the server sends the client an +XkbExtensionDeviceNotify + event which indicates that an unsupported feature was requested. This event is +only generated if the client which issued the unsupported request has selected +for it and, if generated, is not sent to any other clients. + + + + + +Debugging the X Keyboard Extension + + + + + + + + + XkbSetDebuggingFlags + + + + + affectFlags, flags: CARD32 + + + +affectCtrls, ctrls: CARD32 + + + +message: STRING + + + + +currentFlags, supportedFlags: CARD32 + + + + +currentCtrls, supportedCtrls: CARD32 + + + + + + + +This request sets up various internal XKB debugging flags and controls. It is +intended for developer use and may be disabled in production servers. If +disabled, +XkbSetDebuggingFlags + has no effect but returns +Success +. + + + + +The +affectFlags + field specifies the debugging flags to be changed, the +flags + field specifies new values for the changed flags. The interpretation of the +debugging flags is implementation-specific, but flags are intended to control +debugging output and should not otherwise affect the operation of the server. + + + + +The +affectCtrls + field specifies the debugging controls to be changed, the +ctrls + field specifies new values for the changed controls. The interpretation of the +debugging controls is implementation-specific, but debugging controls are +allowed to affect the behavior of the server. + + + + +The +message + field provides a message that the X server can print in any logging or +debugging files before changing the flags. The server must accept this field +but it is not required to actually display it anywhere. + + + + +The X Test Suite makes some assumptions about the implementation of locking +modifier keys that do not apply when XKB is present. The +XkbDF_DisableLocks + debugging control provides a simple workaround to these test suite problems by +simply disabling all locking keys. If +XkbDF_DisableLocks + is enabled, the +SA_LockMods + and +SA_LockGroup + actions behave like +SA_SetMods + and +SA_LockMods +, respectively. If it is disabled, +SA_LockMods + and +SA_LockGroup + actions behave normally. + + + + +Implementations are free to ignore the +XkbDF_DisableLocks + debugging control or to define others. + + + + +The +currentFlags + return value reports the current setting for the debugging flags, if +applicable. The +currentCtrls + return value reports the setting for the debugging controls, if applicable. +The +supportedFlags + and +supportedCtrls + fields report the flags and controls that are recognized by the +implementation. Attempts to change unsupported fields or controls are silently +ignored. + + + + +If the +XkbSetDebuggingFlags + request contains more data than expected, the server ignores the extra data, +but no error results. If the request has less data than expected, a +Length + error results. + + + + +If the +XkbSetDebuggingFlags + reply contains more data than expected, the client just ignores any +uninterpreted data without reporting an error. If the reply has less data than +expected, a +Length + error results. + + + + + + +Events + + +All XKB events report the time at which they occurred in a field named + +time + and the device on which they occurred in a field named +deviceID +. XKB uses a single X event code for all events and uses a common field to +distinguish XKB event type. + + + + +Tracking Keyboard Replacement + + + + + + + + + XkbNewKeyboardNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +changed: KB_NKNDETAILMASK + + + +minKeyCode, maxKeyCode: KEYCODE + + + +oldDeviceID: CARD8 + + + +oldMinKeyCode, oldMaxKeyCode: KEYCODE + + + +requestMajor, requestMinor: CARD8 + + + + + + + +An +XkbNewKeyboardNotify + event reports that a new core keyboard has been installed. New keyboard notify +events can be generated: + + + + + When the X server detects that the keyboard was changed. + + + + When a client installs a new extension device as the core keyboard +using the X Input Extension +ChangeKeyboardDevice + request. + + + + When a client issues an +XkbGetMapByName + request which changes the keycodes range or geometry. + + + + + +The +changed + field of the event reports the aspects of the keyboard that have changed, and +can contain any combination of the event details for this event: + + + + + + + + + + Bit in Changed + Meaning + + + + + NKN_Keycodes + The new keyboard has a different minimum or maximum keycode. + + + NKN_Geometry + The new keyboard has a different keyboard geometry. + + + NKN_DeviceID + The new keyboard has a new X Input Extension device +identifier + + + + + + +The server sends an +XkbNewKeyboardNotify + event to a client only if at least one of the bits that is set in the + +changed + field of the event is also set in the appropriate event details mask for the +client. + + + + +The +minKeyCode + and +maxKeyCode + fields report the minimum and maximum keycodes that can be returned by the new +keyboard. The +oldMinKeyCode + and +oldMaxKeyCode + fields report the minimum and maximum values that could be returned before the +change. This event always reports all four values, but the old and new values +are the same unless +NKN_Keycodes + is set in +changed +. + + + + +Once a client receives a new keyboard notify event which reports a new keycode +range, the X server reports events from all keys in the new range to that +client. Clients that do not request or receive new keyboard notify events +receive events only from keys that fall in the last range for legal keys +reported to that client. See +Replacing the Keyboard "On-the-Fly" for a more detailed explanation. + + + + +If +NKN_Keycodes + is set in +changed +, the +XkbNewKeyboardNotify + event subsumes all other change notification events (e.g. +XkbMapNotify +, +XkbNamesNotify +) that would otherwise result from the keyboard change. Clients who receive an + +XkbNewKeyboardNotify + event should assume that all other aspects of the keyboard mapping have +changed and regenerate the entire local copy of the keyboard description. + + + + +The +deviceID + field reports the X Input Extension device identifier of the new keyboard +device; +oldDeviceID + reports the device identifier before the change. This event always includes +both values, but they are the same unless +NKN_DeviceID + is set in +changed +. If the server does not support the X Input Extension, both fields have the +value +0 +. + + + + +The +requestMajor + and +requestMinor + fields report the major and minor opcode of the request that caused the +keyboard change. If the keyboard change was not caused by some client request, +both fields have the value +0 +. + + + + + +Tracking Keyboard Mapping Changes + + + + + + + + + XkbMapNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +ptrBtnActions: CARD8 + + + +changed: KB_MAPPARTMASK + + + +minKeyCode, maxKeyCode: KEYCODE + + + +firstType, nTypes: CARD8 + + + +firstKeySym, firstKeyAction: KEYCODE + + + +nKeySyms, nKeyActions: CARD8 + + + +firstKeyBehavior, firstKeyExplicit: KEYCODE + + + +nKeyBehaviors, nKeyExplicit: CARD8 + + + +virtualMods: KB_VMODMASK + + + +firstModMapKey, firstVModMapKey: KEYCODE + + + +nModMapKeys, nVModMapKeys: CARD8 + + + + + + + +An +XkbMapNotify + event reports that some aspect of XKB map for a keyboard has changed. Map +notify events can be generated whenever some aspect of the keyboard map is +changed by an XKB or core protocol request. + + + + +The +deviceID + field reports the keyboard for which some map component has changed and the + +changed + field reports the components with new values, and can contain any of the +values that are legal for the +full + and +partial + fields of the +XkbGetMap + request. The server sends an +XkbMapNotify + event to a client only if at least one of the bits that is set in the + +changed + field of the event is also set in the appropriate event details mask for the +client. + + + + +The +minKeyCode + and +maxKeyCode + fields report the range of keycodes that are legal on the keyboard for which +the change is being reported. + + + + +If +XkbKeyTypesMask + is set in +changed +, the +firstType + and +nTypes + fields report a range of key types that includes all changed types. Otherwise, +both fields are +0 +. + + + + +If +XkbKeySymsMask + is set in +changed +, the +firstKeySym + and +nKeySyms + fields report a range of keycodes that includes all keys with new symbols. +Otherwise, both fields are +0 +. + + + + +If +XkbKeyActionsMask + is set in +changed +, the +firstKeyAction + and +nKeyActions + fields report a range of keycodes that includes all keys with new actions. +Otherwise, both fields are +0 +. + + + + +If +XkbKeyBehaviorsMask + is set in +changed +, the +firstKeyBehavior +and +nKeyBehaviors + fields report a range of keycodes that includes all keys with new key +behavior. Otherwise, both fields are +0 +. + + + + +If +XkbVirtualModsMask + is set in +changed +, +virtualMods + contains all virtual modifiers to which a new set of real modifiers is bound. +Otherwise, +virtualMods + is +0 +. + + + + +If +XkbExplicitComponentsMask + is set in +changed +, the +firstKeyExplicit + and +nKeyExplicit + fields report a range of keycodes that includes all keys with changed explicit +components. Otherwise, both fields are +0 +. + + + + +If +XkbModifierMapMask + is set in +changed +, the +firstModMapKey + and +nModMapKeys + fields report a range of keycodes that includes all keys with changed modifier +bindings. Otherwise, both fields are +0 +. + + + + +If +XkbVirtualModMapMask + is set in +changed +, the +firstVModMapKey + and +nVModMapKeys + fields report a range of keycodes that includes all keys with changed virtual +modifier mappings. Otherwise, both fields are +0 +. + + + + + +Tracking Keyboard State Changes + + + + + + + + + XkbStateNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +mods, baseMods, latchedMods, lockedMods: KEYMASK + + + +group, lockedGroup: CARD8 + + + +baseGroup, latchedGroup: INT16 + + + +compatState: KEYMASK + + + +grabMods, compatGrabMods: KEYMASK + + + +lookupMods, compatLookupMods: KEYMASK + + + +ptrBtnState: BUTMASK + + + +changed: KB_STATEPARTMASK + + + +keycode: KEYCODE + + + +eventType: CARD8 + + + +requestMajor, requestMinor: CARD8 + + + + + + + +An XkbStateNotify +event reports that some component of the XKB state (see +Keyboard State) has changed. +State notify events are usually caused by key or pointer activity, but they can +also result from explicit state changes requested by the +XkbLatchLockState + request or by other extensions. + + + + +The +deviceID + field reports the keyboard on which some state component changed. The + +changed + field reports the XKB state components (see +Keyboard State) that have changed +and contain any combination of: + + + + + + + + + + + Bit in changed + Event field + Changed component + + + + + +ModifierState + + +mods + + The effective modifiers + + + +ModifierBase + + +baseMods + + The base modifiers + + + +ModifierLatch + + +latchedMods + + The latched modifiers + + + +ModifierLock + + +lockedMods + + The locked modifiers + + + +GroupState + + +group + + The effective keyboard group + + + +GroupBase + + +baseGroup + + The base keyboard group + + + +GroupLatch + + +latchedGroup + + The latched keyboard group + + + +GroupLock + + +lockedGroup + + The locked keyboard group + + + +PointerButtons + + +ptrBtnState + + The state of the core pointer buttons + + + +GrabMods + + +grabMods + + The XKB state used to compute grabs + + + +LookupMods + + +lookupMods + + The XKB state used to look up symbols + + + +CompatState + + +compatState + + Default state for non-XKB clients + + + +CompatGrabMods + + +compatGrabMods + + The core state used to compute grabs + + + +CompatLookupMods + + +compatLookupMods + + The core state used to look up symbols + + + + + + +The server sends an +XkbStateNotify + event to a client only if at least one of the bits that is set in the + +changed + field of the event is also set in the appropriate event details mask for the +client. + + + + +A state notify event reports current values for all state components, even +those with unchanged values. + + + + +The +keycode + field reports the key or button which caused the change in state while the + +eventType + field reports the exact type of event (e.g. +KeyPress +). If the change in state was not caused by key or button activity, both fields +have the value +0 +. + + + + +The +requestMajor + and +requestMinor + fields report the major and minor opcodes of the request that caused the +change in state and have the value +0 + if it was resulted from key or button activity. + + + + + +Tracking Keyboard Control Changes + + + + + + + + + XkbControlsNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +numGroups: CARD8 + + + +changedControls: KB_CONTROLMASK + + + +enabledControls,enabledControlChanges: KB_BOOLCTRLMASK + + + +keycode: KEYCODE + + + +eventType: CARD8 + + + +requestMajor: CARD8 + + + +requestMinor: CARD8 + + + + + + + +An +XkbControlsNotify + event reports a change in one or more of the global keyboard controls (see +Global Keyboard Controls) +or in the internal modifiers or ignore locks masks (see + +Server Internal Modifiers and Ignore +Locks Behavior). Controls notify events are usually caused by and + +XkbSetControls + request, but they can also be caused by keyboard activity or certain core +protocol and input extension requests. + + + + +The +deviceID + field reports the keyboard for which some control has changed, and the + +changed + field reports the controls that have new values. + + + + +The +changed + field can contain any of the values that are permitted for the +changeControls + field of the +XkbSetControls + request. The server sends an +XkbControlsNotify + event to a client only if at least one of the bits that is set in the + +changed + field of the event is also set in the appropriate event details mask for the +client. + + + + +The +numGroups + field reports the total number of groups defined for the keyboard, whether or +not the number of groups has changed. + + + + +The +enabledControls + field reports the current status of all of the boolean controls, whether or +not any boolean controls changed state. If +EnabledControls + is set in +changed +, the +enabledControlChanges + field reports the boolean controls that were enabled or disabled; if a control +is specified in +enabledControlChanges +, the value that is reported for that control in +enabledControls + represents a change in state. + + + + +The +keycode + field reports the key or button which caused the change in state while the + +eventType + field reports the exact type of event (e.g. +KeyPress +). If the change in state was not caused by key or button activity, both fields +have the value +0 +. + + + + +The +requestMajor + and +requestMinor + fields report the major and minor opcodes of the request that caused the +change in state and have the value +0 + if it was resulted from key or button activity. + + + + + +Tracking Keyboard Indicator State Changes + + + + + + + + + XkbIndicatorStateNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +stateChanged, state: KB_INDICATORMASK + + + + + + + +An +XkbIndicatorStateNotify + event indicates that one or more of the indicators on a keyboard have changed +state. Indicator state notify events can be caused by: + + + + + Automatic update to reflect changes in keyboard state (keyboard +activity, +XkbLatchLockState + requests). + + + + Automatic update to reflect changes in keyboard controls ( +XkbSetControls +, keyboard activity, certain core protocol and input extension requests). + + + + Explicit attempts to change indicator state (core protocol and input +extension requests, +XkbSetNamedIndicator + requests). + + + + Changes to indicator maps ( +XkbSetIndicatorMap + and +XkbSetNamedIndicator + requests). + + + + + +The +deviceID + field reports the keyboard for which some indicator has changed, and the + +state + field reports the new state for all indicators on the specified keyboard. The + +stateChanged + field specifies which of the values in +state + represent a new state for the corresponding indicator. The server sends an + +XkbIndicatorStateNotify + event to a client only if at least one of the bits that is set in the + +stateChanged + field of the event is also set in the appropriate event details mask for the +client. + + + + + +Tracking Keyboard Indicator Map Changes + + + + + + + + + XkbIndicatorMapNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +state: KB_INDICATORMASK + + + +mapChanged: KB_INDICATORMASK + + + + + + + +An +XkbIndicatorMapNotify + event indicates that the maps for one or more keyboard indicators have been +changed. Indicator map notify events can be caused by +XkbSetIndicatorMap + and +XkbSetNamedIndicator + requests. + + + + +The +deviceID + field reports the keyboard for which some indicator map has changed, and the + +mapChanged + field reports the indicators with changed maps. The server sends an +XkbIndicatorMapNotify + event to a client only if at least one of the bits that is set in the + +mapChanged + field of the event is also set in the appropriate event details mask for the +client. + + + + +The +state + field reports the current state of all indicators on the specified keyboard. + + + + + +Tracking Keyboard Name Changes + + + + + + + + + XkbNamesNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +changed: KB_NAMEDETAILMASK + + + +firstType, nTypes: CARD8 + + + +firstLevelName, nLevelNames: CARD8 + + + +firstKey: KEYCODE + + + +nKeys, nKeyAliases, nRadioGroups: CARD8 + + + +changedGroupNames: KB_GROUPMASK + + + +changedVirtualMods: KB_VMODMASK + + + +changedIndicators: KB_INDICATORMASK + + + + + + + +An +XkbNamesNotify + event reports a change to one or more of the symbolic names associated with a +keyboard. Symbolic names can change when: + + + + + Some client explicitly changes them using +XkbSetNames +. + + + + The list of key types or radio groups is resized + + + + The group width of some key type is changed + + + + + +The +deviceID + field reports the keyboard on which names were changed. The +changed + mask lists the components for which some names have changed and can have any +combination of the values permitted for the +which + field of the +XkbGetNames + request. The server sends an +XkbNamesNotify + event to a client only if at least one of the bits that is set in the + +changed + field of the event is also set in the appropriate event details mask for the +client. + + + + +If +KeyTypeNames + is set in +changed +, the +firstType + and +nTypes + fields report a range of types that includes all types with changed names. +Otherwise, both fields are +0 +. + + + + +If +KTLevelNames + is set in +changed +, the +firstLevelName + and +nLevelNames + fields report a range of types that includes all types with changed level +names. Otherwise, both fields are +0 +. + + + + +If +IndicatorNames + is set in +changed +, the +changedIndicators + field reports the indicators with changed names. Otherwise, +changedIndicators + is +0 +. + + + + +If +VirtualModNames + is set in +changed +, the +changedVirtualMods + field reports the virtual modifiers with changed names. Otherwise, +changedVirtualMods + is +0 +. + + + + +If +GroupNames + is set in +changed +, the +changedGroupNames + field reports the groups with changed names. Otherwise, +changedGroupNames + is +0 +. + + + + +If +KeyNames + is set in +changed +, the +firstKey + and +nKeys + fields report a range of keycodes that includes all keys with changed names. +Otherwise, both fields are +0 +. + + + + +The +nKeyAliases + field reports the total number of key aliases associated with the keyboard, +regardless of whether +KeyAliases + is set in +changed +. + + + + +The +nRadioGroups + field reports the total number of radio group names associated with the +keyboard, regardless of whether +RGNames + is set in +changed +. + + + + + +Tracking Compatibility Map Changes + + + + + + + + + XkbCompatMapNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +changedGroups: KB_GROUPMASK + + + +firstSI, nSI: CARD16 + + + +nTotalSI: CARD16 + + + + + + + +An +XkbCompatMapNotify + event indicates that some component of the compatibility map for a keyboard +has been changed. Compatibility map notify events can be caused by +XkbSetCompatMap + and +XkbGetMapByName + requests. + + + + +The +deviceID + field reports the keyboard for which the compatibility map has changed; if the +server does not support the X input extension, +deviceID + is +0 +. + + + + +The +changedGroups + field reports the keyboard groups, if any, with a changed entry in the group +compatibility map. The +firstSI + and +nSI + fields specify a range of symbol interpretations in the symbol compatibility +map that includes all changed symbol interpretations; if the symbol +compatibility map is unchanged, both fields are +0 +. The +nTotalSI + field always reports the total number of symbol interpretations present in the +symbol compatibility map, regardless of whether any symbol interpretations have +been changed. + + + + +The server sends an +XkbCompatMapNotify + event to a client only if at least one of the following conditions is met: + + + + + The +nSI + field of the event is non-zero, and the +XkbSymInterpMask + bit is set in the appropriate event details mask for the client. + + + + The +changedGroups + field of the event contains at least one group, and the +XkbGroupCompatMask + bit is set in the appropriate event details mask for the client. + + + + + + +Tracking Application Bell Requests + + + + + + + + + XkbBellNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +bellClass: { KbdFeedbackClass, BellFeedbackClass } + + + +bellID: CARD8 + + + +percent: CARD8 + + + +pitch: CARD16 + + + +duration: CARD16 + + + +eventOnly: BOOL + + + +name: ATOM + + + +window: WINDOW + + + + + + + +An +XkbBellNotify + event indicates that some client has requested a keyboard bell. Bell notify +events are usually caused by +Bell +, +DeviceBell +, or +XkbBell + requests, but they can also be generated by the server (e.g. if the +AccessXFeedback + control is active). + + + + +The server sends an +XkbBellNotify + event to a client if the appropriate event details field for the client has +the value +True +. + + + + +The +deviceID + field specifies the device for which a bell was requested, while the +bellClass + and +bellID + fields specify the input extension class and identifier of the feedback for +which the bell was requested. If the reporting server does not support the +input extension, all three fields have the value 0. + + + + +The +percent +, +pitch + and +duration + fields report the volume, tone and duration requested for the bell as +specified by the +XkbBell + request. Bell notify events caused by core protocol or input extension +requests use the pitch and duration specified in the corresponding bell or +keyboard feedback control. + + + + +If the bell was caused by an +XkbBell + request or by the X server, +name + reports an optional symbolic name for the bell and the +window + field optionally reports the window for which the bell was generated. +Otherwise, both fields have the value +None +. + + + + +If the +eventOnly + field is +True +, the server did not generate a sound in response to the request, otherwise the +server issues the beep before sending the event. The eventOnly field can be + +True + if the +AudibleBell + control is disabled or if a client explicitly requests +eventOnly + when it issues an +XkbBell + request. + + + + + +Tracking Messages Generated by Key Actions + + + + + + + + + XkbActionMessage + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +keycode: KEYCODE + + + +press: BOOL + + + +mods: KEYMASK + + + +group: KB_GROUP + + + +keyEventFollows: BOOL + + + +message: LISTofCARD8 + + + + + + + +An +XkbActionMessage + event is generated when the user operates a key to which an +SA_ActionMessage + message is bound under the appropriate state and group. The server sends an + +XkbActionMessage + event to a client if the appropriate event details field for the client has +the value +True +. + + + + +The +deviceID + field specifies the keyboard device that contains the key which activated the +event. The +keycode + field specifies the key whose operation caused the message and press is + +True + if the message was caused by the user pressing the key. The +mods + and +group + fields report the effective keyboard modifiers and group in effect at the time +the key was pressed or released. + + + + +If +keyEventFollows + is +True +, the server will also send a key press or release event, as appropriate, for +the key that generated the message. If it is +False +, the key causes only a message. Note that the key event is delivered normally +with respect to passive grabs, keyboard focus, and cursor position, so that + +keyEventFollows + does not guarantee that any particular client which receives the +XkbActionMessage + notify event will also receive a key press or release event. + + + + +The +message + field is +NULL +-terminated string of up to +ActionMessageLength + ( +6 +) bytes, which reports the contents of the +message + field in the action that caused the message notify event. + + + + + +Tracking Changes to AccessX State and Keys + + + + + + + + + XkbAccessXNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD8 + + + +detail: KB_AXNDETAILMASK + + + +keycode: KEYCODE + + + +slowKeysDelay: CARD16 + + + +debounceDelay: CARD16 + + + + + + + +An +XkbAccessXNotify + event reports on some kinds of keyboard activity when any of the +SlowKeys +, +BounceKeys + or +AccessXKeys + controls are active. Compatibility map notify events can only be caused by +keyboard activity. + + + + +The +deviceID + and +keycode + fields specify the keyboard and key for which the event occurred. The + +detail + field describes the event that occurred and has one of the following values: + + + + + + + + + + + Detail + Control + Meaning + + + + + +AXN_SKPress + + +SlowKeys + + Key pressed + + + +AXN_SKAccept + + +SlowKeys + + +K +ey held until it was accepted. + + + +AXN_SKReject + + +SlowKeys + + Key released before it was accepted. + + + +AXN_SKRelease + + +SlowKeys + + Key released after it was accepted. + + + +AXN_BKAccept + + +BounceKeys + + Key pressed while it was active. + + + +AXN_BKReject + + +BounceKeys + + Key pressed while it was still disabled. + + + +AXN_AXKWarning + + +AccessXKeys + + Shift key held down for four seconds + + + + + + +Each subclass of the AccessX notify event is generated only when the control +specified in the table above is enabled. The server sends an +XkbAccessXNotify + event to a client only if the bit which corresponds to the value of the + +detail + field for the event is set in the appropriate event details mask for the +client. + + + + +Regardless of the value of +detail +, the +slowKeysDelay + and +debounceDelay + fields always reports the current slow keys acceptance delay (see +The SlowKeys Control) and +debounce delay (see The BounceKeys +Control) for the specified keyboard. + + + + + +Tracking Changes To Extension Devices + + + + + + + + + XkbExtensionDeviceNotify + + + + + time: TIMESTAMP + + + +deviceID: CARD16 + + + +ledClass: { KbdFeedbackClass, LedFeedbackClass } + + + +ledID: CARD16 + + + +reason: KB_XIDETAILMASK + + + +supported: KB_XIFEATUREMASK + + + +unsupported: KB_XIFEATUREMASK + + + +ledsDefined: KB_INDICATORMASK + + + +ledState: KB_INDICATORMASK + + + +firstButton, nButtons: CARD8 + + + + + + + +An +XkbExtensionDeviceNotify + event reports: + + + + + A change to some part of the XKB information for an extension device. + + + + An attempt to use an XKB extension device feature that is not supported +for the specified device by the current implementation. + + + + + +The +deviceID + field specifies the X Input Extension device identifier of some device on +which an XKB feature was requested, or +XkbUseCorePtr + if the request affected the core pointer device. The +reason + field explains why the event was generated in response to the request, and can +contain any combination of +XkbXI_UnsupportedFeature + and the values permitted for the change field of the +XkbSetDeviceInfo + request. + + + + +If +XkbXI_ButtonActions + is set in +reason +, this event reports a successful change to the XKB actions bound to one or +more buttons on the core pointer or an extension device. The +firstButton + and +nButtons + fields report a range of device buttons that include all of the buttons for +which actions were changed. + + + + +If any combination of +XkbXI_IndicatorNames +, +XkbXI_IndicatorMaps +, or +XkbXI_IndicatorState + is set in either +reason + or +unsupported +, the +ledClass + and +ledID + fields specify the X Input Extension feedback class and identifier of the +feedback for which the change is reported. If this event reports any changes to +an indicator feedback, the +ledsDefined + field reports all indicators on that feedback for which either a name or a +indicator map are defined, and +ledState + reports the current state of all of the indicators on the specified feedback. + + + + +If +XkbXI_IndicatorNames + is set in +reason +, this event reports a successful change to the symbolic names bound to one or +more extension device indicators by XKB. If +XkbXI_IndicatorMaps + is set in +reason +, this event reports a successful change to the indicator maps bound to one or +more extension device indicators by XKB. If +XkbXI_IndicatorState + is set in reason, this event reports that one or more indicators in the +specified device and feedback have changed state. + + + + +If +XkbXI_UnsupportedFeature + is set in reason, this event reports an unsuccessful attempt to use some XKB +extension device feature that is not supported by the XKB implementation in the +server for the specified device. The +unsupported + mask reports the requested features that are not available on the specified +device. See Interactions Between +XKB and the X Input Extension for more information about possible XKB +interactions with the X Input Extension. + + + + +The server sends an +XkbExtensionDeviceNotify + event to a client only if at least one of the bits that is set in the + +reason + field of the event is also set in the appropriate event details mask for the +client. + + + + +Events that report a successful change to some extension device feature are +reported to all clients that have expressed interest in the event; events that +report an attempt to use an unsupported feature are reported only to the client +which issued the request. Events which report a partial success are reported to +all interested clients, but only the client that issued the request is informed +of the attempt to use unsupported features. + + + + diff --git a/miniconda3/envs/ladir/share/doc/kbproto/xkbproto.xml b/miniconda3/envs/ladir/share/doc/kbproto/xkbproto.xml new file mode 100644 index 0000000000000000000000000000000000000000..20f98d57e77273375d4aceb47a2fbacf03d95001 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/kbproto/xkbproto.xml @@ -0,0 +1,70 @@ + + %defs; +]> + + + + + The X Keyboard Extension: Protocol Specification + X Consortium Standard + + Erik + Fortune + Silicon Graphics, Inc + + X Version 11, Release &fullrelvers; + Version 1.0 + 19951996 + X Consortium Inc. + Silicon Graphics Inc. + Hewlett-Packard Company + Digital Equipment Corporation + + + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the names of the X Consortium, Silicon Graphics Inc., Hewlett-Packard Company, and Digital Equipment Corporation shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/readline/CHANGES b/miniconda3/envs/ladir/share/doc/readline/CHANGES new file mode 100644 index 0000000000000000000000000000000000000000..8c89f1e36bce609373a9094c1f64ba1b8010ea30 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/readline/CHANGES @@ -0,0 +1,2112 @@ +This document details the changes between this version, readline-8.3, and +the previous version, readline-8.2. + +1. Changes to Readline + +a. Fixed a bug in clearing the visible line structure before redisplay. + +b. Fix a bug where setlocale(3) returning NULL caused a crash. + +c. Fixed signal checking in callback mode to handle signals that arrive before + readline restore's the application's signal handlers. + +d. Fixed a bug with word completion where the directory name needs to be + dequoted and tilde-expanded. + +e. Fixed a bug that caused compilation to fail on systems with select but not + pselect. + +f. System-specific changes for: WIN32, z/OS, Cygwin, MSYS + +g. Fixed a bug that caused word completion mismatches if the quoted text the + user typed was longer than the unquoted match. + +h. Fixes for freeing undo lists that might appear in history list entries + after non-incremental searches. + +i. Fixes for some errors revealed by address sanitizer. + +j. In vi mode, if an `f' or `F' move command associated with a `c' or `C' + command fails, don't enter insert mode. + +k. Fixed bug with truncating a history file containing timestamps that caused + the timestamp associated with the first history entry not to be written. + +l. Fix vi-mode so that a motion command attached to d/D, y/Y, or t/T must + consume or delete at least one character. + +m. Fix a redisplay error when displaying meta characters as octal sequences + and other C locale issues. + +n. Fix error that caused characters composing an incomplete multibyte + character not to be inserted into the line. + +o. In callback mode, let the application echo the signal characters (e.g., ^C) + when the application's signal handlers are installed. + +p. Added some support for lines that consume more than the physical number of + screen lines. + +q. Make sure dump-variables returns the string values for active-region-start-color + and active-region-end-color if they're set. + +r. Fixes to how characters between 128 and 159 are printed when displaying + macro values (use symbolic notation instead of directly printing the + character). + +s. Don't convert meta characters that contain NULL (\M-\C-@) to actual NULs, + which prematurely terminates the macro value. + +t. Fix typo in the readline color prefix extension that it uses for coloring + filename prefixes when displaying possible completions. + +u. Call the filename rewrite hook on the word being completed before comparing + it against possible completions from the file system to get consistent + strings. + +v. Fix infinite recursion that can happen if someone binds a key that doesn't + have a different upper and lower case represenation to do-lowercase-version. + +w. Check for non-ANSI (dumb) terminals a little more thoroughly. + +x. Don't attempt to history-expand the `quick substitution' character at the + beginning of a line if the application has set the quoting state to single + quotes. + +y. Fix small memory leak if non-incremental or incremental search is + interrupted by a signal. + +z. Loading very large history files should be much faster. + +aa. Retry opening startup files if the open is interrupted by a signal + and is not automatically restarted. + +bb. Make sure the bracketed-paste input buffer is null-terminated when read + returns an error. + +cc. Fixed a small memory leak in execute-named-command if the command doesn't + exist or the function doesn't return. + +dd. Fix for attempting to change case of invalid multibyte characters. + +ee. Fix for possible completions that compare identically when using case- + insensitive completion but have different byte lengths. + +ff. Fix to make non-incremental searches use undo lists and set the history + position the same way as incremental searches. + +gg. Don't check for signals when handling a received signal. + +hh. Fix off-by-one error when tokenizing words like $((expr)) while performing + history expansion. + +ii. Fixes for incremental searches and redisplay in the C locale. + +jj. Fixes for some use-after-free of the undo list errors when stacking multiple + commands that use rl_maybe_replace_line to save changes to a history entry. + +kk. Fixes to ensure that completion-prefix-display-length and + colored-completion-prefix are mutually exclusive. + +ll. Fixed a bug that allowed a history search to change the current history + list position. + +mm. Fixed a bug that allowed ^G to retain a saved command to execute. + +nn. Updates to new export-completions command to allow filename suffixes. + +oo. Fixed a redisplay bug with prompts containing multiple sequences of + invisible characters that are longer than the screen width. + +pp. The history library no longer skips blank lines while it is reading a + multiline history entry from a history file. + +2. New Features in Readline + +a. Output a newline if there is no prompt and readline reads an empty line. + +b. The history library falls back to stdio when writing the history list if + mmap fails. + +c. New bindable variable `search-ignore-case', causes readline to perform + case-insensitive incremental and non-incremental history searches. + +d. rl_full_quoting_desired: new application-settable variable, causes all + completions to be quoted as if they were filenames. + +e. rl_macro_display_hook: new application-settable function pointer, used if + the application wants to print macro values itself instead of letting + readline do it + +f. rl_reparse_colors: new application-callable function, reparses $LS_COLORS + (presumably after the user changes it) + +g. rl_completion_rewrite_hook: new application-settable function pointer, + called to modify the word being completed before comparing it against + pathnames from the file system. + +h. execute-named-command: a new bindable command that reads the name of a + readline command from the standard input and executes it. Bound to M-x + in emacs mode by default. + +i. Incremental and non-incremental searches now allow ^V/^Q (or, in the former + case, anything bound to quoted-insert) to quote characters in the search + string. + +j. Documentation has been significantly updated. + +k. New `force-meta-prefix' bindable variable, which forces the use of ESC as + the meta prefix when using "\M-" in key bindings instead of overloading + convert-meta. + +l. The default value for `readline-colored-completion-prefix' no longer has a + leading `.'; the original report was based on a misunderstanding. + +m. There is a new bindable command, `export-completions', which writes the + possible completions for a word to the standard output in a defined format. + +n. Readline can reset its idea of the screen dimensions when executing after + a SIGCONT. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-8.2, and +the previous version, readline-8.1. + +1. Changes to Readline + +a. Fixed a problem with cleaning up active marks when using callback mode. + +b. Fixed a problem with arithmetic comparison operators checking the version. + +c. Fixed a problem that could cause readline not to build on systems without + POSIX signal functions. + +d. Fixed a bug that could cause readline to crash if the application removed + the callback line handler before readline read all typeahead. + +e. Added additional checks for read errors in the middle of readline commands. + +f. Fixed a redisplay problem that occurred when switching from the digit- + argument prompt `(arg: N)' back to the regular prompt and the regular + prompt contained invisible characters. + +g. Fixed a problem with restoring the prompt when aborting an incremental + search. + +h. Fix a problem with characters > 128 not being displayed correctly in certain + single-byte encodings. + +i. Fixed a problem with unix-filename-rubout that caused it to delete too much + when applied to a pathname consisting only of one or more slashes. + +j. Fixed a display problem that caused the prompt to be wrapped incorrectly if + the screen changed dimensions during a call to readline() and the prompt + became longer than the screen width. + +k. Fixed a problem that caused the \r output by turning off bracketed paste + to overwrite the line if terminal echo was disabled. + +l. Fixed a bug that could cause colored-completion-prefix to not display if + completion-prefix-display-length was set. + +m. Fixed a problem with line wrapping prompts when a group of invisible + characters runs to the right edge of the screen and the prompt extends + longer then the screen width. + +n. Fixed a couple problems that could cause rl_end to be set incorrectly by + transpose-words. + +o. Prevent some display problems when running a command as the result of a + trap or one bound using `bind -x' and the command generates output. + +p. Fixed an issue with multi-line prompt strings that have one or more + invisible characters at the end of a physical line. + +q. Fixed an issue that caused a history line's undo list to be cleared when + it should not have been. + +r. When replacing a history entry, make sure the existing entry has a non-NULL + timestamp before copying it; it may have been added by the application, not + the history library. + +2. New Features in Readline + +a. There is now an HS_HISTORY_VERSION containing the version number of the + history library for applications to use. + +b. History expansion better understands multiple history expansions that may + contain strings that would ordinarily inhibit history expansion (e.g., + `abc!$!$'). + +c. There is a new framework for readline timeouts, including new public + functions to set timeouts and query how much time is remaining before a + timeout hits, and a hook function that can trigger when readline times + out. There is a new state value to indicate a timeout. + +d. Automatically bind termcap key sequences for page-up and page-down to + history-search-backward and history-search-forward, respectively. + +e. There is a new `fetch-history' bindable command that retrieves the history + entry corresponding to its numeric argument. Negative arguments count back + from the end of the history. + +f. `vi-undo' is now a bindable command. + +g. There is a new option: `enable-active-region'. This separates control of + the active region and bracketed-paste. It has the same default value as + bracketed-paste, and enabling bracketed paste enables the active region. + Users can now turn off the active region while leaving bracketed paste + enabled. + +h. rl_completer_word_break_characters is now `const char *' like + rl_basic_word_break_characters. + +i. Readline looks in $LS_COLORS for a custom filename extension + (*.readline-colored-completion-prefix) and uses that as the default color + for the common prefix displayed when `colored-completion-prefix' is set. + +j. Two new bindable string variables: active-region-start-color and + active-region-end-color. The first sets the color used to display the + active region; the second turns it off. If set, these are used in place + of terminal standout mode. + +k. New readline state (RL_STATE_EOF) and application-visible variable + (rl_eof_found) to allow applications to detect when readline reads EOF + before calling the deprep-terminal hook. + +l. There is a new configuration option: --with-shared-termcap-library, which + forces linking the shared readline library with the shared termcap (or + curses/ncurses/termlib) library so applications don't have to do it. + +m. Readline now checks for changes to locale settings (LC_ALL/LC_CTYPE/LANG) + each time it is called, and modifies the appropriate locale-specific display + and key binding variables when the locale changes. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-8.1, and +the previous version, readline-8.0. + +1. Changes to Readline + +a. There are a number of fixes that were found as the result of fuzzing with + random input. + +b. Changed the revert-all-at-newline behavior to make sure to start at the end + of the history list when doing it, instead of the line where the user hit + return. + +c. When parsing `set' commands from the inputrc file or an application, readline + now allows trailing whitespace. + +d. Fixed a bug that left a file descriptor open to the history file if the + file size was 0. + +e. Fixed a problem with binding key sequences containing meta characters. + +f. Fixed a bug that caused the wrong line to be displayed if the user tried to + move back beyond the beginning of the history list, or forward past the end + of the history list. + +g. If readline catches SIGTSTP, it now sets a hook that allows the calling + application to handle it if it desires. + +h. Fixed a redisplay problem with a prompt string containing embedded newlines. + +i. Fixed a problem with completing filenames containing invalid multibyte + sequences when case-insensitive comparisons are enabled. + +j. Fixed a redisplay problem with prompt strings containing invisible multibyte + characters. + +k. Fixed a problem with multibyte characters mapped to editing commands that + modify the search string in incremental search. + +l. Fixed a bug with maintaining the key sequence while resolving a bound + command in the presence of ambiguous sequences (sequences with a common + prefix), in most cases while attempting to unbind it. + +m. Fixed several buffer overflows found as the result of fuzzing. + +n. Reworked backslash handling when translating key sequences for key binding + to be more uniform and consistent, which introduces a slight backwards + incompatibility. + +o. Fixed a bug with saving the history that resulted in errors not being + propagated to the calling application when the history file is not writable. + +p. Readline only calls chown(2) on a newly-written history file if it really + needs to, instead of having it be a no-op. + +q. Readline now behaves better when operate-and-get-next is used when the + history list is `full': when there are already $HISTSIZE entries. + +r. Fixed a bug that could cause vi redo (`.') of a replace command not to work + correctly in the C or POSIX locale. + +s. Fixed a bug with vi-mode digit arguments that caused the last command to be + set incorrectly. This prevents yank-last-arg from working as intended, for + example. + +t. Make sure that all undo groups are closed when leaving vi insertion mode. + +u. Make sure that the vi-mode `C' and `c' commands enter insert mode even if + the motion command doesn't have any effect. + +v. Fixed several potential memory leaks in the callback mode context handling. + +w. If readline is handling a SIGTTOU, make sure SIGTTOU is blocked while + executing the terminal cleanup code, since it's no longer run in a signal + handling context. + +x. Fixed a bug that could cause an application with an application-specific + redisplay function to crash if the line data structures had not been + initialized. + +y. Terminals that are named "dumb" or unknown do not enable bracketed paste + by default. + +z. Ensure that disabling bracketed paste turns off highlighting the incremental + search string when the search is successful. + +2. New Features in Readline + +a. If a second consecutive completion attempt produces matches where the first + did not, treat it as a new completion attempt and insert a match as + appropriate. + +b. Bracketed paste mode works in more places: incremental search strings, vi + overstrike mode, character search, and reading numeric arguments. + +c. Readline automatically switches to horizontal scrolling if the terminal has + only one line. + +d. Unbinding all key sequences bound to a particular readline function now + descends into keymaps for multi-key sequences. + +e. rl-clear-display: new bindable command that clears the screen and, if + possible, the scrollback buffer (bound to emacs mode M-C-l by default). + +f. New active mark and face feature: when enabled, it will highlight the text + inserted by a bracketed paste (the `active region') and the text found by + incremental and non-incremental history searches. This is tied to bracketed + paste and can be disabled by turning off bracketed paste. + +g. Readline sets the mark in several additional commands. + +h. Bracketed paste mode is enabled by default. There is a configure-time + option (--enable-bracketed-paste-default) to set the default to on or off. + +i. Readline tries to take advantage of the more regular structure of UTF-8 + characters to identify the beginning and end of characters when moving + through the line buffer. + +j. The bindable operate-and-get-next command (and its default bindings) are + now part of readline instead of a bash-specific addition. + +k. The signal cleanup code now blocks SIGINT while processing after a SIGINT. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-8.0, and the +previous version, readline-7.0. + +1. Changes to Readline + +a. Added a guard to prevent nested macros from causing an infinite expansion + loop. + +b. Instead of allocating enough history list entries to hold the maximum list + size, cap the number allocated initially. + +c. Added a strategy to avoid allocating huge amounts of memory if a block of + history entries without timestamps occurs after a block with timestamps. + +d. Added support for keyboard timeouts when an ESC character is the last + character in a macro. + +e. There are several performance improvements when in a UTF-8 locale. + +f. Readline does a better job of preserving the original set of blocked + signals when using pselect() to wait for input. + +g. Fixed a bug that caused multibyte characters in macros to be mishandled. + +h. Fixed several bugs in the code that calculates line breaks when expanding + prompts that span several lines, contain multibyte characters, and contain + invisible character seqeuences. + +i. Fixed several bugs in cursor positioning when displaying lines with prompts + containing invisible characters and multibyte characters. + +j. When performing case-insensitive completion, Readline no longer sorts the + list of matches unless directed to do so. + +k. Fixed a problem with key sequences ending with a backslash. + +l. Fixed out-of-bounds and free memory read errors found via fuzzing. + +m. Fixed several cases where the mark was set to an invalid value. + +n. Fixed a problem with the case-changing operators in the case where the + lower and upper case versions of a character do not have the same number + of bytes. + +o. Handle incremental and non-incremental search character reads returning EOF. + +p. Handle the case where a failing readline command at the end of a multi-key + sequence could be misinterpreted. + +q. The history library now prints a meaningful error message if the history + file isn't a regular file. + +r. Fixed a problem with vi-mode redo (`.') on a command when trying to replace + a multibyte character. + +s. The key binding code now attempts to remove a keymap if a key unbinding + leaves it empty. + +t. Fixed a line-wrapping issue that caused problems for some terminal + emulators. + +u. If there is a key bound to the tty's VDISCARD special character, readline + disables VDISCARD while it is active. + +v. Fixed a problem with exiting bracketed paste mode on terminals that assume + the bracketed paste mode character sequence contains visible characters. + +w. Fixed a bug that could cause a key binding command to refer to an + uninitialized variable. + +x. Added more UTF-8-specific versions of multibyte functions, and optimized + existing functions if the current locale uses UTF-8 encoding. + +y. Fixed a problem with bracketed-paste inserting more than one character and + interacting with other readline functions. + +z. Fixed a bug that caused the history library to attempt to append a history + line to a non-existent history entry. + +aa. If using bracketed paste mode, output a newline after the \r that is the + last character of the mode disable string to avoid overwriting output. + +bb. Fixes to the vi-mode `b', `B', `w', `W', `e', and `E' commands to better + handle multibyte characters. + +cc. Fixed a redisplay problem that caused an extra newline to be generated on + accept-line when the line length is exactly the screenwidth. + +dd. Fixed a bug with adding multibyte characters to an incremental search + string. + +ee. Fixed a bug with redoing text insertions in vi mode. + +ff. Fixed a bug with pasting text into an incremental search string if bracketed + paste mode is enabled. ESC cannot be one of the incremental search + terminator characters for this to work. + +gg. Fixed a bug with anchored search patterns when performing searches in vi + mode. + +2. New Features in Readline + +a. Non-incremental vi-mode search (`N', `n') can search for a shell pattern, as + Posix specifies (uses fnmatch(3) if available). + +b. There are new `next-screen-line' and `previous-screen-line' bindable + commands, which move the cursor to the same column in the next, or previous, + physical line, respectively. + +c. There are default key bindings for control-arrow-key key combinations. + +d. A negative argument (-N) to `quoted-insert' means to insert the next N + characters using quoted-insert. + +e. New public function: rl_check_signals(), which allows applications to + respond to signals that readline catches while waiting for input using + a custom read function. + +f. There is new support for conditionally testing the readline version in an + inputrc file, with a full set of arithmetic comparison operators available. + +g. There is a simple variable comparison facility available for use within an + inputrc file. Allowable operators are equality and inequality; string + variables may be compared to a value; boolean variables must be compared to + either `on' or `off'; variable names are separated from the operator by + whitespace. + +h. The history expansion library now understands command and process + substitution and extended globbing and allows them to appear anywhere in a + word. + +i. The history library has a new variable that allows applications to set the + initial quoting state, so quoting state can be inherited from a previous + line. + +j. Readline now allows application-defined keymap names; there is a new public + function, rl_set_keymap_name(), to do that. + +k. The "Insert" keypad key, if available, now puts readline into overwrite + mode. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-7.0, and the +previous version, readline-6.3. + +1. Changes to Readline + +a. A bug that caused vi-mode `.' to be unable to redo `c', `d', and `y' + commands with modifiers was fixed. + +b. Fixed a bug that caused callback mode to dump core when reading a + multiple-key sequence (e.g., arrow keys). + +c. Fixed a bug that caused the redisplay code to erase some of the line when + using horizontal scrolling with incremental search. + +d. Readline's input handler now performs signal processing if read(2) is + interrupted by SIGALRM or SIGVTALRM. + +e. Fixed a problem with revert-all-at-newline freeing freed memory. + +f. Clarified the documentation for the history_quotes_inhibit_expansion + variable to note that it inhibits scanning for the history comment + character and that it only affects double-quoted strings. + +g. Fixed an off-by-one error in the prompt printed when performing searches. + +h. Use pselect(2), if available, to wait for input before calling read(2), so + a SIGWINCH can interrupt it, since it doesn't interrupt read(2). + +i. Some memory leaks caused by signals interrupting filename completion have + been fixed. + +j. Reading EOF twice on a non-empty line causes EOF to be returned, rather + than the partial line. This can cause partial lines to be executed on + SIGHUP, for example. + +k. Fixed a bug concerning deleting multibyte characters from the search + string while performing an incremental search. + +l. Fixed a bug with tilde expanding directory names in filename completion. + +m. Fixed a bug that did not allow binding sequences beginning with a `\'. + +n. Fixed a redisplay bug involving incorrect line wrapping when the prompt + contains a multibyte character in the last screen column. + +o. Fixed a bug that caused history expansion to disregard characters that are + documented to delimit a history event specifier without requiring `:'. + +p. Fixed a bug that could cause reading past the end of a string when reading + the value when binding the set of isearch terminators. + +q. Fixed a bug that caused readline commands that depend on knowing which + key invoked them to misbehave when dispatching key sequences that are + prefixes of other key bindings. + +r. Paren matching now works in vi insert mode. + +s. Colored completion prefixes are now displayed using a different color, less + likely to collide with files. + +t. Fixed a bug that caused vi-mode character search to misbehave when + running in callback mode. + +u. Fixed a bug that caused output to be delayed when input is coming from a + macro in vi-mode. + +v. Fixed a bug that caused the vi-mode `.' command to misbehave when redoing + a multi-key key sequence via a macro. + +w. Fixed a bug that caused problems with applications that supply their own + input function when performing completion. + +x. When read returns -1/EIO when attempting to read a key, return an error + instead of line termination back to the caller. + +y. Updated tty auditing feature based on patch from Red Hat. + +z. Fixed a bug that could cause the history library to crash on overflows + introduced by malicious editing of timestamps in the history file. + +aa. The history file writing functions only attempt to create and use a backup + history file if the history file exists and is a regular file. + +bb. Fixed an out-of-bounds read in readline's internal tilde expansion interface. + +cc. Fixed several redisplay bugs with prompt strings containing multibyte + and non-visible characters whose physical length is longer than the screen + width. + +dd. Fixed a redisplay bug with prompt strings containing invisible characters + whose physical length exceeds the screen width and using incremental search. + +ee. Readline prints more descriptive error messages when it encounters errors + while reading an inputrc file. + +ff. Fixed a bug in the character insertion code that attempts to optimize + typeahead when it reads a character that is not bound to self-insert and + resets the key sequence state. + +gg. When refreshing the line as the result of a key sequence, Readline attempts + to redraw only the last line of a multiline prompt. + +hh. Fixed an issue that caused completion of git commands to display + incorrectly when using colored-completion-prefix. + +ii. Fixed several redisplay bugs having to do with multibyte characters and + invisible characters in prompt strings. + +jj. Fixed a bug that caused mode strings to be displayed incorrectly if the + prompt was shorter than the mode string. + +2. New Features in Readline + +a. The history truncation code now uses the same error recovery mechanism as + the history writing code, and restores the old version of the history file + on error. The error recovery mechanism handles symlinked history files. + +b. There is a new bindable variable, `enable-bracketed-paste', which enables + support for a terminal's bracketed paste mode. + +c. The editing mode indicators can now be strings and are user-settable + (new `emacs-mode-string', `vi-cmd-mode-string' and `vi-ins-mode-string' + variables). Mode strings can contain invisible character sequences. + Setting mode strings to null strings restores the defaults. + +d. Prompt expansion adds the mode string to the last line of a multi-line + prompt (one with embedded newlines). + +e. There is a new bindable variable, `colored-completion-prefix', which, if + set, causes the common prefix of a set of possible completions to be + displayed in color. + +f. There is a new bindable command `vi-yank-pop', a vi-mode version of emacs- + mode yank-pop. + +g. The redisplay code underwent several efficiency improvements for multibyte + locales. + +h. The insert-char function attempts to batch-insert all pending typeahead + that maps to self-insert, as long as it is coming from the terminal. + +i. rl_callback_sigcleanup: a new application function that can clean up and + unset any state set by readline's callback mode. Intended to be used + after a signal. + +j. If an incremental search string has its last character removed with DEL, the + resulting empty search string no longer matches the previous line. + +k. If readline reads a history file that begins with `#' (or the value of + the history comment character) and has enabled history timestamps, the history + entries are assumed to be delimited by timestamps. This allows multi-line + history entries. + +l. Readline now throws an error if it parses a key binding without a terminating + `:' or whitespace. + +m. The default binding for ^W in vi mode now uses word boundaries specified + by Posix (vi-unix-word-rubout is bindable command name). + +n. rl_clear_visible_line: new application-callable function; clears all + screen lines occupied by the current visible readline line. + +o. rl_tty_set_echoing: application-callable function that controls whether + or not readline thinks it is echoing terminal output. + +p. Handle >| and strings of digits preceding and following redirection + specifications as single tokens when tokenizing the line for history + expansion. + +q. Fixed a bug with displaying completions when the prefix display length + is greater than the length of the completions to be displayed. + +r. The :p history modifier now applies to the entire line, so any expansion + specifying :p causes the line to be printed instead of expanded. + +s. New application-callable function: rl_pending_signal(): returns the signal + number of any signal readline has caught but not yet handled. + +t. New application-settable variable: rl_persistent_signal_handlers: if set + to a non-zero value, readline will enable the readline-6.2 signal handler + behavior in callback mode: handlers are installed when + rl_callback_handler_install is called and removed removed when a complete + line has been read. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-6.3, and the +previous version, readline-6.2. + +1. Changes to Readline + +a. Fixed a bug that did not allow the `dd', `cc', or `yy' vi editing mode + commands to work on the entire line. + +b. Fixed a bug that caused redisplay problems with prompts longer than 128 + characters and history searches. + +c. Fixed a bug that caused readline to try and run code to modify its idea + of the screen size in a signal handler context upon receiving a SIGWINCH. + +d. Fixed a bug that caused the `meta' key to be enabled beyond the duration + of an individual call top readline(). + +e. Added a workaround for a wcwidth bug in Mac OS X that caused readline's + redisplay to mishandle zero-width combining characters. + +f. Fixed a bug that caused readline to `forget' part of a key sequence when + a multiple-key sequence caused it to break out of an incremental search. + +g. Fixed bugs that caused readline to execute code in a signal handler + context if interrupted while reading from the file system during completion. + +h. Fixed a bug that caused readline to `forget' part of a key sequence when + reading an unbound multi-character key sequence. + +i. Fixed a bug that caused Readline's signal handlers to be installed beyond + the bounds of a single call to readline(). + +j. Fixed a bug that caused the `.' command to not redo the most recent `R' + command in vi mode. + +k. Fixed a bug that caused ignoring case in completion matches to result in + readline using the wrong match. + +l. Paren matching now works in vi insert mode. + +m. Fix menu-completion to make show-all-if-ambiguous and menu-complete-display-prefix + work together. + +n. Fixed a bug that didn't allow the `cc', `dd', or `yy' commands to be redone + in vi editing mode. + +o. Fixed a bug that caused the filename comparison code to not compare + multibyte characters correctly when using case-sensitive or case-mapping + comparisons. + +p. Fixed the input reading loop to call the input hook function only when there + is no terminal input available. + +q. Fixed a bug that caused binding a macro to a multi-character key sequence + where the sequence and macro value share a common prefix to not perform + the macro replacement. + +r. Fixed several redisplay errors with multibyte characters and prompts + containing invisible characters when using horizontal scrolling. + +s. Fixed a bug that caused redisplay errors when trying to overwrite + existing characters using multibyte characters. + +t. Fixed a bug in vi mode that caused the arrow keys to set the saved last + vi-mode command to the wrong value. + +u. Fixed a bug that caused double-quoted strings to be scanned incorrectly + when being used as the value of a readline variable assignment. + +v. Fixed a bug with vi mode that prevented `.' from repeating a command + entered on a previous line (command). + +w. Fixed a bug that could cause completion to core dump if it was interrupted + by a signal. + +x. Fixed a bug that could cause readline to crash and seg fault attempting to + expand an empty history entry. + +y. Fixed a bug that caused display problems with multi-line prompts containing + invisible characters on multiple lines. + +z. Fixed a bug that caused effects made by undoing changes to a history line to + be discarded. + +2. New Features in Readline + +a. Readline is now more responsive to SIGHUP and other fatal signals when + reading input from the terminal or performing word completion but no + longer attempts to run any not-allowable functions from a signal handler + context. + +b. There are new bindable commands to search the history for the string of + characters between the beginning of the line and the point + (history-substring-search-forward, history-substring-search-backward) + +c. Readline allows quoted strings as the values of variables when setting + them with `set'. As a side effect, trailing spaces and tabs are ignored + when setting a string variable's value. + +d. The history library creates a backup of the history file when writing it + and restores the backup on a write error. + +e. New application-settable variable: rl_filename_stat_hook: a function called + with a filename before using it in a call to stat(2). Bash uses it to + expand shell variables so things like $HOME/Downloads have a slash + appended. + +f. New bindable function `print-last-kbd-macro', prints the most-recently- + defined keyboard macro in a reusable format. + +g. New user-settable variable `colored-stats', enables use of colored text + to denote file types when displaying possible completions (colored analog + of visible-stats). + +h. New user-settable variable `keyseq-timout', acts as an inter-character + timeout when reading input or incremental search strings. + +i. New application-callable function: rl_clear_history. Clears the history list + and frees all readline-associated private data. + +j. New user-settable variable, show-mode-in-prompt, adds a characters to the + beginning of the prompt indicating the current editing mode. + +k. New application-settable variable: rl_input_available_hook; function to be + called when readline needs to check whether there is data available on its + input source. The default hook checks rl_instream. + +l. Readline calls an application-set event hook (rl_signal_event_hook) after + it gets a signal while reading input (read returns -1/EINTR but readline + does not handle the signal immediately) to allow the application to handle + or otherwise note it. Not currently called for SIGHUP or SIGTERM. + +m. If the user-settable variable `history-size' is set to a value less than + 0, the history list size is unlimited. + +n. When creating shared libraries on Mac OS X, the pathname written into the + library (install_name) no longer includes the minor version number. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-6.2, +and the previous version, readline-6.1. + +1. Changes to Readline + +a. Fixed a bug that caused the unconverted filename to be added to the list of + completions when the application specified filename conversion functions. + +b. Fixed a bug that caused the wrong filename to be passed to opendir when the + application has specified a filename dequoting function. + +c. Fixed a bug when repeating a character search in vi mode in the case where + there was no search to repeat. + +d. When show-all-if-ambiguous is set, the completion routines no longer insert + a common match prefix that is shorter than the text being completed. + +e. The full set of vi editing commands may now be used in callback mode. + +f. Fixed a bug that caused readline to not update its idea of the terminal + dimensions while running in `no-echo' mode. + +h. Fixed a bug that caused readline to dump core if an application called + rl_prep_terminal without setting rl_instream. + +i. Fixed a bug that caused meta-prefixed characters bound to incremental + search forward or backward to not be recognized if they were typed + subsequently. + +j. The incremental search code treats key sequences that map to the same + functions as (default) ^G, ^W, and ^Y as equivalent to those characters. + +k. Fixed a bug in menu-complete that caused it to misbehave with large + negative argument. + +l. Fixed a bug that caused vi-mode yank-last-arg to ring the bell when invoked + at the end of the line. + +m. Fixed a bug that made an explicit argument of 0 to yank-last-arg behave + as if it were a negative argument. + +n. Fixed a bug that caused directory names in words to be completed to not + be dequoted correctly. + +2. New Features in Readline + +a. The history library does not try to write the history filename in the + current directory if $HOME is unset. This closes a potential security + problem if the application does not specify a history filename. + +b. New bindable variable `completion-display-width' to set the number of + columns used when displaying completions. + +c. New bindable variable `completion-case-map' to cause case-insensitive + completion to treat `-' and `_' as identical. + +d. There are new bindable vi-mode command names to avoid readline's case- + insensitive matching not allowing them to be bound separately. + +e. New bindable variable `menu-complete-display-prefix' causes the menu + completion code to display the common prefix of the possible completions + before cycling through the list, instead of after. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-6.1, +and the previous version, readline-6.0. + +1. Changes to Readline + +a. The SIGWINCH signal handler now avoids calling the redisplay code if + one arrives while in the middle of redisplay. + +b. Changes to the timeout code to make sure that timeout values greater + than one second are handled better. + +c. Fixed a bug in the redisplay code that was triggered by a prompt + containing invisible characters exactly the width of the screen. + +d. Fixed a bug in the redisplay code encountered when running in horizontal + scroll mode. + +e. Fixed a bug that prevented menu completion from properly completing + filenames. + +f. Fixed a redisplay bug caused by a multibyte character causing a line to + wrap. + +g. Fixed a bug that caused key sequences of two characters to not be + recognized when a longer sequence identical in the first two characters + was bound. + +h. Fixed a bug that caused history expansion to be attempted on $'...' + single-quoted strings. + +i. Fixed a bug that caused incorrect redisplay when the prompt contained + multibyte characters in an `invisible' sequence bracketed by \[ and + \]. + +j. Fixed a bug that caused history expansion to short-circuit after + encountering a multibyte character. + +k. Fixed a bug that caused applications using the callback interface to not + react to SIGINT (or other signals) until another character arrived. + +2. New Features in Readline + +a. New bindable function: menu-complete-backward. + +b. In the vi insertion keymap, C-n is now bound to menu-complete by default, + and C-p to menu-complete-backward. + +c. When in vi command mode, repeatedly hitting ESC now does nothing, even + when ESC introduces a bound key sequence. This is closer to how + historical vi behaves. + +d. New bindable function: skip-csi-sequence. Can be used as a default to + consume key sequences generated by keys like Home and End without having + to bind all keys. + +e. New application-settable function: rl_filename_rewrite_hook. Can be used + to rewrite or modify filenames read from the file system before they are + compared to the word to be completed. + +f. New bindable variable: skip-completed-text, active when completing in the + middle of a word. If enabled, it means that characters in the completion + that match characters in the remainder of the word are "skipped" rather + than inserted into the line. + +g. The pre-readline-6.0 version of menu completion is available as + "old-menu-complete" for users who do not like the readline-6.0 version. + +h. New bindable variable: echo-control-characters. If enabled, and the + tty ECHOCTL bit is set, controls the echoing of characters corresponding + to keyboard-generated signals. + +i. New bindable variable: enable-meta-key. Controls whether or not readline + sends the smm/rmm sequences if the terminal indicates it has a meta key + that enables eight-bit characters. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-6.0, +and the previous version, readline-5.2. + +1. Changes to Readline + +a. Fixed a number of redisplay errors in environments supporting multibyte + characters. + +b. Fixed bugs in vi command mode that caused motion commands to inappropriately + set the mark. + +c. When using the arrow keys in vi insertion mode, readline allows movement + beyond the current end of the line (unlike command mode). + +d. Fixed bugs that caused readline to loop when the terminal has been taken + away and reads return -1/EIO. + +e. Fixed bugs in redisplay occurring when displaying prompts containing + invisible characters. + +f. Fixed a bug that caused the completion append character to not be reset to + the default after an application-specified completion function changed it. + +g. Fixed a problem that caused incorrect positioning of the cursor while in + emacs editing mode when moving forward at the end of a line while using + a locale supporting multibyte characters. + +h. Fixed an off-by-one error that caused readline to drop every 511th + character of buffered input. + +i. Fixed a bug that resulted in SIGTERM not being caught or cleaned up. + +j. Fixed redisplay bugs caused by multiline prompts with invisible characters + or no characters following the final newline. + +k. Fixed redisplay bug caused by prompts consisting solely of invisible + characters. + +l. Fixed a bug in the code that buffers characters received very quickly in + succession which caused characters to be dropped. + +m. Fixed a bug that caused readline to reference uninitialized data structures + if it received a SIGWINCH before completing initialization. + +n. Fixed a bug that caused the vi-mode `last command' to be set incorrectly + and therefore unrepeatable. + +o. Fixed a bug that caused readline to disable echoing when it was being used + with an output file descriptor that was not a terminal. + +p. Readline now blocks SIGINT while manipulating internal data structures + during redisplay. + +q. Fixed a bug in redisplay that caused readline to segfault when pasting a + very long line (over 130,000 characters). + +r. Fixed bugs in redisplay when using prompts with no visible printing + characters. + +s. Fixed a bug that caused redisplay errors when using prompts with invisible + characters and numeric arguments to a command in a multibyte locale. + +t. Fixed a bug that caused redisplay errors when using prompts with invisible + characters spanning more than two physical screen lines. + +2. New Features in Readline + +a. A new variable, rl_sort_completion_matches; allows applications to inhibit + match list sorting (but beware: some things don't work right if + applications do this). + +b. A new variable, rl_completion_invoking_key; allows applications to discover + the key that invoked rl_complete or rl_menu_complete. + +c. The functions rl_block_sigint and rl_release_sigint are now public and + available to calling applications who want to protect critical sections + (like redisplay). + +d. The functions rl_save_state and rl_restore_state are now public and + available to calling applications; documented rest of readline's state + flag values. + +e. A new user-settable variable, `history-size', allows setting the maximum + number of entries in the history list. + +f. There is a new implementation of menu completion, with several improvements + over the old; the most notable improvement is a better `completions + browsing' mode. + +g. The menu completion code now uses the rl_menu_completion_entry_function + variable, allowing applications to provide their own menu completion + generators. + +h. There is support for replacing a prefix of a pathname with a `...' when + displaying possible completions. This is controllable by setting the + `completion-prefix-display-length' variable. Matches with a common prefix + longer than this value have the common prefix replaced with `...'. + +i. There is a new `revert-all-at-newline' variable. If enabled, readline will + undo all outstanding changes to all history lines when `accept-line' is + executed. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-5.2, +and the previous version, readline-5.1. + +1. Changes to Readline + +a. Fixed a problem that caused segmentation faults when using readline in + callback mode and typing consecutive DEL characters on an empty line. + +b. Fixed several redisplay problems with multibyte characters, all having to + do with the different code paths and variable meanings between single-byte + and multibyte character redisplay. + +c. Fixed a problem with key sequence translation when presented with the + sequence \M-\C-x. + +d. Fixed a problem that prevented the `a' command in vi mode from being + undone and redone properly. + +e. Fixed a problem that prevented empty inserts in vi mode from being undone + properly. + +f. Fixed a problem that caused readline to initialize with an incorrect idea + of whether or not the terminal can autowrap. + +g. Fixed output of key bindings (like bash `bind -p') to honor the setting of + convert-meta and use \e where appropriate. + +h. Changed the default filename completion function to call the filename + dequoting function if the directory completion hook isn't set. This means + that any directory completion hooks need to dequote the directory name, + since application-specific hooks need to know how the word was quoted, + even if no other changes are made. + +i. Fixed a bug with creating the prompt for a non-interactive search string + when there are non-printing characters in the primary prompt. + +j. Fixed a bug that caused prompts with invisible characters to be redrawn + multiple times in a multibyte locale. + +k. Fixed a bug that could cause the key sequence scanning code to return the + wrong function. + +l. Fixed a problem with the callback interface that caused it to fail when + using multi-character keyboard macros. + +m. Fixed a bug that could cause a core dump when an edited history entry was + re-executed under certain conditions. + +n. Fixed a bug that caused readline to reference freed memory when attmpting + to display a portion of the prompt. + +o. Fixed a bug with prompt redisplay in a multi-byte locale to avoid redrawing + the prompt and input line multiple times. + +p. Fixed history expansion to not be confused by here-string redirection. + +q. Readline no longer treats read errors by converting them to newlines, as + it does with EOF. This caused partial lines to be returned from readline(). + +r. Fixed a redisplay bug that occurred in multibyte-capable locales when the + prompt was one character longer than the screen width. + +2. New Features in Readline + +a. Calling applications can now set the keyboard timeout to 0, allowing + poll-like behavior. + +b. The value of SYS_INPUTRC (configurable at compilation time) is now used as + the default last-ditch startup file. + +c. The history file reading functions now allow windows-like \r\n line + terminators. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-5.1, +and the previous version, readline-5.0. + +1. Changes to Readline + +a. Fixed a bug that caused multiliine prompts to be wrapped and displayed + incorrectly. + +b. Fixed a bug that caused ^P/^N in emacs mode to fail to display the current + line correctly. + +c. Fixed a problem in computing the number of invisible characters on the first + line of a prompt whose length exceeds the screen width. + +d. Fixed vi-mode searching so that failure preserves the current line rather + than the last line in the history list. + +e. Fixed the vi-mode `~' command (change-case) to have the correct behavior at + end-of-line when manipulating multibyte characters. + +f. Fixed the vi-mode `r' command (change-char) to have the correct behavior at + end-of-line when manipulating multibyte characters. + +g. Fixed multiple bugs in the redisplay of multibyte characters: displaying + prompts longer than the screen width containing multibyte characters, + +h. Fix the calculation of the number of physical characters in the prompt + string when it contains multibyte characters. + +i. A non-zero value for the `rl_complete_suppress_append' variable now causes + no `/' to be appended to a directory name. + +j. Fixed forward-word and backward-word to work when words contained + multibyte characters. + +k. Fixed a bug in finding the delimiter of a `?' substring when performing + history expansion in a locale that supports multibyte characters. + +l. Fixed a memory leak caused by not freeing the timestamp in a history entry. + +m. Fixed a bug that caused "\M-x" style key bindings to not obey the setting + of the `convert-meta' variable. + +n. Fixed saving and restoring primary prompt when prompting for incremental + and non-incremental searches; search prompts now display multibyte + characters correctly. + +o. Fixed a bug that caused keys originally bound to self-insert but shadowed + by a multi-character key sequence to not be inserted. + +p. Fixed code so rl_prep_term_function and rl_deprep_term_function aren't + dereferenced if NULL (matching the documentation). + +q. Extensive changes to readline to add enough state so that commands + requiring additional characters (searches, multi-key sequences, numeric + arguments, commands requiring an additional specifier character like + vi-mode change-char, etc.) work without synchronously waiting for + additional input. + +r. Lots of changes so readline builds and runs on MinGW. + +s. Readline no longer tries to modify the terminal settings when running in + callback mode. + +t. The Readline display code no longer sets the location of the last invisible + character in the prompt if the \[\] sequence is empty. + +u. The `change-case' command now correctly changes the case of multibyte + characters. + +v. Changes to the shared library construction scripts to deal with Windows + DLL naming conventions for Cygwin. + +w. Fixed the redisplay code to avoid core dumps resulting from a poorly-timed + SIGWINCH. + +x. Fixed the non-incremental search code in vi mode to dispose of any current + undo list when copying a line from the history into the current editing + buffer. + +y. Fixed a bug that caused reversing the incremental search direction to + not work correctly. + +z. Fixed the vi-mode `U' command to only undo up to the first time insert mode + was entered, as Posix specifies. + +aa. Fixed a bug in the vi-mode `r' command that left the cursor in the wrong + place. + +bb. Fixed a redisplay bug caused by moving the cursor vertically to a line + with invisible characters in the prompt in a multibyte locale. + +cc. Fixed a bug that could cause the terminal special chars to be bound in the + wrong keymap in vi mode. + +2. New Features in Readline + +a. The key sequence sent by the keypad `delete' key is now automatically + bound to delete-char. + +b. A negative argument to menu-complete now cycles backward through the + completion list. + +c. A new bindable readline variable: bind-tty-special-chars. If non-zero, + readline will bind the terminal special characters to their readline + equivalents when it's called (on by default). + +d. New bindable command: vi-rubout. Saves deleted text for possible + reinsertion, as with any vi-mode `text modification' command; `X' is bound + to this in vi command mode. + +e. If the rl_completion_query_items is set to a value < 0, readline never + asks the user whether or not to view the possible completions. + +f. The `C-w' binding in incremental search now understands multibyte + characters. + +g. New application-callable auxiliary function, rl_variable_value, returns + a string corresponding to a readline variable's value. + +h. When parsing inputrc files and variable binding commands, the parser + strips trailing whitespace from values assigned to boolean variables + before checking them. + +i. A new external application-controllable variable that allows the LINES + and COLUMNS environment variables to set the window size regardless of + what the kernel returns. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-5.0, +and the previous version, readline-4.3. + +1. Changes to Readline + +a. Fixes to avoid core dumps because of null pointer references in the + multibyte character code. + +b. Fix to avoid infinite recursion caused by certain key combinations. + +c. Fixed a bug that caused the vi-mode `last command' to be set incorrectly. + +d. Readline no longer tries to read ahead more than one line of input, even + when more is available. + +e. Fixed the code that adjusts the point to not mishandle null wide + characters. + +f. Fixed a bug in the history expansion `g' modifier that caused it to skip + every other match. + +g. Fixed a bug that caused the prompt to overwrite previous output when the + output doesn't contain a newline and the locale supports multibyte + characters. This same change fixes the problem of readline redisplay + slowing down dramatically as the line gets longer in multibyte locales. + +h. History traversal with arrow keys in vi insertion mode causes the cursor + to be placed at the end of the new line, like in emacs mode. + +i. The locale initialization code does a better job of using the right + precedence and defaulting when checking the appropriate environment + variables. + +j. Fixed the history word tokenizer to handle <( and >( better when used as + part of bash. + +k. The overwrite mode code received several bug fixes to improve undo. + +l. Many speedups to the multibyte character redisplay code. + +m. The callback character reading interface should not hang waiting to read + keyboard input. + +n. Fixed a bug with redoing vi-mode `s' command. + +o. The code that initializes the terminal tracks changes made to the terminal + special characters with stty(1) (or equivalent), so that these changes + are reflected in the readline bindings. New application-callable function + to make it work: rl_tty_unset_default_bindings(). + +p. Fixed a bug that could cause garbage to be inserted in the buffer when + changing character case in vi mode when using a multibyte locale. + +q. Fixed a bug in the redisplay code that caused problems on systems + supporting multibyte characters when moving between history lines when the + new line has more glyphs but fewer bytes. + +r. Undo and redo now work better after exiting vi insertion mode. + +s. Make sure system calls are restarted after a SIGWINCH is received using + SA_RESTART. + +t. Improvements to the code that displays possible completions when using + multibyte characters. + +u. Fixed a problem when parsing nested if statements in inputrc files. + +v. The completer now takes multibyte characters into account when looking for + quoted substrings on which to perform completion. + +w. The history search functions now perform better bounds checking on the + history list. + +x. Change to history expansion functions to treat `^' as equivalent to word + one, as the documentation states. + +y. Some changes to the display code to improve display and redisplay of + multibyte characters. + +z. Changes to speed up the multibyte character redisplay code. + +aa. Fixed a bug in the vi-mode `E' command that caused it to skip over the + last character of a word if invoked while point was on the word's + next-to-last character. + +bb. Fixed a bug that could cause incorrect filename quoting when + case-insensitive completion was enabled and the word being completed + contained backslashes quoting word break characters. + +cc. Fixed a bug in redisplay triggered when the prompt string contains + invisible characters. + +dd. Fixed some display (and other) bugs encountered in multibyte locales + when a non-ascii character was the last character on a line. + +ee. Fixed some display bugs caused by multibyte characters in prompt strings. + +ff. Fixed a problem with history expansion caused by non-whitespace characters + used as history word delimiters. + +gg. Fixed a problem that could cause readline to refer to freed memory when + moving between history lines while doing searches. + +hh. Improvements to the code that expands and displays prompt strings + containing multibyte characters. + +ii. Fixed a problem with vi-mode not correctly remembering the numeric argument + to the last `c'hange command for later use with `.'. + +jj. Fixed a bug in vi-mode that caused multi-digit count arguments to work + incorrectly. + +kk. Fixed a problem in vi-mode that caused the last text modification command + to not be remembered across different command lines. + +ll. Fixed problems with changing characters and changing case at the end of + the line. + +mm. Fixed a problem with readline saving the contents of the current line + before beginning a non-interactive search. + +nn. Fixed a problem with EOF detection when using rl_event_hook. + +oo. Fixed a problem with the vi mode `p' and `P' commands ignoring numeric + arguments. + +2. New Features in Readline + +a. History expansion has a new `a' modifier equivalent to the `g' modifier + for compatibility with the BSD csh. + +b. History expansion has a new `G' modifier equivalent to the BSD csh `g' + modifier, which performs a substitution once per word. + +c. All non-incremental search operations may now undo the operation of + replacing the current line with the history line. + +d. The text inserted by an `a' command in vi mode can be reinserted with + `.'. + +e. New bindable variable, `show-all-if-unmodified'. If set, the readline + completer will list possible completions immediately if there is more + than one completion and partial completion cannot be performed. + +f. There is a new application-callable `free_history_entry()' function. + +g. History list entries now contain timestamp information; the history file + functions know how to read and write timestamp information associated + with each entry. + +h. Four new key binding functions have been added: + + rl_bind_key_if_unbound() + rl_bind_key_if_unbound_in_map() + rl_bind_keyseq_if_unbound() + rl_bind_keyseq_if_unbound_in_map() + +i. New application variable, rl_completion_quote_character, set to any + quote character readline finds before it calls the application completion + function. + +j. New application variable, rl_completion_suppress_quote, settable by an + application completion function. If set to non-zero, readline does not + attempt to append a closing quote to a completed word. + +k. New application variable, rl_completion_found_quote, set to a non-zero + value if readline determines that the word to be completed is quoted. + Set before readline calls any application completion function. + +l. New function hook, rl_completion_word_break_hook, called when readline + needs to break a line into words when completion is attempted. Allows + the word break characters to vary based on position in the line. + +m. New bindable command: unix-filename-rubout. Does the same thing as + unix-word-rubout, but adds `/' to the set of word delimiters. + +n. When listing completions, directories have a `/' appended if the + `mark-directories' option has been enabled. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-4.3, +and the previous version, readline-4.2a. + +1. Changes to Readline + +a. Fixed output of comment-begin character when listing variable values. + +b. Added some default key bindings for common escape sequences produced by + HOME and END keys. + +c. Fixed the mark handling code to be more emacs-compatible. + +d. A bug was fixed in the code that prints possible completions to keep it + from printing empty strings in certain circumstances. + +e. Change the key sequence printing code to print ESC as M\- if ESC is a + meta-prefix character -- it's easier for users to understand than \e. + +f. Fixed unstifle_history() to return values that match the documentation. + +g. Fixed the event loop (rl_event_hook) to handle the case where the input + file descriptor is invalidated. + +h. Fixed the prompt display code to work better when the application has a + custom redisplay function. + +i. Changes to make reading and writing the history file a little faster, and + to cope with huge history files without calling abort(3) from xmalloc. + +j. The vi-mode `S' and `s' commands are now undone correctly. + +k. Fixed a problem which caused the display to be messed up when the last + line of a multi-line prompt (possibly containing invisible characters) + was longer than the screen width. + +2. New Features in Readline + +a. Support for key `subsequences': allows, e.g., ESC and ESC-a to both + be bound to readline functions. Now the arrow keys may be used in vi + insert mode. + +b. When listing completions, and the number of lines displayed is more than + the screen length, readline uses an internal pager to display the results. + This is controlled by the `page-completions' variable (default on). + +c. New code to handle editing and displaying multibyte characters. + +d. The behavior introduced in bash-2.05a of deciding whether or not to + append a slash to a completed name that is a symlink to a directory has + been made optional, controlled by the `mark-symlinked-directories' + variable (default is the 2.05a behavior). + +e. The `insert-comment' command now acts as a toggle if given a numeric + argument: if the first characters on the line don't specify a + comment, insert one; if they do, delete the comment text + +f. New application-settable completion variable: + rl_completion_mark_symlink_dirs, allows an application's completion + function to temporarily override the user's preference for appending + slashes to names which are symlinks to directories. + +g. New function available to application completion functions: + rl_completion_mode, to tell how the completion function was invoked + and decide which argument to supply to rl_complete_internal (to list + completions, etc.). + +h. Readline now has an overwrite mode, toggled by the `overwrite-mode' + bindable command, which could be bound to `Insert'. + +i. New application-settable completion variable: + rl_completion_suppress_append, inhibits appending of + rl_completion_append_character to completed words. + +j. New key bindings when reading an incremental search string: ^W yanks + the currently-matched word out of the current line into the search + string; ^Y yanks the rest of the current line into the search string, + DEL or ^H deletes characters from the search string. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-4.2a, +and the previous version, readline-4.2. + +1. Changes to Readline + +a. More `const' and type casting fixes. + +b. Changed rl_message() to use vsnprintf(3) (if available) to fix buffer + overflow problems. + +c. The completion code no longer appends a `/' or ` ' to a match when + completing a symbolic link that resolves to a directory name, unless + the match does not add anything to the word being completed. This + means that a tab will complete the word up to the full name, but not + add anything, and a subsequent tab will add a slash. + +d. Fixed a trivial typo that made the vi-mode `dT' command not work. + +e. Fixed the tty code so that ^S and ^Q can be inserted with rl_quoted_insert. + +f. Fixed the tty code so that ^V works more than once. + +g. Changed the use of __P((...)) for function prototypes to PARAMS((...)) + because the use of __P in typedefs conflicted g++ and glibc. + +h. The completion code now attempts to do a better job of preserving the + case of the word the user typed if ignoring case in completions. + +i. Readline defaults to not echoing the input and lets the terminal + initialization code enable echoing if there is a controlling terminal. + +j. The key binding code now processes only two hex digits after a `\x' + escape sequence, and the documentation was changed to note that the + octal and hex escape sequences result in an eight-bit value rather + than strict ASCII. + +k. Fixed a few places where negative array subscripts could have occurred. + +l. Fixed the vi-mode code to use a better method to determine the bounds of + the array used to hold the marks, and to avoid out-of-bounds references. + +m. Fixed the defines in chardefs.h to work better when chars are signed. + +n. Fixed configure.in to use the new names for bash autoconf macros. + +o. Readline no longer attempts to define its own versions of some ctype + macros if they are implemented as functions in libc but not as macros in + . + +p. Fixed a problem where rl_backward could possibly set point to before + the beginning of the line. + +q. Fixed Makefile to not put -I/usr/include into CFLAGS, since it can cause + include file problems. + +2. New Features in Readline + +a. Added extern declaration for rl_get_termcap to readline.h, making it a + public function (it was always there, just not in readline.h). + +b. New #defines in readline.h: RL_READLINE_VERSION, currently 0x0402, + RL_VERSION_MAJOR, currently 4, and RL_VERSION_MINOR, currently 2. + +c. New readline variable: rl_readline_version, mirrors RL_READLINE_VERSION. + +d. New bindable boolean readline variable: match-hidden-files. Controls + completion of files beginning with a `.' (on Unix). Enabled by default. + +e. The history expansion code now allows any character to terminate a + `:first-' modifier, like csh. + +f. The incremental search code remembers the last search string and uses + it if ^R^R is typed without a search string. + +h. New bindable variable `history-preserve-point'. If set, the history + code attempts to place the user at the same location on each history + line retrieved with previous-history or next-history. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-4.2, +and the previous version, readline-4.1. + +1. Changes to Readline + +a. When setting the terminal attributes on systems using `struct termio', + readline waits for output to drain before changing the attributes. + +b. A fix was made to the history word tokenization code to avoid attempts to + dereference a null pointer. + +c. Readline now defaults rl_terminal_name to $TERM if the calling application + has left it unset, and tries to initialize with the resultant value. + +d. Instead of calling (*rl_getc_function)() directly to get input in certain + places, readline now calls rl_read_key() consistently. + +e. Fixed a bug in the completion code that allowed a backslash to quote a + single quote inside a single-quoted string. + +f. rl_prompt is no longer assigned directly from the argument to readline(), + but uses memory allocated by readline. This allows constant strings to + be passed to readline without problems arising when the prompt processing + code wants to modify the string. + +g. Fixed a bug that caused non-interactive history searches to return the + wrong line when performing multiple searches backward for the same string. + +h. Many variables, function arguments, and function return values are now + declared `const' where appropriate, to improve behavior when linking with + C++ code. + +i. The control character detection code now works better on systems where + `char' is unsigned by default. + +j. The vi-mode numeric argument is now capped at 999999, just like emacs mode. + +k. The Function, CPFunction, CPPFunction, and VFunction typedefs have been + replaced with a set of specific prototyped typedefs, though they are + still in the readline header files for backwards compatibility. + +m. Nearly all of the (undocumented) internal global variables in the library + now have an _rl_ prefix -- there were a number that did not, like + screenheight, screenwidth, alphabetic, etc. + +n. The ding() convenience function has been renamed to rl_ding(), though the + old function is still defined for backwards compatibility. + +o. The completion convenience functions filename_completion_function, + username_completion_function, and completion_matches now have an rl_ + prefix, though the old names are still defined for backwards compatibility. + +p. The functions shared by readline and bash (linkage is satisfied from bash + when compiling with bash, and internally otherwise) now have an sh_ prefix. + +q. Changed the shared library creation procedure on Linux and BSD/OS 4.x so + that the `soname' contains only the major version number rather than the + major and minor numbers. + +r. Fixed a redisplay bug that occurred when the prompt spanned more than one + physical line and contained invisible characters. + +s. Added a missing `includedir' variable to the Makefile. + +t. When installing the shared libraries, make sure symbolic links are relative. + +u. Added configure test so that it can set `${MAKE}' appropriately. + +v. Fixed a bug in rl_forward that could cause the point to be set to before + the beginning of the line in vi mode. + +w. Fixed a bug in the callback read-char interface to make it work when a + readline function pushes some input onto the input stream with + rl_execute_next (like the incremental search functions). + +x. Fixed a file descriptor leak in the history file manipulation code that + was tripped when attempting to truncate a non-regular file (like + /dev/null). + +y. Changes to make all of the exported readline functions declared in + readline.h have an rl_ prefix (rltty_set_default_bindings is now + rl_tty_set_default_bindings, crlf is now rl_crlf, etc.) + +z. The formatted documentation included in the base readline distribution + is no longer removed on a `make distclean'. + +aa. Some changes were made to avoid gcc warnings with -Wall. + +bb. rl_get_keymap_by_name now finds keymaps case-insensitively, so + `set keymap EMACS' works. + +cc. The history file writing and truncation functions now return a useful + status on error. + +dd. Fixed a bug that could cause applications to dereference a NULL pointer + if a NULL second argument was passed to history_expand(). + +ee. If a hook function assigned to rl_event_hook sets rl_done to a non-zero + value, rl_read_key() now immediately returns '\n' (which is assumed to + be bound to accept-line). + +2. New Features in Readline + +a. The blink timeout for paren matching is now settable by applications, + via the rl_set_paren_blink_timeout() function. + +b. _rl_executing_macro has been renamed to rl_executing_macro, which means + it's now part of the public interface. + +c. Readline has a new variable, rl_readline_state, which is a bitmap that + encapsulates the current state of the library; intended for use by + callbacks and hook functions. + +d. rlfe has a new -l option to log input and output (-a appends to logfile), + a new -n option to set the readline application name, and -v and -h + options for version and help information. + +e. rlfe can now perform filename completion for the inferior process if the + OS has a /proc//cwd that can be read with readlink(2) to get the + inferior's current working directory. + +f. A new file, rltypedefs.h, contains the new typedefs for function pointers + and is installed by `make install'. + +g. New application-callable function rl_set_prompt(const char *prompt): + expands its prompt string argument and sets rl_prompt to the result. + +h. New application-callable function rl_set_screen_size(int rows, int cols): + public method for applications to set readline's idea of the screen + dimensions. + +i. The history example program (examples/histexamp.c) is now built as one + of the examples. + +j. The documentation has been updated to cover nearly all of the public + functions and variables declared in readline.h. + +k. New function, rl_get_screen_size (int *rows, int *columns), returns + readline's idea of the screen dimensions. + +l. The timeout in rl_gather_tyi (readline keyboard input polling function) + is now settable via a function (rl_set_keyboard_input_timeout()). + +m. Renamed the max_input_history variable to history_max_entries; the old + variable is maintained for backwards compatibility. + +n. The list of characters that separate words for the history tokenizer is + now settable with a variable: history_word_delimiters. The default + value is as before. + +o. There is a new history.3 manual page documenting the history library. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-4.1, +and the previous version, readline-4.0. + +1. Changes to Readline + +a. Changed the HTML documents so that the table-of-contents is no longer + a separate file. + +b. Changes to the shared object configuration for: Irix 5.x, Irix 6.x, + OSF/1. + +c. The shared library major and minor versions are now constructed + automatically by configure and substituted into the makefiles. + +d. It's now possible to install the shared libraries separately from the + static libraries. + +e. The history library tries to truncate the history file only if it is a + regular file. + +f. A bug that caused _rl_dispatch to address negative array indices on + systems with signed chars was fixed. + +g. rl-yank-nth-arg now leaves the history position the same as when it was + called. + +h. Changes to the completion code to handle MS-DOS drive-letter:pathname + filenames. + +i. Completion is now case-insensitive by default on MS-DOS. + +j. Fixes to the history file manipulation code for MS-DOS. + +k. Readline attempts to bind the arrow keys to appropriate defaults on MS-DOS. + +l. Some fixes were made to the redisplay code for better operation on MS-DOS. + +m. The quoted-insert code will now insert tty special chars like ^C. + +n. A bug was fixed that caused the display code to reference memory before + the start of the prompt string. + +o. More support for __EMX__ (OS/2). + +p. A bug was fixed in readline's signal handling that could cause infinite + recursion in signal handlers. + +q. A bug was fixed that caused the point to be less than zero when rl_forward + was given a very large numeric argument. + +r. The vi-mode code now gets characters via the application-settable value + of rl_getc_function rather than calling rl_getc directly. + +s. The history file code now uses O_BINARY mode when reading and writing + the history file on cygwin32. + +t. Fixed a bug in the redisplay code for lines with more than 256 line + breaks. + +u. A bug was fixed which caused invisible character markers to not be + stripped from the prompt string if the terminal was in no-echo mode. + +v. Readline no longer tries to get the variables it needs for redisplay + from the termcap entry if the calling application has specified its + own redisplay function. Readline treats the terminal as `dumb' in + this case. + +w. Fixes to the SIGWINCH code so that a multiple-line prompt with escape + sequences is redrawn correctly. + +x. Changes to the install and install-shared targets so that the libraries + and header files are installed separately. + +2. New Features in Readline + +a. A new Readline `user manual' is in doc/rluserman.texinfo. + +b. Parentheses matching is now always compiled into readline, and enabled + or disabled when the value of the `blink-matching-paren' variable is + changed. + +c. MS-DOS systems now use ~/_inputrc as the last-ditch inputrc filename. + +d. MS-DOS systems now use ~/_history as the default history file. + +e. history-search-{forward,backward} now leave the point at the end of the + line when the string to search for is empty, like + {reverse,forward}-search-history. + +f. history-search-{forward,backward} now leave the last history line found + in the readline buffer if the second or subsequent search fails. + +g. New function for use by applications: rl_on_new_line_with_prompt, used + when an application displays the prompt itself before calling readline(). + +h. New variable for use by applications: rl_already_prompted. An application + that displays the prompt itself before calling readline() must set this to + a non-zero value. + +i. A new variable, rl_gnu_readline_p, always 1. The intent is that an + application can verify whether or not it is linked with the `real' + readline library or some substitute. + +j. Per Bothner's `rlfe' (pronounced `Ralphie') readline front-end program + is included in the examples subdirectory, though it is not built + by default. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-4.0, +and the previous version, readline-2.2. + +1. Changes to Readline + +a. The version number is now 4.0, to match the major and minor version + numbers on the shared readline and history libraries. Future + releases will maintain the identical numbering. + +b. Fixed a typo in the `make install' recipe that copied libreadline.a + to libhistory.old right after installing it. + +c. The readline and history info files are now installed out of the source + directory if they are not found in the build directory. + +d. The library no longer exports a function named `savestring' -- backwards + compatibility be damned. + +e. There is no longer any #ifdef SHELL code in the source files. + +f. Some changes were made to the key binding code to fix memory leaks and + better support Win32 systems. + +g. Fixed a silly typo in the paren matching code -- it's microseconds, not + milliseconds. + +h. The readline library should be compilable by C++ compilers. + +i. The readline.h public header file now includes function prototypes for + all readline functions, and some changes were made to fix errors in the + source files uncovered by the use of prototypes. + +j. The maximum numeric argument is now clamped at 1000000. + +k. Fixes to rl_yank_last_arg to make it behave better. + +l. Fixed a bug in the display code that caused core dumps if the prompt + string length exceeded 1024 characters. + +m. The menu completion code was fixed to properly insert a single completion + if there is only one match. + +n. A bug was fixed that caused the display code to improperly display tabs + after newlines. + +o. A fix was made to the completion code in which a typo caused the wrong + value to be passed to the function that computed the longest common + prefix of the list of matches. + +p. The completion code now checks the value of rl_filename_completion_desired, + which is set by application-supplied completion functions to indicate + that filename completion is being performed, to decide whether or not to + call an application-supplied `ignore completions' function. + +q. Code was added to the history library to catch history substitutions + using `&' without a previous history substitution or search having been + performed. + + +2. New Features in Readline + +a. There is a new script, support/shobj-conf, to do system-specific shared + object and library configuration. It generates variables for configure + to substitute into makefiles. The README file provides a detailed + explanation of the shared library creation process. + +b. Shared libraries and objects are now built in the `shlib' subdirectory. + There is a shlib/Makefile.in to control the build process. `make shared' + from the top-level directory is still the right way to build shared + versions of the libraries. + +c. rlconf.h is now installed, so applications can find out which features + have been compiled into the installed readline and history libraries. + +d. rlstdc.h is now an installed header file. + +e. Many changes to the signal handling: + o Readline now catches SIGQUIT and cleans up the tty before returning; + o A new variable, rl_catch_signals, is available to application writers + to indicate to readline whether or not it should install its own + signal handlers for SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, + SIGTTIN, and SIGTTOU; + o A new variable, rl_catch_sigwinch, is available to application + writers to indicate to readline whether or not it should install its + own signal handler for SIGWINCH, which will chain to the calling + applications's SIGWINCH handler, if one is installed; + o There is a new function, rl_free_line_state, for application signal + handlers to call to free up the state associated with the current + line after receiving a signal; + o There is a new function, rl_cleanup_after_signal, to clean up the + display and terminal state after receiving a signal; + o There is a new function, rl_reset_after_signal, to reinitialize the + terminal and display state after an application signal handler + returns and readline continues + +f. There is a new function, rl_resize_terminal, to reset readline's idea of + the screen size after a SIGWINCH. + +g. New public functions: rl_save_prompt and rl_restore_prompt. These were + previously private functions with a `_' prefix. These functions are + used when an application wants to write a message to the `message area' + with rl_message and have the prompt restored correctly when the message + is erased. + +h. New function hook: rl_pre_input_hook, called just before readline starts + reading input, after initialization. + +i. New function hook: rl_display_matches_hook, called when readline would + display the list of completion matches. The new function + rl_display_match_list is what readline uses internally, and is available + for use by application functions called via this hook. + +j. New bindable function, delete-char-or-list, like tcsh. + +k. A new variable, rl_erase_empty_line, which, if set by an application using + readline, will cause readline to erase, prompt and all, lines on which the + only thing typed was a newline. + +l. There is a new script, support/shlib-install, to install and uninstall + the shared readline and history libraries. + +m. A new bindable variable, `isearch-terminators', which is a string + containing the set of characters that should terminate an incremental + search without being executed as a command. + +n. A new bindable function, forward-backward-delete-char. + +------------------------------------------------------------------------------- +This document details the changes between this version, readline-2.2, +and the previous version, readline-2.1. + +1. Changes to Readline + +a. Added a missing `extern' to a declaration in readline.h that kept + readline from compiling cleanly on some systems. + +b. The history file is now opened with mode 0600 when it is written for + better security. + +c. Changes were made to the SIGWINCH handling code so that prompt redisplay + is done better. + +d. ^G now interrupts incremental searches correctly. + +e. A bug that caused a core dump when the set of characters to be quoted + when completing words was empty was fixed. + +f. Fixed a problem in the readline test program rltest.c that caused a core + dump. + +g. The code that handles parser directives in inputrc files now displays + more error messages. + +h. The history expansion code was fixed so that the appearance of the + history comment character at the beginning of a word inhibits history + expansion for that word and the rest of the input line. + +i. The code that prints completion listings now behaves better if one or + more of the filenames contains non-printable characters. + +j. The time delay when showing matching parentheses is now 0.5 seconds. + + +2. New Features in Readline + +a. There is now an option for `iterative' yank-last-arg handline, so a user + can keep entering `M-.', yanking the last argument of successive history + lines. + +b. New variable, `print-completions-horizontally', which causes completion + matches to be displayed across the screen (like `ls -x') rather than up + and down the screen (like `ls'). + +c. New variable, `completion-ignore-case', which causes filename completion + and matching to be performed case-insensitively. + +d. There is a new bindable command, `magic-space', which causes history + expansion to be performed on the current readline buffer and a space to + be inserted into the result. + +e. There is a new bindable command, `menu-complete', which enables tcsh-like + menu completion (successive executions of menu-complete insert a single + completion match, cycling through the list of possible completions). + +f. There is a new bindable command, `paste-from-clipboard', for use on Win32 + systems, to insert the text from the Win32 clipboard into the editing + buffer. + +g. The key sequence translation code now understands printf-style backslash + escape sequences, including \NNN octal escapes. These escape sequences + may be used in key sequence definitions or macro values. + +h. An `$include' inputrc file parser directive has been added. diff --git a/miniconda3/envs/ladir/share/doc/readline/INSTALL b/miniconda3/envs/ladir/share/doc/readline/INSTALL new file mode 100644 index 0000000000000000000000000000000000000000..52ba8eb360eb52464c612076fa4d4c9404697194 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/readline/INSTALL @@ -0,0 +1,335 @@ +Basic Installation +================== + +These are installation instructions for Readline. + +The simplest way to compile readline is: + + 1. `cd' to the directory containing the readline source code and type + `./configure' to configure readline for your system. If you're + using `csh' on an old version of System V, you might need to type + `sh ./configure' instead to prevent `csh' from trying to execute + `configure' itself. + + Running `configure' takes some time. While running, it prints some + messages telling which features it is checking for. + + If you want to build readline in a directory other than the source + directory, just run `configure' using a full pathname, for instance: + + bash /usr/local/src/readline/readline-8.3/configure + + 2. Type `make' to compile readline and build the static readline + and history libraries. If supported, this will build the shared + readline and history libraries also. See below for instructions on + compiling the other parts of the distribution. Typing `make everything' + will build the static and shared libraries (if supported) and the + example programs. + + 3. Type `make install' to install the static readline and history + libraries, the readline include files, the documentation, and, if + supported, the shared readline and history libraries. + + 4. You can remove the created libraries and object files from the + build directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile readline for + a different kind of computer), type `make distclean'. There is + also a `make maintainer-clean' target, but that is intended mainly + for the readline developers, and should be used with care. + +The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It +uses those values to create a `Makefile' in the build directory, +and Makefiles in the `doc', `shlib', and `examples' +subdirectories. It also creates a `config.h' file containing +system-dependent definitions. Finally, it creates a shell script +`config.status' that you can run in the future to recreate the +current configuration, a file `config.cache' that saves the +results of its tests to speed up reconfiguring, and a file +`config.log' containing compiler output (useful mainly for +debugging `configure'). + +To find out more about the options and arguments that the `configure' +script understands, type + + bash-4.2$ ./configure --help + +at a shell prompt in your readline source directory. + +If you want to build readline in a directory separate from the source +directory - to build for multiple architectures, for example - just use +the full path to the configure script. The following commands will +build readline in a directory under `/usr/local/build' from the source code +in `/usr/local/src/readline/readline-8.3': + + mkdir /usr/local/build/readline-8.3 + cd /usr/local/build/readline-8.3 + bash /usr/local/src/readline/readline-8.3/configure + make + +See `Compiling For Multiple Architectures' below for more information +about building in a directory separate from the source. + +If you need to do unusual things to compile readline, please try +to figure out how `configure' could check whether to do them, and +mail diffs or instructions to so they can +be considered for the next release. If at some point +`config.cache' contains results you don't want to keep, you may +remove or edit it. + +The file `configure.in' is used to create `configure' by a +program called `autoconf'. You only need `configure.in' if you +want to change it or regenerate `configure' using a newer version +of `autoconf'. The readline `configure.in' requires autoconf +version 2.69 or newer. + +Compilers and Options +===================== + +Some systems require unusual options for compilation or linking that +the `configure' script does not know about. You can give `configure' +initial values for variables by setting them in the environment. Using +a Bourne-compatible shell, you can do that on the command line like +this: + + CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure + +Or on systems that have the `env' program, you can do it like this: + + env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure + +Compiling For Multiple Architectures +==================================== + +You can compile readline for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you must use a version of `make' that +supports the `VPATH' variable, such as GNU `make'. `cd' to the +directory where you want the object files and executables to go and run +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. + +If you have to use a `make' that does not supports the `VPATH' +variable, you have to compile readline for one architecture at a +time in the source code directory. After you have installed +readline for one architecture, use `make distclean' before +reconfiguring for another architecture. + +Installation Names +================== + +By default, `make install' will install the readline libraries in +`/usr/local/lib', the include files in `/usr/local/include/readline', +the man pages in `/usr/local/man', and the info files in `/usr/local/info'. +You can specify an installation prefix other than `/usr/local' by +giving `configure' the option `--prefix=PATH' or by supplying a value for +the DESTDIR variable when running `make install'. + +You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. +If you give `configure' the option `--exec-prefix=PATH', the +readline Makefiles will use PATH as the prefix for installing the +libraries. Documentation and other data files will still use the +regular prefix. + +Specifying the System Type +========================== + +There may be some features `configure' can not figure out +automatically, but need to determine by the type of host readline +will run on. Usually `configure' can figure that out, but if it +prints a message saying it can not guess the host type, give it +the `--host=TYPE' option. TYPE can either be a short name for +the system type, such as `sun4', or a canonical name with three +fields: CPU-COMPANY-SYSTEM (e.g., i386-unknown-freebsd4.2). + +See the file `config.sub' for the possible values of each field. + +Sharing Defaults +================ + +If you want to set default values for `configure' scripts to share, +you can create a site shell script called `config.site' that gives +default values for variables like `CC', `cache_file', and `prefix'. +`configure' looks for `PREFIX/share/config.site' if it exists, then +`PREFIX/etc/config.site' if it exists. Or, you can set the +`CONFIG_SITE' environment variable to the location of the site script. +A warning: the readline `configure' looks for a site script, but not +all `configure' scripts do. + +Operation Controls +================== + +`configure' recognizes the following options to control how it +operates. + +`--cache-file=FILE' + Use and save the results of the tests in FILE instead of + `./config.cache'. Set FILE to `/dev/null' to disable caching, for + debugging `configure'. + +`--help' + Print a summary of the options to `configure', and exit. + +`--quiet' +`--silent' +`-q' + Do not print messages saying which checks are being made. + +`--srcdir=DIR' + Look for the package's source code in directory DIR. Usually + `configure' can determine that directory automatically. + +`--version' + Print the version of Autoconf used to generate the `configure' + script, and exit. + +`configure' also accepts some other, not widely useful, options. + +Optional Features +================= + +The readline `configure' recognizes two `--with-PACKAGE' options: + +`--with-curses' + This tells readline that it can find the termcap library functions + (tgetent, et al.) in the curses library, rather than a separate + termcap library. Readline uses the termcap functions, but does not + usually link with the termcap or curses library itself, allowing + applications which link with readline the to choose an appropriate + library. This option tells readline to link the example programs with + the curses library rather than libtermcap. + +`--with-shared-termcap-library' + This tells the readline build process to link the shared version of + libreadline against a shared version of the curses or termcap library + (see the description of SHLIB_LIBS below under `Shared Libraries'). + This relieves the application of having to link with curses or termcap + itself, but does not allow the application to choose which library to + use. This is only effective on systems that build shared libraries (see + below; the default for shared libraries is `yes'). + +`configure' also recognizes several `--enable-FEATURE' options: + +`--enable-bracketed-paste-default' + Enable bracketed paste by default, so the initial value of the + `enable-bracketed-paste' Readline variable is `on'. The default + is `yes'. + +`--enable-install-examples' + Install the readline example programs as part of `make install'. + +`--enable-multibyte' + Build with support for multibyte characters enabled on systems with the + necessary framework (locale definitions, C library functions, etc.). The + default is `yes'. + +`--enable-shared' + Build the shared libraries by default on supported platforms. The + default is `yes'. + +`--enable-static' + Build the static libraries by default. The default is `yes'. + +Shared Libraries +================ + +There is support for building shared versions of the readline and +history libraries. The configure script creates a Makefile in +the `shlib' subdirectory, and typing `make shared' will cause +shared versions of the readline and history libraries to be built +on supported platforms. + +If `configure' is given the `--enable-shared' option, it will attempt +to build the shared libraries by default on supported platforms. This +option is enabled by default. + +Configure calls the script support/shobj-conf to test whether or +not shared library creation is supported and to generate the values +of variables that are substituted into shlib/Makefile. If you +try to build shared libraries on an unsupported platform, `make' +will display a message asking you to update support/shobj-conf for +your platform. + +If you need to update support/shobj-conf, you will need to create +a `stanza' for your operating system and compiler. The script uses +the value of host_os and ${CC} as determined by configure. For +instance, FreeBSD 4.2 with any version of gcc is identified as +`freebsd4.2-gcc*'. + +In the stanza for your operating system-compiler pair, you will need to +define several variables. They are: + +SHOBJ_CC The C compiler used to compile source files into shareable + object files. This is normally set to the value of ${CC} + by configure, and should not need to be changed. + +SHOBJ_CFLAGS Flags to pass to the C compiler ($SHOBJ_CC) to create + position-independent code. If you are using gcc, this + should probably be set to `-fpic'. + +SHOBJ_LD The link editor to be used to create the shared library from + the object files created by $SHOBJ_CC. If you are using + gcc, a value of `gcc' will probably work. + +SHOBJ_LDFLAGS Flags to pass to SHOBJ_LD to enable shared object creation. + If you are using gcc, `-shared' may be all that is necessary. + These should be the flags needed for generic shared object + creation. + +SHLIB_XLDFLAGS Additional flags to pass to SHOBJ_LD for shared library + creation. Many systems use the -R option to the link + editor to embed a path within the library for run-time + library searches. A reasonable value for such systems would + be `-R$(libdir)'. + +SHLIB_LIBS Any additional libraries that shared libraries should be + linked against when they are created. + +SHLIB_LIBPREF The prefix to use when generating the filename of the shared + library. The default is `lib'; Cygwin uses `cyg'. + +SHLIB_LIBSUFF The suffix to add to `libreadline' and `libhistory' when + generating the filename of the shared library. Many systems + use `so'; HP-UX uses `sl'. + +SHLIB_LIBVERSION The string to append to the filename to indicate the version + of the shared library. It should begin with $(SHLIB_LIBSUFF), + and possibly include version information that allows the + run-time loader to load the version of the shared library + appropriate for a particular program. Systems using shared + libraries similar to SunOS 4.x use major and minor library + version numbers; for those systems a value of + `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)$(SHLIB_MINOR)' is appropriate. + Systems based on System V Release 4 don't use minor version + numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems. + Other Unix versions use different schemes. + +SHLIB_DLLVERSION The version number for shared libraries that determines API + compatibility between readline versions and the underlying + system. Used only on Cygwin. Defaults to $SHLIB_MAJOR, but + can be overridden at configuration time by defining DLLVERSION + in the environment. + +SHLIB_DOT The character used to separate the name of the shared library + from the suffix and version information. The default is `.'; + systems like Cygwin which don't separate version information + from the library name should set this to the empty string. + +SHLIB_STATUS Set this to `supported' when you have defined the other + necessary variables. Make uses this to determine whether + or not shared library creation should be attempted. If + shared libraries are not supported, this will be set to + `unsupported'. + +You should look at the existing stanzas in support/shobj-conf for ideas. + +Once you have updated support/shobj-conf, re-run configure and type +`make shared' or `make'. The shared libraries will be created in the +shlib subdirectory. + +If shared libraries are created, `make install' will install them. +You may install only the shared libraries by running `make +install-shared' from the top-level build directory. Running `make +install' in the shlib subdirectory will also work. If you don't want +to install any created shared libraries, run `make install-static'. diff --git a/miniconda3/envs/ladir/share/doc/readline/README b/miniconda3/envs/ladir/share/doc/readline/README new file mode 100644 index 0000000000000000000000000000000000000000..75eaa2ff8e57b78ff9d4ac6a7a7c76e956dd7935 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/readline/README @@ -0,0 +1,197 @@ +Introduction +============ + +This is the Gnu Readline library, version 8.3. + +The Readline library provides a set of functions for use by applications +that allow users to edit command lines as they are typed in. Both +Emacs and vi editing modes are available. The Readline library includes +additional functions to maintain a list of previously-entered command +lines, to recall and perhaps reedit those lines, and perform csh-like +history expansion on previous commands. + +The history facilities are also placed into a separate library, the +History library, as part of the build process. The History library +may be used without Readline in applications which desire its +capabilities. + +The Readline library is free software, distributed under the terms of +the [GNU] General Public License as published by the Free Software +Foundation, version 3 of the License. For more information, see the +file COPYING. + +To build the library, try typing `./configure', then `make'. The +configuration process is automated, so no further intervention should +be necessary. Readline builds with `gcc' by default if it is +available. If you want to use `cc' instead, type + + CC=cc ./configure + +if you are using a Bourne-style shell. If you are not, the following +may work: + + env CC=cc ./configure + +Read the file INSTALL in this directory for more information about how +to customize and control the build process, including how to build readline +in a directory other than the source directory. + +The file rlconf.h contains C preprocessor defines that enable and disable +certain Readline features. + +The special make target `everything' will build the static and shared +libraries (if the target platform supports them) and the examples. + +Examples +======== + +There are several example programs that use Readline features in the +examples directory. The `rl' program is of particular interest. It +is a command-line interface to Readline, suitable for use in shell +scripts in place of `read' (but look at bash's `read -e' first). + +Shared Libraries +================ + +There is skeletal support for building shared versions of the +Readline and History libraries. The configure script creates +a Makefile in the `shlib' subdirectory, and typing `make shared' +will cause shared versions of the Readline and History libraries +to be built on supported platforms. + +If `configure' is given the `--enable-shared' option, it will attempt +to build the shared libraries by default on supported platforms. + +Configure calls the script support/shobj-conf to test whether or +not shared library creation is supported and to generate the values +of variables that are substituted into shlib/Makefile. If you +try to build shared libraries on an unsupported platform, `make' +will display a message asking you to update support/shobj-conf for +your platform. + +If you need to update support/shobj-conf, you will need to create +a `stanza' for your operating system and compiler. The script uses +the value of host_os and ${CC} as determined by configure. For +instance, FreeBSD 4.2 with any version of gcc is identified as +`freebsd4.2-gcc*'. + +In the stanza for your operating system-compiler pair, you will need to +define several variables. They are: + +SHOBJ_CC The C compiler used to compile source files into shareable + object files. This is normally set to the value of ${CC} + by configure, and should not need to be changed. + +SHOBJ_CFLAGS Flags to pass to the C compiler ($SHOBJ_CC) to create + position-independent code. If you are using gcc, this + should probably be set to `-fpic'. + +SHOBJ_LD The link editor to be used to create the shared library from + the object files created by $SHOBJ_CC. If you are using + gcc, a value of `gcc' will probably work. + +SHOBJ_LDFLAGS Flags to pass to SHOBJ_LD to enable shared object creation. + If you are using gcc, `-shared' may be all that is necessary. + These should be the flags needed for generic shared object + creation. + +SHLIB_XLDFLAGS Additional flags to pass to SHOBJ_LD for shared library + creation. Many systems use the -R option to the link + editor to embed a path within the library for run-time + library searches. A reasonable value for such systems would + be `-R$(libdir)'. + +SHLIB_LIBS Any additional libraries that shared libraries should be + linked against when they are created. + +SHLIB_LIBPREF The prefix to use when generating the filename of the shared + library. The default is `lib'; Cygwin uses `cyg'. + +SHLIB_LIBSUFF The suffix to add to `libreadline' and `libhistory' when + generating the filename of the shared library. Many systems + use `so'; HP-UX uses `sl'. + +SHLIB_LIBVERSION The string to append to the filename to indicate the version + of the shared library. It should begin with $(SHLIB_LIBSUFF), + and possibly include version information that allows the + run-time loader to load the version of the shared library + appropriate for a particular program. Systems using shared + libraries similar to SunOS 4.x use major and minor library + version numbers; for those systems a value of + `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)$(SHLIB_MINOR)' is appropriate. + Systems based on System V Release 4 don't use minor version + numbers; use `$(SHLIB_LIBSUFF).$(SHLIB_MAJOR)' on those systems. + Other Unix versions use different schemes. + +SHLIB_DLLVERSION The version number for shared libraries that determines API + compatibility between readline versions and the underlying + system. Used only on Cygwin. Defaults to $SHLIB_MAJOR, but + can be overridden at configuration time by defining DLLVERSION + in the environment. + +SHLIB_DOT The character used to separate the name of the shared library + from the suffix and version information. The default is `.'; + systems like Cygwin which don't separate version information + from the library name should set this to the empty string. + +SHLIB_STATUS Set this to `supported' when you have defined the other + necessary variables. Make uses this to determine whether + or not shared library creation should be attempted. + +You should look at the existing stanzas in support/shobj-conf for ideas. + +Once you have updated support/shobj-conf, re-run configure and type +`make shared'. The shared libraries will be created in the shlib +subdirectory. + +If shared libraries are created, `make install' will install them. +You may install only the shared libraries by running `make +install-shared' from the top-level build directory. Running `make +install' in the shlib subdirectory will also work. If you don't want +to install any created shared libraries, run `make install-static'. + +Documentation +============= + +The documentation for the Readline and History libraries appears in +the `doc' subdirectory. There are three texinfo files and a +Unix-style manual page describing the facilities available in the +Readline library. The texinfo files include both user and +programmer's manuals. HTML versions of the manuals appear in the +`doc' subdirectory as well. + +Usage +===== + +Our position on the use of Readline through a shared-library linking +mechanism is that there is no legal difference between shared-library +linking and static linking--either kind of linking combines various +modules into a single larger work. The conditions for using Readline +in a larger work are stated in section 3 of the GNU GPL. + +Reporting Bugs +============== + +Bug reports for Readline should be sent to: + + bug-readline@gnu.org + +When reporting a bug, please include the following information: + + * the version number and release status of Readline (e.g., 4.2-release) + * the machine and OS that it is running on + * a list of the compilation flags or the contents of `config.h', if + appropriate + * a description of the bug + * a recipe for recreating the bug reliably + * a fix for the bug if you have one! + +If you would like to contact the Readline maintainer directly, send mail +to bash-maintainers@gnu.org. + +Since Readline is developed along with bash, the bug-bash@gnu.org mailing +list (mirrored to the Usenet newsgroup gnu.bash.bug) often contains +Readline bug reports and fixes. + +Chet Ramey +chet.ramey@case.edu diff --git a/miniconda3/envs/ladir/share/doc/readline/history.html b/miniconda3/envs/ladir/share/doc/readline/history.html new file mode 100644 index 0000000000000000000000000000000000000000..62803d81e89c7cbae8036be1c1ac466617d9ca19 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/readline/history.html @@ -0,0 +1,1835 @@ + + + + + + +GNU History Library + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/readline/readline.html b/miniconda3/envs/ladir/share/doc/readline/readline.html new file mode 100644 index 0000000000000000000000000000000000000000..897bc7c22091a3d3a2e80ffabf3f1341c67c9fa4 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/readline/readline.html @@ -0,0 +1,6706 @@ + + + + + + +GNU Readline Library + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

+Next:   [Contents][Index]

+
+

GNU Readline Library

+ +

This document describes the GNU Readline Library, a utility which aids +in the consistency of user interface across discrete programs which +provide a command line interface. +The Readline home page is http://www.gnu.org/software/readline/. +

+ + + + + +
+

Table of Contents

+ +
+ + +
+
+
+
+
+

+Next: , Previous: , Up: GNU Readline Library   [Contents][Index]

+
+

1 Command Line Editing

+ +

This chapter describes the basic features of the GNU +command line editing interface. +

+ + +
+
+
+

+Next: , Up: Command Line Editing   [Contents][Index]

+
+

1.1 Introduction to Line Editing

+ +

The following paragraphs use Emacs style to +describe the notation used to represent keystrokes. +

+

The text C-k is read as ‘Control-K’ and describes the character +produced when the k key is pressed while the Control key +is depressed. +

+

The text M-k is read as ‘Meta-K’ and describes the character +produced when the Meta key (if you have one) is depressed, and the k +key is pressed (a meta character), then both are released. +The Meta key is labeled ALT or Option on many keyboards. +On keyboards with two keys labeled ALT (usually to either side of +the space bar), the ALT on the left side is generally set to +work as a Meta key. +One of the ALT keys may also be configured +as some other modifier, such as a +Compose key for typing accented characters. +

+

On some keyboards, the Meta key modifier produces characters with +the eighth bit (0200) set. +You can use the enable-meta-key variable +to control whether or not it does this, if the keyboard allows it. +On many others, the terminal or terminal emulator converts the metafied +key to a key sequence beginning with ESC as described in the +next paragraph. +

+

If you do not have a Meta or ALT key, or another key working as +a Meta key, you can generally achieve the latter effect by typing ESC +first, and then typing k. +The ESC character is known as the meta prefix). +

+

Either process is known as metafying the k key. +

+

If your Meta key produces a key sequence with the ESC meta prefix, +you can make M-key key bindings you specify +(see Key Bindings in Readline Init File Syntax) +do the same thing by setting the force-meta-prefix variable. +

+

The text M-C-k is read as ‘Meta-Control-k’ and describes the +character produced by metafying C-k. +

+

In addition, several keys have their own names. +Specifically, +DEL, ESC, LFD, SPC, RET, and TAB all +stand for themselves when seen in this text, or in an init file +(see Readline Init File). +If your keyboard lacks a LFD key, typing C-j will +output the appropriate character. +The RET key may be labeled Return or Enter on +some keyboards. +

+
+
+
+
+

+Next: , Previous: , Up: Command Line Editing   [Contents][Index]

+
+

1.2 Readline Interaction

+ + +

Often during an interactive session you type in a long line of text, +only to notice that the first word on the line is misspelled. +The Readline library gives you a set of commands for manipulating the text +as you type it in, allowing you to just fix your typo, and not forcing +you to retype the majority of the line. +Using these editing commands, +you move the cursor to the place that needs correction, and delete or +insert the text of the corrections. +Then, when you are satisfied with the line, you simply press RET. +You do not have to be at the +end of the line to press RET; the entire line is accepted +regardless of the location of the cursor within the line. +

+ + +
+
+
+

+Next: , Up: Readline Interaction   [Contents][Index]

+
+

1.2.1 Readline Bare Essentials

+ + + + +

In order to enter characters into the line, simply type them. +The typed +character appears where the cursor was, and then the cursor moves one +space to the right. +If you mistype a character, you can use your +erase character to back up and delete the mistyped character. +

+

Sometimes you may mistype a character, and +not notice the error until you have typed several other characters. +In that case, you can type C-b to move the cursor to the left, +and then correct your mistake. +Afterwards, you can move the cursor to the right with C-f. +

+

When you add text in the middle of a line, you will notice that characters +to the right of the cursor are ‘pushed over’ to make room for the text +that you have inserted. +Likewise, when you delete text behind the cursor, +characters to the right of the cursor are ‘pulled back’ to fill in the +blank space created by the removal of the text. +These are the bare +essentials for editing the text of an input line: +

+
+
C-b
+

Move back one character. +

+
C-f
+

Move forward one character. +

+
DEL or Backspace
+

Delete the character to the left of the cursor. +

+
C-d
+

Delete the character underneath the cursor. +

+
Printing characters
+

Insert the character into the line at the cursor. +

+
C-_ or C-x C-u
+

Undo the last editing command. +You can undo all the way back to an empty line. +

+
+ +

Depending on your configuration, the Backspace key might be set to +delete the character to the left of the cursor and the DEL key set +to delete the character underneath the cursor, like C-d, rather +than the character to the left of the cursor. +

+
+
+
+
+

+Next: , Previous: , Up: Readline Interaction   [Contents][Index]

+
+

1.2.2 Readline Movement Commands

+ +

The above table describes the most basic keystrokes that you need +in order to do editing of the input line. +For your convenience, many other commands are available in +addition to C-b, C-f, C-d, and DEL. +Here are some commands for moving more rapidly within the line. +

+
+
C-a
+

Move to the start of the line. +

+
C-e
+

Move to the end of the line. +

+
M-f
+

Move forward a word, where a word is composed of letters and digits. +

+
M-b
+

Move backward a word. +

+
C-l
+

Clear the screen, reprinting the current line at the top. +

+
+ +

Notice how C-f moves forward a character, while M-f moves +forward a word. +It is a loose convention that control keystrokes +operate on characters while meta keystrokes operate on words. +

+
+
+
+
+

+Next: , Previous: , Up: Readline Interaction   [Contents][Index]

+
+

1.2.3 Readline Killing Commands

+ + + + +

Killing text means to delete the text from the line, but to save +it away for later use, usually by yanking (re-inserting) +it back into the line. +(‘Cut’ and ‘paste’ are more recent jargon for ‘kill’ and ‘yank’.) +

+

If the description for a command says that it ‘kills’ text, then you can +be sure that you can get the text back in a different (or the same) +place later. +

+

When you use a kill command, the text is saved in a kill-ring. +Any number of consecutive kills save all of the killed text together, so +that when you yank it back, you get it all. +The kill ring is not line specific; the text that you killed on a previously +typed line is available to be yanked back later, when you are typing +another line. + +

+

Here is the list of commands for killing text. +

+
+
C-k
+

Kill the text from the current cursor position to the end of the line. +

+
+
M-d
+

Kill from the cursor to the end of the current word, or, if between +words, to the end of the next word. +Word boundaries are the same as those used by M-f. +

+
+
M-DEL
+

Kill from the cursor to the start of the current word, or, if between +words, to the start of the previous word. +Word boundaries are the same as those used by M-b. +

+
+
C-w
+

Kill from the cursor to the previous whitespace. +This is different than +M-DEL because the word boundaries differ. +

+
+
+ +

Here is how to yank the text back into the line. Yanking +means to copy the most-recently-killed text from the kill buffer +into the line at the current cursor position. +

+
+
C-y
+

Yank the most recently killed text back into the buffer at the cursor. +

+
+
M-y
+

Rotate the kill-ring, and yank the new top. +You can only do this if the prior command is C-y or M-y. +

+
+ +
+
+
+
+

+Next: , Previous: , Up: Readline Interaction   [Contents][Index]

+
+

1.2.4 Readline Arguments

+ +

You can pass numeric arguments to Readline commands. +Sometimes the +argument acts as a repeat count, other times it is the sign of the +argument that is significant. +If you pass a negative argument to a +command which normally acts in a forward direction, that command will +act in a backward direction. +For example, to kill text back to the +start of the line, you might type ‘M-- C-k’. +

+

The general way to pass numeric arguments to a command is to type meta +digits before the command. +If the first ‘digit’ typed is a minus +sign (‘-’), then the sign of the argument will be negative. +Once you have typed one meta digit to get the argument started, you can +type the remainder of the digits, and then the command. +For example, to give +the C-d command an argument of 10, you could type ‘M-1 0 C-d’, +which will delete the next ten characters on the input line. +

+
+
+
+
+

+Previous: , Up: Readline Interaction   [Contents][Index]

+
+

1.2.5 Searching for Commands in the History

+ +

Readline provides commands for searching through the command history +for lines containing a specified string. +There are two search modes: incremental and non-incremental. +

+

Incremental searches begin before the user has finished typing the +search string. +As each character of the search string is typed, Readline displays +the next entry from the history matching the string typed so far. +An incremental search requires only as many characters as needed to +find the desired history entry. +When using emacs editing mode, type C-r +to search backward in the history for a particular string. +Typing C-s searches forward through the history. +The characters present in the value of the isearch-terminators variable +are used to terminate an incremental search. +If that variable has not been assigned a value, the ESC and +C-j characters terminate an incremental search. +C-g aborts an incremental search and restores the original line. +When the search is terminated, the history entry containing the +search string becomes the current line. +

+

To find other matching entries in the history list, type C-r or +C-s as appropriate. +This searches backward or forward in the history for the next +entry matching the search string typed so far. +Any other key sequence bound to a Readline command terminates +the search and executes that command. +For instance, a RET terminates the search and accepts +the line, thereby executing the command from the history list. +A movement command will terminate the search, make the last line found +the current line, and begin editing. +

+

Readline remembers the last incremental search string. +If two C-rs are typed without any intervening characters defining +a new search string, Readline uses any remembered search string. +

+

Non-incremental searches read the entire search string before starting +to search for matching history entries. +The search string may be typed by the user or be part of the contents of +the current line. +

+
+
+
+
+
+

+Next: , Previous: , Up: Command Line Editing   [Contents][Index]

+
+

1.3 Readline Init File

+ + +

Although the Readline library comes with a set of Emacs-like +keybindings installed by default, it is possible to use a different set +of keybindings. +Any user can customize programs that use Readline by putting +commands in an inputrc file, conventionally in their home directory. +The name of this file is taken from the value of the +environment variable INPUTRC. +If that variable is unset, the default is ~/.inputrc. +If that file does not exist or cannot be read, Readline looks for +/etc/inputrc. +

+

When a program that uses the Readline library starts up, Readline reads +the init file and sets any variables and key bindings it contains. +

+

In addition, the C-x C-r command re-reads this init file, thus +incorporating any changes that you might have made to it. +

+ + +
+
+
+

+Next: , Up: Readline Init File   [Contents][Index]

+
+

1.3.1 Readline Init File Syntax

+ +

There are only a few basic constructs allowed in the +Readline init file. +Blank lines are ignored. +Lines beginning with a ‘#’ are comments. +Lines beginning with a ‘$’ indicate conditional +constructs (see Conditional Init Constructs). +Other lines denote variable settings and key bindings. +

+
+
Variable Settings
+

You can modify the run-time behavior of Readline by +altering the values of variables in Readline +using the set command within the init file. +The syntax is simple: +

+
+
set variable value
+
+ +

Here, for example, is how to +change from the default Emacs-like key binding to use +vi line editing commands: +

+
+
set editing-mode vi
+
+ +

Variable names and values, where appropriate, are recognized without +regard to case. +Unrecognized variable names are ignored. +

+

Boolean variables (those that can be set to on or off) are set to on if +the value is null or empty, on (case-insensitive), or 1. +Any other value results in the variable being set to off. +

+ +

A great deal of run-time behavior is changeable with the following +variables. +

+ +
+
active-region-start-color
+

A string variable that controls the text color and background when displaying +the text in the active region (see the description of +enable-active-region below). +This string must not take up any physical character positions on the display, +so it should consist only of terminal escape sequences. +It is output to the terminal before displaying the text in the active region. +This variable is reset to the default value whenever the terminal type changes. +The default value is the string that puts the terminal in standout mode, +as obtained from the terminal’s terminfo description. +A sample value might be ‘\e[01;33m’. +

+
+
active-region-end-color
+

A string variable that “undoes” +the effects of active-region-start-color +and restores “normal” +terminal display appearance after displaying text in the active region. +This string must not take up any physical character positions on the display, +so it should consist only of terminal escape sequences. +It is output to the terminal after displaying the text in the active region. +This variable is reset to the default value whenever the terminal type changes. +The default value is the string that restores the terminal from standout mode, +as obtained from the terminal’s terminfo description. +A sample value might be ‘\e[0m’. +

+
+
bell-style
+

Controls what happens when Readline wants to ring the terminal bell. +If set to ‘none’, Readline never rings the bell. +If set to ‘visible’, Readline uses a visible bell if one is available. +If set to ‘audible’ (the default), Readline attempts to ring +the terminal’s bell. +

+
+
bind-tty-special-chars
+

If set to ‘on’ (the default), Readline attempts to bind the control +characters that are +treated specially by the kernel’s terminal driver to their +Readline equivalents. +These override the default Readline bindings described here. +Type ‘stty -a’ at a Bash prompt to see your current terminal settings, +including the special control characters (usually cchars). +

+
+
blink-matching-paren
+

If set to ‘on’, Readline attempts to briefly move the cursor to an +opening parenthesis when a closing parenthesis is inserted. +The default is ‘off’. +

+
+
colored-completion-prefix
+

If set to ‘on’, when listing completions, Readline displays the +common prefix of the set of possible completions using a different color. +The color definitions are taken from the value of the LS_COLORS +environment variable. +If there is a color definition in LS_COLORS for the custom suffix +‘readline-colored-completion-prefix’, Readline uses this color for +the common prefix instead of its default. +The default is ‘off’. +

+
+
colored-stats
+

If set to ‘on’, Readline displays possible completions using different +colors to indicate their file type. +The color definitions are taken from the value of the LS_COLORS +environment variable. +The default is ‘off’. +

+
+
comment-begin
+

The string to insert at the beginning of the line by the +insert-comment command. +The default value is "#". +

+
+
completion-display-width
+

The number of screen columns used to display possible matches +when performing completion. +The value is ignored if it is less than 0 or greater than the terminal +screen width. +A value of 0 causes matches to be displayed one per line. +The default value is -1. +

+
+
completion-ignore-case
+

If set to ‘on’, Readline performs filename matching and completion +in a case-insensitive fashion. +The default value is ‘off’. +

+
+
completion-map-case
+

If set to ‘on’, and completion-ignore-case is enabled, Readline +treats hyphens (‘-’) and underscores (‘_’) as equivalent when +performing case-insensitive filename matching and completion. +The default value is ‘off’. +

+
+
completion-prefix-display-length
+

The maximum +length in characters of the common prefix of a list of possible +completions that is displayed without modification. +When set to a value greater than zero, Readline +replaces common prefixes longer than this value +with an ellipsis when displaying possible completions. +If a completion begins with a period, +and Readline is completing filenames, +it uses three underscores instead of an ellipsis. +

+
+
completion-query-items
+

The number of possible completions that determines when the user is asked +whether the list of possibilities should be displayed. +If the number of possible completions is greater than +or equal to this value, +Readline asks whether or not the user wishes to view them; +otherwise, Readline simply lists the completions. +This variable must be set to an integer value greater than or equal to zero. +A zero value means Readline should never ask; negative +values are treated as zero. +The default limit is 100. +

+
+
convert-meta
+

If set to ‘on’, Readline converts characters it reads +that have the eighth bit set to an ASCII key sequence by +clearing the eighth bit and prefixing an ESC character, +converting them to a meta-prefixed key sequence. +The default value is ‘on’, but Readline sets it to ‘off’ +if the locale contains +characters whose encodings may include bytes with the eighth bit set. +This variable is dependent on the LC_CTYPE locale category, and +may change if the locale changes. +This variable also affects key bindings; +see the description of force-meta-prefix below. +

+
+
disable-completion
+

If set to ‘On’, Readline inhibits word completion. +Completion characters are inserted into the line as if they +had been mapped to self-insert. +The default is ‘off’. +

+
+
echo-control-characters
+

When set to ‘on’, on operating systems that indicate they support it, +Readline echoes a character corresponding to a signal generated from the +keyboard. +The default is ‘on’. +

+
+
editing-mode
+

The editing-mode variable controls the default set of +key bindings. +By default, Readline starts up in emacs editing mode, where +the keystrokes are most similar to Emacs. +This variable can be set to either ‘emacs’ or ‘vi’. +

+
+
emacs-mode-string
+

If the show-mode-in-prompt variable is enabled, +this string is displayed immediately before the last line of the primary +prompt when emacs editing mode is active. +The value is expanded like a +key binding, so the standard set of meta- and control- prefixes and +backslash escape sequences is available. +The ‘\1’ and ‘\2’ escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +The default is ‘@’. +

+
+
enable-active-region
+

point is the current cursor position, and mark refers to a +saved cursor position (see Commands For Moving). +The text between the point and mark is referred to as the region. +When this variable is set to ‘On’, Readline allows certain commands +to designate the region as active. +When the region is active, Readline highlights the text in the region using +the value of the active-region-start-color, which defaults to the +string that enables the terminal’s standout mode. +The active region shows the text inserted by bracketed-paste and any +matching text found by incremental and non-incremental history searches. +The default is ‘On’. +

+
+
enable-bracketed-paste
+

When set to ‘On’, Readline configures the terminal to insert each +paste into the editing buffer as a single string of characters, instead +of treating each character as if it had been read from the keyboard. +This is called putting the terminal into bracketed paste mode; +it prevents Readline from executing any editing commands bound +to key sequences appearing in the pasted text. +The default is ‘On’. +

+
+
enable-keypad
+

When set to ‘on’, Readline tries to enable the application +keypad when it is called. +Some systems need this to enable the arrow keys. +The default is ‘off’. +

+
+
enable-meta-key
+

When set to ‘on’, Readline tries to enable any meta +modifier key the terminal claims to support when it is called. +On many terminals, the Meta key is used to send eight-bit characters; +this variable checks for the terminal capability that indicates the +terminal can enable and disable a mode that sets the eighth bit of a +character (0200) if the Meta key is held down when the character is +typed (a meta character). +The default is ‘on’. +

+
+
expand-tilde
+

If set to ‘on’, Readline attempts tilde expansion when it +attempts word completion. +The default is ‘off’. +

+
+
force-meta-prefix
+

If set to ‘on’, Readline modifies its behavior when binding key +sequences containing \M- or Meta- +(see Key Bindings in Readline Init File Syntax) +by converting a key sequence of the form +\M-C or Meta-C to the two-character sequence +ESC C (adding the meta prefix). +If force-meta-prefix is set to ‘off’ (the default), +Readline uses the value of the convert-meta variable to determine +whether to perform this conversion: +if convert-meta is ‘on’, +Readline performs the conversion described above; +if it is ‘off’, Readline converts C to a meta character by +setting the eighth bit (0200). +The default is ‘off’. +

+
+
history-preserve-point
+

If set to ‘on’, the history code attempts to place the point (the +current cursor position) at the +same location on each history line retrieved with previous-history +or next-history. +The default is ‘off’. +

+
+
history-size
+

Set the maximum number of history entries saved in the history list. +If set to zero, any existing history entries are deleted and no new entries +are saved. +If set to a value less than zero, the number of history entries is not +limited. +By default, the number of history entries is not limited. +If you try to set history-size to a non-numeric value, +the maximum number of history entries will be set to 500. +

+
+
horizontal-scroll-mode
+

Setting this variable to ‘on’ means that the text of the lines +being edited will scroll horizontally on a single screen line when +the lines are longer than the width of the screen, instead of wrapping +onto a new screen line. +This variable is automatically set to ‘on’ for terminals of height 1. +By default, this variable is set to ‘off’. +

+
+
+input-meta
+

If set to ‘on’, Readline enables eight-bit input (that is, it +does not clear the eighth bit in the characters it reads), +regardless of what the terminal claims it can support. +The default value is ‘off’, but Readline sets it to ‘on’ +if the locale contains characters whose encodings may include bytes +with the eighth bit set. +This variable is dependent on the LC_CTYPE locale category, and +its value may change if the locale changes. +The name meta-flag is a synonym for input-meta. +

+
+
isearch-terminators
+

The string of characters that should terminate an incremental search without +subsequently executing the character as a command (see Searching for Commands in the History). +If this variable has not been given a value, the characters ESC and +C-j terminate an incremental search. +

+
+
keymap
+

Sets Readline’s idea of the current keymap for key binding commands. +Built-in keymap names are +emacs, +emacs-standard, +emacs-meta, +emacs-ctlx, +vi, +vi-move, +vi-command, and +vi-insert. +vi is equivalent to vi-command (vi-move is also a +synonym); emacs is equivalent to emacs-standard. +Applications may add additional names. +The default value is emacs; +the value of the editing-mode variable also affects the +default keymap. +

+
+
keyseq-timeout
+

Specifies the duration Readline will wait for a character when +reading an ambiguous key sequence +(one that can form a complete key sequence using the input read so far, +or can take additional input to complete a longer key sequence). +If Readline doesn’t receive any input within the timeout, it uses the +shorter but complete key sequence. +Readline uses this value to determine whether or not input is +available on the current input source (rl_instream by default). +The value is specified in milliseconds, so a value of 1000 means that +Readline will wait one second for additional input. +If this variable is set to a value less than or equal to zero, or to a +non-numeric value, Readline waits until another key is pressed to +decide which key sequence to complete. +The default value is 500. +

+
+
mark-directories
+

If set to ‘on’, completed directory names have a slash appended. +The default is ‘on’. +

+
+
mark-modified-lines
+

When this variable is set to ‘on’, Readline displays an +asterisk (‘*’) at the start of history lines which have been modified. +This variable is ‘off’ by default. +

+
+
mark-symlinked-directories
+

If set to ‘on’, completed names which are symbolic links to directories +have a slash appended, subject to the value of mark-directories. +The default is ‘off’. +

+
+
match-hidden-files
+

This variable, when set to ‘on’, forces Readline to match files whose +names begin with a ‘.’ (hidden files) when performing filename +completion. +If set to ‘off’, the user must include the leading ‘.’ +in the filename to be completed. +This variable is ‘on’ by default. +

+
+
menu-complete-display-prefix
+

If set to ‘on’, menu completion displays the common prefix of the +list of possible completions (which may be empty) before cycling through +the list. +The default is ‘off’. +

+
+
output-meta
+

If set to ‘on’, Readline displays characters with the +eighth bit set directly rather than as a meta-prefixed escape +sequence. +The default is ‘off’, but Readline sets it to ‘on’ +if the locale contains characters whose encodings may include +bytes with the eighth bit set. +This variable is dependent on the LC_CTYPE locale category, and +its value may change if the locale changes. +

+
+
page-completions
+

If set to ‘on’, Readline uses an internal pager resembling +more(1) +to display a screenful of possible completions at a time. +This variable is ‘on’ by default. +

+
+
prefer-visible-bell
+

See bell-style. +

+
+
print-completions-horizontally
+

If set to ‘on’, Readline displays completions with matches +sorted horizontally in alphabetical order, rather than down the screen. +The default is ‘off’. +

+
+
revert-all-at-newline
+

If set to ‘on’, Readline will undo all changes to history lines +before returning when executing accept-line. +By default, +history lines may be modified and retain individual undo lists across +calls to readline(). +The default is ‘off’. +

+
+
search-ignore-case
+

If set to ‘on’, Readline performs incremental and non-incremental +history list searches in a case-insensitive fashion. +The default value is ‘off’. +

+
+
show-all-if-ambiguous
+

This alters the default behavior of the completion functions. +If set to ‘on’, +words which have more than one possible completion cause the +matches to be listed immediately instead of ringing the bell. +The default value is ‘off’. +

+
+
show-all-if-unmodified
+

This alters the default behavior of the completion functions in +a fashion similar to show-all-if-ambiguous. +If set to ‘on’, +words which have more than one possible completion without any +possible partial completion (the possible completions don’t share +a common prefix) cause the matches to be listed immediately instead +of ringing the bell. +The default value is ‘off’. +

+
+
show-mode-in-prompt
+

If set to ‘on’, add a string to the beginning of the prompt +indicating the editing mode: emacs, vi command, or vi insertion. +The mode strings are user-settable (e.g., emacs-mode-string). +The default value is ‘off’. +

+
+
skip-completed-text
+

If set to ‘on’, this alters the default completion behavior when +inserting a single match into the line. +It’s only active when performing completion in the middle of a word. +If enabled, Readline does not insert characters from the completion +that match characters after point in the word being completed, +so portions of the word following the cursor are not duplicated. +For instance, if this is enabled, attempting completion when the cursor +is after the first ‘e’ in ‘Makefile’ will result in +‘Makefile’ rather than ‘Makefilefile’, +assuming there is a single possible completion. +The default value is ‘off’. +

+
+
vi-cmd-mode-string
+

If the show-mode-in-prompt variable is enabled, +this string is displayed immediately before the last line of the primary +prompt when vi editing mode is active and in command mode. +The value is expanded like a key binding, so the standard set of +meta- and control- prefixes and backslash escape sequences is available. +The ‘\1’ and ‘\2’ escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +The default is ‘(cmd)’. +

+
+
vi-ins-mode-string
+

If the show-mode-in-prompt variable is enabled, +this string is displayed immediately before the last line of the primary +prompt when vi editing mode is active and in insertion mode. +The value is expanded like a key binding, so the standard set of +meta- and control- prefixes and backslash escape sequences is available. +The ‘\1’ and ‘\2’ escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +The default is ‘(ins)’. +

+
+
visible-stats
+

If set to ‘on’, a character denoting a file’s type +is appended to the filename when listing possible +completions. +The default is ‘off’. +

+
+
+ +
+
Key Bindings
+

The syntax for controlling key bindings in the init file is simple. +First you need to find the name of the command that you +want to change. +The following sections contain tables of the command +name, the default keybinding, if any, and a short description of what +the command does. +

+

Once you know the name of the command, simply place on a line +in the init file the name of the key +you wish to bind the command to, a colon, and then the name of the +command. +There can be no space between the key name and the colon – that will be +interpreted as part of the key name. +The name of the key can be expressed in different ways, depending on +what you find most comfortable. +

+

In addition to command names, Readline allows keys to be bound +to a string that is inserted when the key is pressed (a macro). +The difference between a macro and a command is that a macro is +enclosed in single or double quotes. +

+ +
+
keyname: function-name or macro
+

keyname is the name of a key spelled out in English. +For example: +

+
Control-u: universal-argument
+Meta-Rubout: backward-kill-word
+Control-o: "> output"
+
+ +

In the example above, C-u is bound to the function +universal-argument, +M-DEL is bound to the function backward-kill-word, and +C-o is bound to run the macro +expressed on the right hand side (that is, to insert the text +‘> output’ into the line). +

+

This key binding syntax recognizes a number of symbolic character names: +DEL, +ESC, +ESCAPE, +LFD, +NEWLINE, +RET, +RETURN, +RUBOUT +(a destructive backspace), +SPACE, +SPC, +and +TAB. +

+
+
"keyseq": function-name or macro
+

keyseq differs from keyname above in that strings +denoting an entire key sequence can be specified, by placing +the key sequence in double quotes. +Some GNU Emacs style key escapes can be used, +as in the following example, but none of the +special character names are recognized. +

+
+
"\C-u": universal-argument
+"\C-x\C-r": re-read-init-file
+"\e[11~": "Function Key 1"
+
+ +

In the above example, C-u is again bound to the function +universal-argument (just as it was in the first example), +‘C-x C-r’ is bound to the function re-read-init-file, +and ‘ESC [ 1 1 ~’ is bound to insert +the text ‘Function Key 1’. +

+
+
+ +

The following GNU Emacs style escape sequences are available when +specifying key sequences: +

+
+
\C-
+

A control prefix. +

+
\M-
+

Adding the meta prefix or converting the following character to a meta +character, as described above under force-meta-prefix +(see Variable Settings in Readline Init File Syntax). +

+
\e
+

An escape character. +

+
\\
+

Backslash. +

+
\"
+

", a double quotation mark. +

+
\'
+

', a single quote or apostrophe. +

+
+ +

In addition to the GNU Emacs style escape sequences, a second +set of backslash escapes is available: +

+
+
\a
+

alert (bell) +

+
\b
+

backspace +

+
\d
+

delete +

+
\f
+

form feed +

+
\n
+

newline +

+
\r
+

carriage return +

+
\t
+

horizontal tab +

+
\v
+

vertical tab +

+
\nnn
+

The eight-bit character whose value is the octal value nnn +(one to three digits). +

+
\xHH
+

The eight-bit character whose value is the hexadecimal value HH +(one or two hex digits). +

+
+ +

When entering the text of a macro, single or double quotes must +be used to indicate a macro definition. +Unquoted text is assumed to be a function name. +The backslash escapes described above are expanded +in the macro body. +Backslash will quote any other character in the macro text, +including ‘"’ and ‘'’. +For example, the following binding will make ‘C-x \’ +insert a single ‘\’ into the line: +

+
"\C-x\\": "\\"
+
+ +
+
+ +
+
+
+
+

+Next: , Previous: , Up: Readline Init File   [Contents][Index]

+
+

1.3.2 Conditional Init Constructs

+ +

Readline implements a facility similar in spirit to the conditional +compilation features of the C preprocessor which allows key +bindings and variable settings to be performed as the result +of tests. +There are four parser directives available. +

+
+
$if
+

The $if construct allows bindings to be made based on the +editing mode, the terminal being used, or the application using +Readline. +The text of the test, after any comparison operator, +extends to the end of the line; +unless otherwise noted, no characters are required to isolate it. +

+
+
mode
+

The mode= form of the $if directive is used to test +whether Readline is in emacs or vi mode. +This may be used in conjunction +with the ‘set keymap’ command, for instance, to set bindings in +the emacs-standard and emacs-ctlx keymaps only if +Readline is starting out in emacs mode. +

+
+
term
+

The term= form may be used to include terminal-specific +key bindings, perhaps to bind the key sequences output by the +terminal’s function keys. +The word on the right side of the +‘=’ +is tested against both the full name of the terminal and the portion +of the terminal name before the first ‘-’. +This allows xterm to match both xterm and +xterm-256color, for instance. +

+
+
version
+

The version test may be used to perform comparisons against +specific Readline versions. +The version expands to the current Readline version. +The set of comparison operators includes +‘=’ (and ‘==’), ‘!=’, ‘<=’, ‘>=’, ‘<’, +and ‘>’. +The version number supplied on the right side of the operator consists +of a major version number, an optional decimal point, and an optional +minor version (e.g., ‘7.1’). +If the minor version is omitted, it +defaults to ‘0’. +The operator may be separated from the string version and +from the version number argument by whitespace. +The following example sets a variable if the Readline version being used +is 7.0 or newer: +

+
$if version >= 7.0
+set show-mode-in-prompt on
+$endif
+
+ +
+
application
+

The application construct is used to include +application-specific settings. +Each program using the Readline +library sets the application name, and you can test for +a particular value. +This could be used to bind key sequences to functions useful for +a specific program. +For instance, the following command adds a +key sequence that quotes the current or previous word in Bash: +

+
$if Bash
+# Quote the current or previous word
+"\C-xq": "\eb\"\ef\""
+$endif
+
+ +
+
variable
+

The variable construct provides simple equality tests for Readline +variables and values. +The permitted comparison operators are ‘=’, ‘==’, and ‘!=’. +The variable name must be separated from the comparison operator by +whitespace; the operator may be separated from the value on the right hand +side by whitespace. +String and boolean variables may be tested. +Boolean variables must be +tested against the values on and off. +The following example is equivalent to the mode=emacs test described +above: +

+
$if editing-mode == emacs
+set show-mode-in-prompt on
+$endif
+
+
+
+ +
+
$else
+

Commands in this branch of the $if directive are executed if +the test fails. +

+
+
$endif
+

This command, as seen in the previous example, terminates an +$if command. +

+
+
$include
+

This directive takes a single filename as an argument and reads commands +and key bindings from that file. +For example, the following directive reads from /etc/inputrc: +

+
$include /etc/inputrc
+
+
+
+ +
+
+
+
+

+Previous: , Up: Readline Init File   [Contents][Index]

+
+

1.3.3 Sample Init File

+ +

Here is an example of an inputrc file. This illustrates key +binding, variable assignment, and conditional syntax. +

+
+
# This file controls the behavior of line input editing for
+# programs that use the GNU Readline library.  Existing
+# programs include FTP, Bash, and GDB.
+#
+# You can re-read the inputrc file with C-x C-r.
+# Lines beginning with '#' are comments.
+#
+# First, include any system-wide bindings and variable
+# assignments from /etc/Inputrc
+$include /etc/Inputrc
+
+#
+# Set various bindings for emacs mode.
+
+set editing-mode emacs 
+
+$if mode=emacs
+
+Meta-Control-h:	backward-kill-word	Text after the function name is ignored
+
+#
+# Arrow keys in keypad mode
+#
+#"\M-OD":        backward-char
+#"\M-OC":        forward-char
+#"\M-OA":        previous-history
+#"\M-OB":        next-history
+#
+# Arrow keys in ANSI mode
+#
+"\M-[D":        backward-char
+"\M-[C":        forward-char
+"\M-[A":        previous-history
+"\M-[B":        next-history
+#
+# Arrow keys in 8 bit keypad mode
+#
+#"\M-\C-OD":       backward-char
+#"\M-\C-OC":       forward-char
+#"\M-\C-OA":       previous-history
+#"\M-\C-OB":       next-history
+#
+# Arrow keys in 8 bit ANSI mode
+#
+#"\M-\C-[D":       backward-char
+#"\M-\C-[C":       forward-char
+#"\M-\C-[A":       previous-history
+#"\M-\C-[B":       next-history
+
+C-q: quoted-insert
+
+$endif
+
+# An old-style binding.  This happens to be the default.
+TAB: complete
+
+# Macros that are convenient for shell interaction
+$if Bash
+# edit the path
+"\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f"
+# prepare to type a quoted word --
+# insert open and close double quotes
+# and move to just after the open quote
+"\C-x\"": "\"\"\C-b"
+# insert a backslash (testing backslash escapes
+# in sequences and macros)
+"\C-x\\": "\\"
+# Quote the current or previous word
+"\C-xq": "\eb\"\ef\""
+# Add a binding to refresh the line, which is unbound
+"\C-xr": redraw-current-line
+# Edit variable on current line.
+"\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
+$endif
+
+# use a visible bell if one is available
+set bell-style visible
+
+# don't strip characters to 7 bits when reading
+set input-meta on
+
+# allow iso-latin1 characters to be inserted rather
+# than converted to prefix-meta sequences
+set convert-meta off
+
+# display characters with the eighth bit set directly
+# rather than as meta-prefixed characters
+set output-meta on
+
+# if there are 150 or more possible completions for a word,
+# ask whether or not the user wants to see all of them
+set completion-query-items 150
+
+# For FTP
+$if Ftp
+"\C-xg": "get \M-?"
+"\C-xt": "put \M-?"
+"\M-.": yank-last-arg
+$endif
+
+ +
+
+
+
+
+

+Next: , Previous: , Up: Command Line Editing   [Contents][Index]

+
+

1.4 Bindable Readline Commands

+ + +

This section describes Readline commands that may be bound to key +sequences. +Command names without an accompanying key sequence are unbound by default. +

+

In the following descriptions, point refers to the current cursor +position, and mark refers to a cursor position saved by the +set-mark command. +The text between the point and mark is referred to as the region. +Readline +has the concept of an active region: +when the region is active, +Readline redisplay highlights the region using the +value of the +active-region-start-color +variable. +The enable-active-region variable turns this on and off. +Several commands set the region to active; those are noted below. +

+ +
+
+
+

+Next: , Up: Bindable Readline Commands   [Contents][Index]

+
+

1.4.1 Commands For Moving

+
+
beginning-of-line (C-a)
+

Move to the start of the current line. +This may also be bound to the Home key on some keyboards. +

+
+
end-of-line (C-e)
+

Move to the end of the line. +This may also be bound to the End key on some keyboards. +

+
+
forward-char (C-f)
+

Move forward a character. +This may also be bound to the right arrow key on some keyboards. +

+
+
backward-char (C-b)
+

Move back a character. +This may also be bound to the left arrow key on some keyboards. +

+
+
forward-word (M-f)
+

Move forward to the end of the next word. +Words are composed of letters and digits. +

+
+
backward-word (M-b)
+

Move back to the start of the current or previous word. +Words are composed of letters and digits. +

+ +
+
previous-screen-line ()
+

Attempt to move point to the same physical screen column on the previous +physical screen line. +This will not have the desired effect if the current +Readline line does not take up more than one physical line or if point is not +greater than the length of the prompt plus the screen width. +

+
+
next-screen-line ()
+

Attempt to move point to the same physical screen column on the next +physical screen line. +This will not have the desired effect if the current +Readline line does not take up more than one physical line or if the length +of the current Readline line is not greater than the length of the prompt +plus the screen width. +

+
+
clear-display (M-C-l)
+

Clear the screen and, if possible, the terminal’s scrollback buffer, +then redraw the current line, +leaving the current line at the top of the screen. +

+
+
clear-screen (C-l)
+

Clear the screen, +then redraw the current line, +leaving the current line at the top of the screen. +If given a numeric argument, this refreshes the current line +without clearing the screen. +

+
+
redraw-current-line ()
+

Refresh the current line. By default, this is unbound. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents][Index]

+
+

1.4.2 Commands For Manipulating The History

+ +
+
accept-line (Newline or Return)
+

Accept the line regardless of where the cursor is. +If this line is non-empty, you can add it to the history list using +add_history(). +If this line is a modified history line, then restore the history line +to its original state. +

+
+
previous-history (C-p)
+

Move ‘back’ through the history list, fetching the previous command. +This may also be bound to the up arrow key on some keyboards. +

+
+
next-history (C-n)
+

Move ‘forward’ through the history list, fetching the next command. +This may also be bound to the down arrow key on some keyboards. +

+
+
beginning-of-history (M-<)
+

Move to the first line in the history. +

+
+
end-of-history (M->)
+

Move to the end of the input history, i.e., the line currently +being entered. +

+
+
reverse-search-history (C-r)
+

Search backward starting at the current line and moving ‘up’ through +the history as necessary. +This is an incremental search. +This command sets the region to the matched text and activates the region. +

+
+
forward-search-history (C-s)
+

Search forward starting at the current line and moving ‘down’ through +the history as necessary. +This is an incremental search. +This command sets the region to the matched text and activates the region. +

+
+
non-incremental-reverse-search-history (M-p)
+

Search backward starting at the current line and moving ‘up’ +through the history as necessary using a non-incremental search +for a string supplied by the user. +The search string may match anywhere in a history line. +

+
+
non-incremental-forward-search-history (M-n)
+

Search forward starting at the current line and moving ‘down’ +through the history as necessary using a non-incremental search +for a string supplied by the user. +The search string may match anywhere in a history line. +

+
+
history-search-backward ()
+

Search backward through the history for the string of characters +between the start of the current line and the point. +The search string must match at the beginning of a history line. +This is a non-incremental search. +By default, this command is unbound, but may be bound to the Page Down +key on some keyboards. +

+
+
history-search-forward ()
+

Search forward through the history for the string of characters +between the start of the current line and the point. +The search string must match at the beginning of a history line. +This is a non-incremental search. +By default, this command is unbound, but may be bound to the Page Up +key on some keyboards. +

+
+
history-substring-search-backward ()
+

Search backward through the history for the string of characters +between the start of the current line and the point. +The search string may match anywhere in a history line. +This is a non-incremental search. +By default, this command is unbound. +

+
+
history-substring-search-forward ()
+

Search forward through the history for the string of characters +between the start of the current line and the point. +The search string may match anywhere in a history line. +This is a non-incremental search. +By default, this command is unbound. +

+
+
yank-nth-arg (M-C-y)
+

Insert the first argument to the previous command (usually +the second word on the previous line) at point. +With an argument n, +insert the nth word from the previous command (the words +in the previous command begin with word 0). +A negative argument inserts the nth word from the end of +the previous command. +Once the argument n is computed, +this uses the history expansion facilities to extract the +nth word, as if the +‘!n’ history expansion had been specified. +

+
+
yank-last-arg (M-. or M-_)
+

Insert last argument to the previous command (the last word of the +previous history entry). +With a numeric argument, behave exactly like yank-nth-arg. +Successive calls to yank-last-arg move back through the history +list, inserting the last word (or the word specified by the argument to +the first call) of each line in turn. +Any numeric argument supplied to these successive calls determines +the direction to move through the history. +A negative argument switches the direction through the history +(back or forward). +This uses the history expansion facilities to extract the +last word, as if the +‘!$’ history expansion had been specified. +

+
+
operate-and-get-next (C-o)
+

Accept the current line for return to the calling application as if a +newline had been entered, +and fetch the next line relative to the current line from the history +for editing. +A numeric argument, if supplied, specifies the history entry +to use instead of the current line. +

+
+
fetch-history ()
+

With a numeric argument, fetch that entry from the history list +and make it the current line. +Without an argument, move back to the first entry in the history list. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents][Index]

+
+

1.4.3 Commands For Changing Text

+ +
+
end-of-file (usually C-d)
+

The character indicating end-of-file as set, for example, by +stty. +If this character is read when there are no characters +on the line, and point is at the beginning of the line, Readline +interprets it as the end of input and returns EOF. +

+
+
delete-char (C-d)
+

Delete the character at point. +If this function is bound to the +same character as the tty EOF character, as C-d +commonly is, see above for the effects. +This may also be bound to the Delete key on some keyboards. +

+
+
backward-delete-char (Rubout)
+

Delete the character behind the cursor. +A numeric argument means +to kill the characters, saving them on the kill ring, +instead of deleting them. +

+
+
forward-backward-delete-char ()
+

Delete the character under the cursor, unless the cursor is at the +end of the line, in which case the character behind the cursor is +deleted. +By default, this is not bound to a key. +

+
+
quoted-insert (C-q or C-v)
+

Add the next character typed to the line verbatim. +This is how to insert key sequences like C-q, for example. +

+
+
tab-insert (M-TAB)
+

Insert a tab character. +

+
+
self-insert (a, b, A, 1, !, …)
+

Insert the character typed. +

+
+
bracketed-paste-begin ()
+

This function is intended to be bound to the "bracketed paste" escape +sequence sent by some terminals, and such a binding is assigned by default. +It allows Readline to insert the pasted text as a single unit without treating +each character as if it had been read from the keyboard. +The characters +are inserted as if each one was bound to self-insert instead of +executing any editing commands. +

+

Bracketed paste sets the region (the characters between point and the mark) +to the inserted text. +It sets the active region. +

+
+
transpose-chars (C-t)
+

Drag the character before the cursor forward over +the character at the cursor, moving the +cursor forward as well. +If the insertion point +is at the end of the line, then this +transposes the last two characters of the line. +Negative arguments have no effect. +

+
+
transpose-words (M-t)
+

Drag the word before point past the word after point, +moving point past that word as well. +If the insertion point is at the end of the line, this transposes +the last two words on the line. +

+ +
+
upcase-word (M-u)
+

Uppercase the current (or following) word. +With a negative argument, +uppercase the previous word, but do not move the cursor. +

+
+
downcase-word (M-l)
+

Lowercase the current (or following) word. +With a negative argument, +lowercase the previous word, but do not move the cursor. +

+
+
capitalize-word (M-c)
+

Capitalize the current (or following) word. +With a negative argument, +capitalize the previous word, but do not move the cursor. +

+
+
overwrite-mode ()
+

Toggle overwrite mode. +With an explicit positive numeric argument, switches to overwrite mode. +With an explicit non-positive numeric argument, switches to insert mode. +This command affects only emacs mode; +vi mode does overwrite differently. +Each call to readline() starts in insert mode. +

+

In overwrite mode, characters bound to self-insert replace +the text at point rather than pushing the text to the right. +Characters bound to backward-delete-char replace the character +before point with a space. +

+

By default, this command is unbound, but may be bound to the Insert +key on some keyboards. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents][Index]

+
+

1.4.4 Killing And Yanking

+ +
+
kill-line (C-k)
+

Kill the text from point to the end of the current line. +With a negative numeric argument, kill backward from the cursor to the +beginning of the line. +

+
+
backward-kill-line (C-x Rubout)
+

Kill backward from the cursor to the beginning of the current line. +With a negative numeric argument, kill forward from the cursor to the +end of the line. +

+
+
unix-line-discard (C-u)
+

Kill backward from the cursor to the beginning of the current line. +

+
+
kill-whole-line ()
+

Kill all characters on the current line, no matter where point is. +By default, this is unbound. +

+
+
kill-word (M-d)
+

Kill from point to the end of the current word, or if between +words, to the end of the next word. +Word boundaries are the same as forward-word. +

+
+
backward-kill-word (M-DEL)
+

Kill the word behind point. +Word boundaries are the same as backward-word. +

+ +
+
unix-word-rubout (C-w)
+

Kill the word behind point, using white space as a word boundary, +saving the killed text on the kill-ring. +

+
+
unix-filename-rubout ()
+

Kill the word behind point, using white space and the slash character +as the word boundaries, +saving the killed text on the kill-ring. +

+
+
delete-horizontal-space ()
+

Delete all spaces and tabs around point. +By default, this is unbound. +

+
+
kill-region ()
+

Kill the text in the current region. +By default, this command is unbound. +

+
+
copy-region-as-kill ()
+

Copy the text in the region to the kill buffer, so it can be yanked +right away. +By default, this command is unbound. +

+
+
copy-backward-word ()
+

Copy the word before point to the kill buffer. +The word boundaries are the same as backward-word. +By default, this command is unbound. +

+
+
copy-forward-word ()
+

Copy the word following point to the kill buffer. +The word boundaries are the same as forward-word. +By default, this command is unbound. +

+
+
yank (C-y)
+

Yank the top of the kill ring into the buffer at point. +

+
+
yank-pop (M-y)
+

Rotate the kill-ring, and yank the new top. +You can only do this if +the prior command is yank or yank-pop. +

+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents][Index]

+
+

1.4.5 Specifying Numeric Arguments

+
+
digit-argument (M-0, M-1, … M--)
+

Add this digit to the argument already accumulating, or start a new +argument. +M-- starts a negative argument. +

+
+
universal-argument ()
+

This is another way to specify an argument. +If this command is followed by one or more digits, optionally with a +leading minus sign, those digits define the argument. +If the command is followed by digits, executing universal-argument +again ends the numeric argument, but is otherwise ignored. +As a special case, if this command is immediately followed by a +character that is neither a digit nor minus sign, the argument count +for the next command is multiplied by four. +The argument count is initially one, so executing this function the +first time makes the argument count four, a second time makes the +argument count sixteen, and so on. +By default, this is not bound to a key. +

+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents][Index]

+
+

1.4.6 Letting Readline Type For You

+ +
+
complete (TAB)
+

Attempt to perform completion on the text before point. +The actual completion performed is application-specific. +The default is filename completion. +

+
+
possible-completions (M-?)
+

List the possible completions of the text before point. +When displaying completions, Readline sets the number of columns used +for display to the value of completion-display-width, the value of +the environment variable COLUMNS, or the screen width, in that order. +

+
+
insert-completions (M-*)
+

Insert all completions of the text before point that would have +been generated by possible-completions, +separated by a space. +

+
+
menu-complete ()
+

Similar to complete, but replaces the word to be completed +with a single match from the list of possible completions. +Repeatedly executing menu-complete steps through the list +of possible completions, inserting each match in turn. +At the end of the list of completions, +menu-complete rings the bell +(subject to the setting of bell-style) +and restores the original text. +An argument of n moves n positions forward in the list +of matches; a negative argument moves backward through the list. +This command is intended to be bound to TAB, but is unbound +by default. +

+
+
menu-complete-backward ()
+

Identical to menu-complete, but moves backward through the list +of possible completions, as if menu-complete had been given a +negative argument. +This command is unbound by default. +

+
+
export-completions ()
+

Perform completion on the word before point as described above +and write the list of possible completions to Readline’s output stream +using the following format, writing information on separate lines: +

+
    +
  • the number of matches N; +
  • the word being completed; +
  • S:E, +where S and E are the start and end offsets of the word +in the Readline line buffer; then +
  • each match, one per line +
+ +

If there are no matches, the first line will be “0”, +and this command does not print any output after the S:E. +If there is only a single match, this prints a single line containing it. +If there is more than one match, this prints the common prefix of the +matches, which may be empty, on the first line after the S:E, +then the matches on subsequent lines. +In this case, N will include the first line with the common prefix. +

+

The user or application +should be able to accommodate the possibility of a blank line. +The intent is that the user or application reads N lines after +the line containing S:E to obtain the match list. +This command is unbound by default. +

+
+
delete-char-or-list ()
+

Deletes the character under the cursor if not at the beginning or +end of the line (like delete-char). +At the end of the line, it behaves identically to possible-completions. +This command is unbound by default. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents][Index]

+
+

1.4.7 Keyboard Macros

+
+
start-kbd-macro (C-x ()
+

Begin saving the characters typed into the current keyboard macro. +

+
+
end-kbd-macro (C-x ))
+

Stop saving the characters typed into the current keyboard macro +and save the definition. +

+
+
call-last-kbd-macro (C-x e)
+

Re-execute the last keyboard macro defined, by making the characters +in the macro appear as if typed at the keyboard. +

+
+
print-last-kbd-macro ()
+

Print the last keyboard macro defined in a format suitable for the +inputrc file. +

+
+
+ +
+
+
+
+

+Previous: , Up: Bindable Readline Commands   [Contents][Index]

+
+

1.4.8 Some Miscellaneous Commands

+
+
re-read-init-file (C-x C-r)
+

Read in the contents of the inputrc file, and incorporate +any bindings or variable assignments found there. +

+
+
abort (C-g)
+

Abort the current editing command and +ring the terminal’s bell (subject to the setting of +bell-style). +

+
+
do-lowercase-version (M-A, M-B, M-x, …)
+

If the metafied character x is upper case, run the command +that is bound to the corresponding metafied lower case character. +The behavior is undefined if x is already lower case. +

+
+
prefix-meta (ESC)
+

Metafy the next character typed. +Typing ‘ESC f’ is equivalent to typing M-f. +

+
+
undo (C-_ or C-x C-u)
+

Incremental undo, separately remembered for each line. +

+
+
revert-line (M-r)
+

Undo all changes made to this line. +This is like executing the undo +command enough times to get back to the initial state. +

+
+
tilde-expand (M-~)
+

Perform tilde expansion on the current word. +

+
+
set-mark (C-@)
+

Set the mark to the point. +If a numeric argument is supplied, set the mark to that position. +

+
+
exchange-point-and-mark (C-x C-x)
+

Swap the point with the mark. +Set the current cursor position to the saved position, +then set the mark to the old cursor position. +

+
+
character-search (C-])
+

Read a character and move point to the next occurrence of that character. +A negative argument searches for previous occurrences. +

+
+
character-search-backward (M-C-])
+

Read a character and move point to the previous occurrence of that character. +A negative argument searches for subsequent occurrences. +

+
+
skip-csi-sequence ()
+

Read enough characters to consume a multi-key sequence such as those +defined for keys like Home and End. +CSI sequences begin with a Control Sequence Indicator (CSI), usually +ESC [. +If this sequence is bound to "\e[", +keys producing CSI sequences have no effect +unless explicitly bound to a Readline command, +instead of inserting stray characters into the editing buffer. +This is unbound by default, but usually bound to +ESC [. +

+
+
insert-comment (M-#)
+

Without a numeric argument, insert the value of the comment-begin +variable at the beginning of the current line. +If a numeric argument is supplied, this command acts as a toggle: if +the characters at the beginning of the line do not match the value +of comment-begin, insert the value; otherwise delete +the characters in comment-begin from the beginning of the line. +In either case, the line is accepted as if a newline had been typed. +

+
+
dump-functions ()
+

Print all of the functions and their key bindings +to the Readline output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an inputrc file. +This command is unbound by default. +

+
+
dump-variables ()
+

Print all of the settable variables and their values +to the Readline output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an inputrc file. +This command is unbound by default. +

+
+
dump-macros ()
+

Print all of the Readline key sequences bound to macros and the +strings they output +to the Readline output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an inputrc file. +This command is unbound by default. +

+
+
execute-named-command (M-x)
+

Read a bindable Readline command name from the input and execute the +function to which it’s bound, as if the key sequence to which it was +bound appeared in the input. +If this function is supplied with a numeric argument, it passes that +argument to the function it executes. +

+ +
+
emacs-editing-mode (C-e)
+

When in vi command mode, this causes a switch to emacs +editing mode. +

+
+
vi-editing-mode (M-C-j)
+

When in emacs editing mode, this causes a switch to vi +editing mode. +

+ +
+
+ +
+
+
+
+
+

+Previous: , Up: Command Line Editing   [Contents][Index]

+
+

1.5 Readline vi Mode

+ +

While the Readline library does not have a full set of vi +editing functions, it does contain enough to allow simple editing +of the line. +The Readline vi mode behaves as specified in the +sh description in the POSIX standard. +

+

In order to switch interactively between emacs and vi +editing modes, use the command M-C-j (bound to emacs-editing-mode +when in vi mode and to vi-editing-mode in emacs mode). +The Readline default is emacs mode. +

+

When you enter a line in vi mode, you are already placed in +‘insertion’ mode, as if you had typed an ‘i’. Pressing ESC +switches you into ‘command’ mode, where you can edit the text of the +line with the standard vi movement keys, move to previous +history lines with ‘k’ and subsequent lines with ‘j’, and +so forth. +

+ + +
+
+
+
+
+

+Next: , Previous: , Up: GNU Readline Library   [Contents][Index]

+
+

2 Programming with GNU Readline

+ +

This chapter describes the interface between the GNU Readline Library and +other programs. If you are a programmer, and you wish to include the +features found in GNU Readline +such as completion, line editing, and interactive history manipulation +in your own programs, this section is for you. +

+ + +
+
+
+

+Next: , Up: Programming with GNU Readline   [Contents][Index]

+
+

2.1 Basic Behavior

+ +

Many programs provide a command line interface, such as mail, +ftp, and sh. +For such programs, the default behavior of Readline is sufficient. +This section describes how to use Readline in +the simplest way possible, perhaps to replace calls in your code to +fgets(). +

+ + + +

The function readline() prints a prompt prompt +and then reads and returns a single line of text from the user. +Since it’s possible to enter characters into the line while quoting +them to disable any Readline editing function they might normally have, +this line may include embedded newlines and other special characters. +If prompt is NULL or the empty string, +readline() does not display a prompt. +The line readline() returns is allocated with malloc(); +the caller should free() the line when it has finished with it. +The declaration for readline in ANSI C is +

+
+
char *readline (const char *prompt);
+
+ +

So, one might say +

+
char *line = readline ("Enter a line: ");
+
+

in order to read a line of text from the user. +The line returned has the final newline removed, so only the +text remains. +This means that lines consisting of a newline return the empty string. +

+

If Readline encounters an EOF while reading the line, +and the line is empty at that point, +then readline() returns (char *)NULL. +Otherwise, the line is ended just as if a newline had been typed. +

+

Readline performs some expansion on the prompt before it is +displayed on the screen. +See the description of rl_expand_prompt +(see Redisplay) for additional details, especially if prompt +will contain characters that do not consume physical screen space when +displayed. +

+

If you want the user to be able to get at the line later, (with +C-p for example), you must call add_history() to save the +line away in a history list of such lines. +

+
+
add_history (line);
+
+ +

For full details on the GNU History Library, see the associated manual. +

+

It is preferable to avoid saving empty lines on the history list, since +users rarely have a burning need to reuse a blank line. +Here is a function which usefully replaces the standard gets() library +function, and has the advantage of no static buffer to overflow: +

+
+
/* A static variable for holding the line. */
+static char *line_read = (char *)NULL;
+
+/* Read a string, and return a pointer to it.
+   Returns NULL on EOF. */
+char *
+rl_gets ()
+{
+  /* If the buffer has already been allocated,
+     return the memory to the free pool. */
+  if (line_read)
+    {
+      free (line_read);
+      line_read = (char *)NULL;
+    }
+
+  /* Get a line from the user. */
+  line_read = readline ("");
+
+  /* If the line has any text in it,
+     save it on the history. */
+  if (line_read && *line_read)
+    add_history (line_read);
+
+  return (line_read);
+}
+
+ +

This function gives the user the default behavior of TAB +completion: filename completion. +If you do not want Readline to +complete filenames, you can change the binding of the TAB key +with rl_bind_key(). +

+
+
int rl_bind_key (int key, rl_command_func_t *function);
+
+ +

rl_bind_key() takes two arguments: key is the character that +you want to bind, and function is the address of the function to +call when key is pressed. +Binding TAB to rl_insert() makes TAB insert itself. +rl_bind_key() returns non-zero if key is not a valid +ASCII character code (between 0 and 255). +

+

Thus, to disable the default TAB behavior, the following suffices: +

+
rl_bind_key ('\t', rl_insert);
+
+ +

This code should be executed once at the start of your program; you +might write a function called initialize_readline() which +performs this and other desired initializations, such as installing +custom completers (see Custom Completers). +

+
+
+
+
+

+Next: , Previous: , Up: Programming with GNU Readline   [Contents][Index]

+
+

2.2 Custom Functions

+ +

Readline provides many functions for manipulating the text of +the line, but it isn’t possible to anticipate the needs of all +programs. +This section describes the various functions and variables +defined within the Readline library which allow a program to add +customized functionality to Readline. +

+

Before declaring any functions that customize Readline’s behavior, or +using any functionality Readline provides in other code, an +application writer should include the file <readline/readline.h> +in any file that uses Readline’s features. +Since some of the definitions +in readline.h use the stdio library, the program +should include the file <stdio.h> +before readline.h. +

+

readline.h defines a C preprocessor variable that should +be treated as an integer, RL_READLINE_VERSION, which may +be used to conditionally compile application code depending on +the installed Readline version. +The value is a hexadecimal +encoding of the major and minor version numbers of the library, +of the form 0xMMmm. MM is the two-digit major +version number; mm is the two-digit minor version number. +For Readline 4.2, for example, the value of +RL_READLINE_VERSION would be 0x0402. +

+ + +
+
+
+

+Next: , Up: Custom Functions   [Contents][Index]

+
+

2.2.1 Readline Typedefs

+ +

For readability, we declare a number of new object types, all pointers +to functions. +

+

The reason for declaring these new types is to make it easier to write +code describing pointers to C functions with appropriately prototyped +arguments and return values. +

+

For instance, say we want to declare a variable func as a pointer +to a function which takes two int arguments and returns an +int (this is the type of all of the Readline bindable functions). +Instead of the classic C declaration +

+

int (*func)(); +

+

or the ANSI-C style declaration +

+

int (*func)(int, int); +

+

we may write +

+

rl_command_func_t *func; +

+

The full list of function pointer types available is +

+
+
typedef int rl_command_func_t (int, int);
+
typedef char *rl_compentry_func_t (const char *, int);
+
typedef char **rl_completion_func_t (const char *, int, int);
+
typedef char *rl_quote_func_t (char *, int, char *);
+
typedef char *rl_dequote_func_t (char *, int);
+
typedef int rl_compignore_func_t (char **);
+
typedef void rl_compdisp_func_t (char **, int, int);
+
typedef void rl_macro_print_func_t (const char *, const char *, int, const char *);
+
typedef int rl_hook_func_t (void);
+
typedef int rl_getc_func_t (FILE *);
+
typedef int rl_linebuf_func_t (char *, int);
+
typedef int rl_intfunc_t (int);
+
#define rl_ivoidfunc_t rl_hook_func_t
+
typedef int rl_icpfunc_t (char *);
+
typedef int rl_icppfunc_t (char **);
+
typedef void rl_voidfunc_t (void);
+
typedef void rl_vintfunc_t (int);
+
typedef void rl_vcpfunc_t (char *);
+
typedef void rl_vcppfunc_t (char **);
+
+ +

The rltypedefs.h file has more documentation for these types. +

+
+
+
+
+

+Previous: , Up: Custom Functions   [Contents][Index]

+
+

2.2.2 Writing a New Function

+ +

In order to write new functions for Readline, you need to know the +calling conventions for keyboard-invoked functions, and the names of the +variables that describe the current state of the line read so far. +

+

The calling sequence for a command foo looks like +

+
+
int foo (int count, int key)
+
+ +

where count is the numeric argument (or 1 if defaulted) and +key is the key that invoked this function. +

+

It is completely up to the function as to what should be done with the +numeric argument. +Some functions use it as a repeat count, some +as a flag, and others to choose alternate behavior (refreshing the current +line as opposed to refreshing the screen, for example). +Some choose to ignore it. +In general, if a +function uses the numeric argument as a repeat count, it should be able +to do something useful with both negative and positive arguments. +At the very least, it should be aware that it can be passed a +negative argument. +

+

A command function should return 0 if its action completes successfully, +and a value greater than zero if some error occurs. +All of the builtin Readline bindable command functions +obey this convention. +

+
+
+
+
+
+

+Next: , Previous: , Up: Programming with GNU Readline   [Contents][Index]

+
+

2.3 Readline Variables

+ +

These variables are available to function writers. +

+
+
Variable: char * rl_line_buffer
+

This is the line gathered so far. +You are welcome to modify the contents of the line, +but see Allowing Undoing. +The function rl_extend_line_buffer will increase +the memory allocated to rl_line_buffer. +

+ +
+
Variable: int rl_point
+

The offset of the current cursor position in rl_line_buffer +(the point). +

+ +
+
Variable: int rl_end
+

The number of characters present in rl_line_buffer. +When rl_point is at the end of the line, +rl_point and rl_end are equal. +

+ +
+
Variable: int rl_mark
+

The mark (saved position) in the current line. +If set, the mark and point define a region. +Some Readline commands set the mark as part of operating; +users can also set the mark explicitly. +

+ +
+
Variable: int rl_done
+

Setting this to a non-zero value causes Readline to return the current +line immediately. +Readline will set this variable when it has read a key sequence bound +to accept-line and is about to return the line to the caller. +

+ +
+
Variable: int rl_eof_found
+

Readline will set this variable when it has read an EOF character +(e.g., the stty ‘EOF’ character) on an empty line +or has encountered a read error or EOF and +is about to return a NULL line to the caller. +

+ +
+
Variable: int rl_num_chars_to_read
+

Setting this to a positive value before calling readline() causes +Readline to return after accepting that many characters, rather +than reading up to a character bound to accept-line. +

+ +
+
Variable: int rl_pending_input
+

Setting this to a value makes it the next keystroke read. +This is a way to stuff a single character into the input stream. +

+ +
+
Variable: int rl_dispatching
+

Set to a non-zero value if a function is being called from a key binding; +zero otherwise. +Application functions can test this to discover whether +they were called directly or by Readline’s dispatching mechanism. +

+ +
+
Variable: int rl_erase_empty_line
+

Setting this to a non-zero value causes Readline to completely erase +the current line, including any prompt, any time a newline is typed as +the only character on an otherwise-empty line. +This moves the cursor to the beginning of the newly-blank line. +

+ +
+
Variable: char * rl_prompt
+

The prompt Readline uses. +This is set from the argument to +readline(), and should not be assigned to directly. +The rl_set_prompt() function (see Redisplay) may +be used to modify the prompt string after calling readline(). +Readline performs some prompt expansions and analyzes the prompt for +line breaks, so rl_set_prompt() is preferred. +

+ +
+
Variable: char * rl_display_prompt
+

The string displayed as the prompt. +This is usually identical to +rl_prompt, but may be changed temporarily by functions that +use the prompt string as a message area, such as incremental search. +

+ +
+
Variable: int rl_already_prompted
+

If an application wishes to display the prompt itself, rather than have +Readline do it the first time readline() is called, it should set +this variable to a non-zero value after displaying the prompt. +The prompt must also be passed as the argument to readline() so +the redisplay functions can update the display properly. +The calling application is responsible for managing the value; Readline +never sets it. +

+ +
+
Variable: const char * rl_library_version
+

The version number of this revision of the Readline library, as a string +(e.g., "4.2"). +

+ +
+
Variable: int rl_readline_version
+

An integer encoding the current version of the library. +The encoding is of the form 0xMMmm, +where MM is the two-digit major version number, +and mm is the two-digit minor version number. +For example, for Readline-4.2, rl_readline_version would have the +value 0x0402. +

+ +
+
Variable: int rl_gnu_readline_p
+

Always set to 1, denoting that this is GNU Readline rather than some +emulation. +

+ +
+
Variable: const char * rl_terminal_name
+

The terminal type, used for initialization. +If not set by the application, +Readline sets this to the value of the TERM environment variable +the first time it is called. +Readline uses this to look up the terminal capabilities it needs in +the terminfo database. +

+ +
+
Variable: const char * rl_readline_name
+

This variable is set to a unique name by each application using Readline. +The value allows conditional parsing of the inputrc file +(see Conditional Init Constructs). +

+ +
+
Variable: FILE * rl_instream
+

The stdio stream from which Readline reads input. +If NULL, Readline defaults to stdin. +

+ +
+
Variable: FILE * rl_outstream
+

The stdio stream to which Readline performs output. +If NULL, Readline defaults to stdout. +

+ +
+
Variable: int rl_prefer_env_winsize
+

If non-zero, Readline gives values found in the LINES and +COLUMNS environment variables greater precedence than values fetched +from the kernel when computing the screen dimensions. +

+ +
+
Variable: rl_command_func_t * rl_last_func
+

The address of the last command function Readline executed. +This may be used to test whether or not a function is being executed +twice in succession, for example. +

+ +
+
Variable: rl_hook_func_t * rl_startup_hook
+

If non-zero, this is the address of a function to call just +before Readline prints the first prompt. +

+ +
+
Variable: rl_hook_func_t * rl_pre_input_hook
+

If non-zero, this is the address of a function to call after +the first prompt has been printed and just before Readline +starts reading input characters. +

+ +
+
Variable: rl_hook_func_t * rl_event_hook
+

If non-zero, this is the address of a function to call periodically +when Readline is waiting for terminal input. +By default, this will be called at most ten times a second if there +is no keyboard input. +

+ +
+
Variable: rl_getc_func_t * rl_getc_function
+

If non-zero, Readline will call indirectly through this pointer +to get a character from the input stream. +By default, it is set to rl_getc, the Readline character +input function (see Character Input). +In general, an application that sets rl_getc_function should consider +setting rl_input_available_hook as well. +

+ +
+
Variable: rl_hook_func_t * rl_signal_event_hook
+

If non-zero, this is the address of a function to call if a read system +call is interrupted by a signal when Readline is reading terminal input. +

+ +
+
Variable: rl_hook_func_t * rl_timeout_event_hook
+

If non-zero, this is the address of a function to call if Readline times +out while reading input. +

+ +
+
Variable: rl_hook_func_t * rl_input_available_hook
+

If non-zero, Readline will use this function’s return value when it needs +to determine whether or not there is available input on the current input +source. +The default hook checks rl_instream; if an application is using a +different input source, it should set the hook appropriately. +Readline queries for available input when implementing intra-key-sequence +timeouts during input and incremental searches. +This function must return zero if there is no input available, and non-zero +if input is available. +This may use an application-specific timeout before returning a value; +Readline uses the value passed to rl_set_keyboard_input_timeout() +or the value of the user-settable keyseq-timeout variable. +This is designed for use by applications using Readline’s callback interface +(see Alternate Interface), which may not use the traditional +read(2) and file descriptor interface, or other applications using +a different input mechanism. +If an application uses an input mechanism or hook that can potentially exceed +the value of keyseq-timeout, it should increase the timeout or set +this hook appropriately even when not using the callback interface. +In general, an application that sets rl_getc_function should consider +setting rl_input_available_hook as well. +

+ +
+
Variable: rl_voidfunc_t * rl_redisplay_function
+

Readline will call indirectly through this pointer +to update the display with the current contents of the editing buffer. +By default, it is set to rl_redisplay, the default Readline +redisplay function (see Redisplay). +

+ +
+
Variable: rl_vintfunc_t * rl_prep_term_function
+

If non-zero, Readline will call indirectly through this pointer +to initialize the terminal. +The function takes a single argument, an +int flag that says whether or not to use eight-bit characters. +By default, this is set to rl_prep_terminal +(see Terminal Management). +

+ +
+
Variable: rl_voidfunc_t * rl_deprep_term_function
+

If non-zero, Readline will call indirectly through this pointer +to reset the terminal. +This function should undo the effects of rl_prep_term_function. +By default, this is set to rl_deprep_terminal +(see Terminal Management). +

+ +
+
Variable: void rl_macro_display_hook
+

If set, this points to a function that rl_macro_dumper will call to +display a key sequence bound to a macro. +It is called with the key sequence, the "untranslated" macro value (i.e., +with backslash escapes included, as when passed to rl_macro_bind), +the readable argument passed to rl_macro_dumper, and any +prefix to display before the key sequence. +

+ +
+
Variable: Keymap rl_executing_keymap
+

This variable is set to the keymap (see Selecting a Keymap) in which the +currently executing Readline function was found. +

+ +
+
Variable: Keymap rl_binding_keymap
+

This variable is set to the keymap (see Selecting a Keymap) in which the +last key binding occurred. +

+ +
+
Variable: char * rl_executing_macro
+

This variable is set to the text of any currently-executing macro. +

+ +
+
Variable: int rl_executing_key
+

The key that caused the dispatch to the currently-executing Readline function. +

+ +
+
Variable: char * rl_executing_keyseq
+

The full key sequence that caused the dispatch to the currently-executing +Readline function. +

+ +
+
Variable: int rl_key_sequence_length
+

The number of characters in rl_executing_keyseq. +

+ +
+
Variable: int rl_readline_state
+

A variable with bit values that encapsulate the current Readline state. +A bit is set with the RL_SETSTATE macro, and unset with the +RL_UNSETSTATE macro. +Use the RL_ISSTATE macro to test whether a particular state +bit is set. +Current state bits include: +

+
+
RL_STATE_NONE
+

Readline has not yet been called, nor has it begun to initialize. +

+
RL_STATE_INITIALIZING
+

Readline is initializing its internal data structures. +

+
RL_STATE_INITIALIZED
+

Readline has completed its initialization. +

+
RL_STATE_TERMPREPPED
+

Readline has modified the terminal modes to do its own input and redisplay. +

+
RL_STATE_READCMD
+

Readline is reading a command from the keyboard. +

+
RL_STATE_METANEXT
+

Readline is reading more input after reading the meta-prefix character. +

+
RL_STATE_DISPATCHING
+

Readline is dispatching to a command. +

+
RL_STATE_MOREINPUT
+

Readline is reading more input while executing an editing command. +

+
RL_STATE_ISEARCH
+

Readline is performing an incremental history search. +

+
RL_STATE_NSEARCH
+

Readline is performing a non-incremental history search. +

+
RL_STATE_SEARCH
+

Readline is searching backward or forward through the history for a string. +

+
RL_STATE_NUMERICARG
+

Readline is reading a numeric argument. +

+
RL_STATE_MACROINPUT
+

Readline is currently getting its input from a previously-defined keyboard +macro. +

+
RL_STATE_MACRODEF
+

Readline is currently reading characters defining a keyboard macro. +

+
RL_STATE_OVERWRITE
+

Readline is in overwrite mode. +

+
RL_STATE_COMPLETING
+

Readline is performing word completion. +

+
RL_STATE_SIGHANDLER
+

Readline is currently executing the Readline signal handler. +

+
RL_STATE_UNDOING
+

Readline is performing an undo. +

+
RL_STATE_INPUTPENDING
+

Readline has input pending due to a call to rl_execute_next(). +

+
RL_STATE_TTYCSAVED
+

Readline has saved the values of the terminal’s special characters. +

+
RL_STATE_CALLBACK
+

Readline is currently using the alternate (callback) interface +(see Alternate Interface). +

+
RL_STATE_VIMOTION
+

Readline is reading the argument to a vi-mode "motion" command. +

+
RL_STATE_MULTIKEY
+

Readline is reading a multiple-keystroke command. +

+
RL_STATE_VICMDONCE
+

Readline has entered vi command (movement) mode at least one time during +the current call to readline(). +

+
RL_STATE_DONE
+

Readline has read a key sequence bound to accept-line +and is about to return the line to the caller. +

+
RL_STATE_TIMEOUT
+

Readline has timed out (it did not receive a line or specified number of +characters before the timeout duration specified by rl_set_timeout +elapsed) and is returning that status to the caller. +

+
RL_STATE_EOF
+

Readline has read an EOF character (e.g., the stty ‘EOF’ character) +or encountered a read error or EOF +and is about to return a NULL line to the caller. +

+
+ +
+ +
+
Variable: int rl_explicit_arg
+

Set to a non-zero value if an explicit numeric argument was specified by +the user. +It is only valid in a bindable command function. +

+ +
+
Variable: int rl_numeric_arg
+

Set to the value of any numeric argument explicitly specified by the user +before executing the current Readline function. +It is only valid in a bindable command function. +

+ +
+
Variable: int rl_editing_mode
+

Set to a value denoting Readline’s current editing mode. +A value of 1 means Readline is currently in emacs mode; +0 means that vi mode is active. +This determines the current keymap and key bindings. +

+ +
+
+
+
+

+Next: , Previous: , Up: Programming with GNU Readline   [Contents][Index]

+
+

2.4 Readline Convenience Functions

+ + + +
+
+
+

+Next: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.1 Naming a Function

+ +

Readline has a descriptive +string name for every function a user can bind to a key sequence, +so users can dynamically change the bindings associated with key +sequences while using Readline, +using the descriptive name when referring to the function. +Thus, in an init file, one might find +

+
+
Meta-Rubout:	backward-kill-word
+
+ +

This binds the keystroke Meta-Rubout to the function +descriptively named backward-kill-word. +As the programmer, you +should bind the functions you write to descriptive names as well. +Readline provides a function for doing that: +

+
+
Function: int rl_add_defun (const char *name, rl_command_func_t *function, int key)
+

Add name to the list of named functions. +Make function be the function that gets called by key sequences +that bind to name. +If key is not -1, then bind it to +function using rl_bind_key(). +

+ +

Using this function alone is sufficient for most applications. +It is the recommended way to add a few functions to the default +functions that Readline has built in. +If you need to do something other than adding a function to Readline, +you may need to use the underlying functions described below. +

+
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.2 Selecting a Keymap

+ +

Key bindings take place on a keymap. +The keymap is the association between the keys that the user types and +the functions that get run. +You can make your own keymaps, copy existing keymaps, and tell +Readline which keymap to use. +

+
+
Function: Keymap rl_make_bare_keymap (void)
+

Returns a new, empty keymap. +The space for the keymap is allocated with +malloc(); the caller should free it by calling +rl_free_keymap() when done. +

+ +
+
Function: Keymap rl_copy_keymap (Keymap map)
+

Return a new keymap which is a copy of map. +

+ +
+
Function: Keymap rl_make_keymap (void)
+

Return a new keymap with the printing characters bound to rl_insert, +the lowercase Meta characters bound to run their equivalents, and +the Meta digits bound to produce numeric arguments. +

+ +
+
Function: void rl_discard_keymap (Keymap keymap)
+

Free the storage associated with the data in keymap. +The caller should free keymap. +

+ +
+
Function: void rl_free_keymap (Keymap keymap)
+

Free all storage associated with keymap. +This calls rl_discard_keymap to free subordinate +keymaps and macros. +

+ +
+
Function: int rl_empty_keymap (Keymap keymap)
+

Return non-zero if there are no keys bound to functions in keymap; +zero if there are any keys bound. +

+ +

Readline has several internal keymaps. +These functions allow you to change which keymap is active. +This is one way to switch editing modes, for example. +

+
+
Function: Keymap rl_get_keymap (void)
+

Returns the currently active keymap. +

+ +
+
Function: void rl_set_keymap (Keymap keymap)
+

Makes keymap the currently active keymap. +

+ +
+
Function: Keymap rl_get_keymap_by_name (const char *name)
+

Return the keymap matching name. +name is one which would be supplied in a +set keymap inputrc line (see Readline Init File). +

+ +
+
Function: char * rl_get_keymap_name (Keymap keymap)
+

Return the name matching keymap. +name is one which would be supplied in a +set keymap inputrc line (see Readline Init File). +

+ +
+
Function: int rl_set_keymap_name (const char *name, Keymap keymap)
+

Set the name of keymap. +This name will then be "registered" and +available for use in a set keymap inputrc directive +see Readline Init File). +The name may not be one of Readline’s builtin keymap names; +you may not add a different name for one of Readline’s builtin keymaps. +You may replace the name associated with a given keymap by calling this +function more than once with the same keymap argument. +You may associate a registered name with a new keymap by calling this +function more than once with the same name argument. +There is no way to remove a named keymap once the name has been +registered. +Readline will make a copy of name. +The return value is greater than zero unless name is one of +Readline’s builtin keymap names or keymap is one of Readline’s +builtin keymaps. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.3 Binding Keys

+ +

Key sequences are associated with functions through the keymap. +Readline has several internal keymaps: emacs_standard_keymap, +emacs_meta_keymap, emacs_ctlx_keymap, +vi_movement_keymap, and vi_insertion_keymap. +emacs_standard_keymap is the default, and the examples in +this manual assume that. +

+

Since readline() installs a set of default key bindings the first +time it is called, there is always the danger that a custom binding +installed before the first call to readline() will be overridden. +An alternate mechanism that can avoid this +is to install custom key bindings in an +initialization function assigned to the rl_startup_hook variable +(see Readline Variables). +

+

These functions manage key bindings. +

+
+
Function: int rl_bind_key (int key, rl_command_func_t *function)
+

Binds key to function in the currently active keymap. +Returns non-zero in the case of an invalid key. +

+ +
+
Function: int rl_bind_key_in_map (int key, rl_command_func_t *function, Keymap map)
+

Bind key to function in map. +Returns non-zero in the case of an invalid key. +

+ +
+
Function: int rl_bind_key_if_unbound (int key, rl_command_func_t *function)
+

Binds key to function if it is not already bound in the +currently active keymap. +Returns non-zero in the case of an invalid key or if key is +already bound. +

+ +
+
Function: int rl_bind_key_if_unbound_in_map (int key, rl_command_func_t *function, Keymap map)
+

Binds key to function if it is not already bound in map. +Returns non-zero in the case of an invalid key or if key is +already bound. +

+ +
+
Function: int rl_unbind_key (int key)
+

Bind key to the null function in the currently active keymap. +This is not the same as binding it to self-insert. +Returns non-zero in case of error. +

+ +
+
Function: int rl_unbind_key_in_map (int key, Keymap map)
+

Bind key to the null function in map. +This is not the same as binding it to self-insert. +Returns non-zero in case of error. +

+ +
+
Function: int rl_unbind_function_in_map (rl_command_func_t *function, Keymap map)
+

Unbind all keys that execute function in map. +

+ +
+
Function: int rl_unbind_command_in_map (const char *command, Keymap map)
+

Unbind all keys that are bound to command in map. +

+ +
+
Function: int rl_bind_keyseq (const char *keyseq, rl_command_func_t *function)
+

Bind the key sequence represented by the string keyseq to the function +function, beginning in the current keymap. +This makes new keymaps as necessary. +The return value is non-zero if keyseq is invalid. +

+ +
+
Function: int rl_bind_keyseq_in_map (const char *keyseq, rl_command_func_t *function, Keymap map)
+

Bind the key sequence represented by the string keyseq to the function +function in map. +This makes new keymaps as necessary. +Initial bindings are performed in map. +The return value is non-zero if keyseq is invalid. +

+ +
+
Function: int rl_set_key (const char *keyseq, rl_command_func_t *function, Keymap map)
+

Equivalent to rl_bind_keyseq_in_map. +

+ +
+
Function: int rl_bind_keyseq_if_unbound (const char *keyseq, rl_command_func_t *function)
+

Binds keyseq to function if it is not already bound in the +currently active keymap. +Returns non-zero in the case of an invalid keyseq or if keyseq is +already bound. +

+ +
+
Function: int rl_bind_keyseq_if_unbound_in_map (const char *keyseq, rl_command_func_t *function, Keymap map)
+

Binds keyseq to function if it is not already bound in map. +Returns non-zero in the case of an invalid keyseq or if keyseq is +already bound. +

+ +
+
Function: int rl_generic_bind (int type, const char *keyseq, char *data, Keymap map)
+

Bind the key sequence represented by the string keyseq to the arbitrary +pointer data. +type says what kind of data is pointed to by data; this can be +a function (ISFUNC), +a macro (ISMACR), +or a keymap (ISKMAP). +This makes new keymaps as necessary. +The initial keymap in which to do bindings is map. +Returns non-zero in the case of an invalid keyseq, zero otherwise. +

+ +
+
Function: int rl_parse_and_bind (char *line)
+

Parse line as if it had been read from the inputrc file and +perform any key bindings and variable assignments found +(see Readline Init File). +

+ +
+
Function: int rl_read_init_file (const char *filename)
+

Read keybindings and variable assignments from filename +(see Readline Init File). +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.4 Associating Function Names and Bindings

+ +

These functions allow you to find out what keys invoke named functions +and the functions invoked by a particular key sequence. +You may also associate a new function name with an arbitrary function. +

+
+
Function: rl_command_func_t * rl_named_function (const char *name)
+

Return the function with name name. +name is a descriptive name users might use in a key binding. +

+ +
+
Function: rl_command_func_t * rl_function_of_keyseq (const char *keyseq, Keymap map, int *type)
+

Return the function invoked by keyseq in keymap map. +If map is NULL, this uses the current keymap. +If type is not NULL, this returns the type of the object +in the int variable it points to +(one of ISFUNC, ISKMAP, or ISMACR). +It takes a "translated" key sequence and should not be used +if the key sequence can include NUL. +

+ +
+
Function: rl_command_func_t * rl_function_of_keyseq_len (const char *keyseq, size_t len, Keymap map, int *type)
+

Return the function invoked by keyseq of length len +in keymap map. +Equivalent to rl_function_of_keyseq with the addition +of the len parameter. +It takes a "translated" key sequence and should be used +if the key sequence can include NUL. +

+ +
+
Function: int rl_trim_arg_from_keyseq (const char *keyseq, size_t len, Keymap map)
+

If there is a numeric argument at the beginning of keyseq, possibly +including digits, return the index of the first character in keyseq +following the numeric argument. +This can be used to skip over the numeric argument (which is available as +rl_numeric_arg) while traversing the key sequence that invoked the +current command. +

+ +
+
Function: char ** rl_invoking_keyseqs (rl_command_func_t *function)
+

Return an array of strings representing the key sequences used to +invoke function in the current keymap. +

+ +
+
Function: char ** rl_invoking_keyseqs_in_map (rl_command_func_t *function, Keymap map)
+

Return an array of strings representing the key sequences used to +invoke function in the keymap map. +

+ +
+
Function: void rl_print_keybinding (const char *name, Keymap map, int readable)
+

Print key sequences bound to Readline function name name in +keymap map. +If map is NULL, this uses the current keymap. +If readable is non-zero, +the list is formatted in such a way that it can be made part of an +inputrc file and re-read to recreate the key binding. +

+ +
+
Function: void rl_function_dumper (int readable)
+

Print the Readline function names and the key sequences currently +bound to them to rl_outstream. +If readable is non-zero, +the list is formatted in such a way that it can be made part of an +inputrc file and re-read. +

+ +
+
Function: void rl_list_funmap_names (void)
+

Print the names of all bindable Readline functions to rl_outstream. +

+ +
+
Function: const char ** rl_funmap_names (void)
+

Return a NULL terminated array of known function names. +The array is sorted. +The array itself is allocated, but not the strings inside. +You should free the array, but not the pointers, using free +or rl_free when you are done. +

+ +
+
Function: int rl_add_funmap_entry (const char *name, rl_command_func_t *function)
+

Add name to the list of bindable Readline command names, and make +function the function to be called when name is invoked. +This returns the index of the newly-added name in the array of +function names. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.5 Allowing Undoing

+ +

Supporting the undo command is a painless thing, and makes your +functions much more useful. +It is certainly easier to try something if you know you can undo it. +

+

If your function simply inserts text once, or deletes text once, +and uses rl_insert_text() or rl_delete_text() to do it, +then Readline does the undoing for you automatically. +

+

If you do multiple insertions or multiple deletions, or any combination +of these operations, you should group them together into one operation. +This is done with rl_begin_undo_group() and +rl_end_undo_group(). +

+

The types of events Readline can undo are: +

+
+
enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END }; 
+
+ +

Notice that UNDO_DELETE means to insert some text, and +UNDO_INSERT means to delete some text. +That is, the undo code tells what to undo, not how to undo it. +UNDO_BEGIN and UNDO_END are tags +added by rl_begin_undo_group() and rl_end_undo_group(); +they are how Readline delimits groups of commands that should be +undone together. +

+
+
Function: int rl_begin_undo_group (void)
+

Begins saving undo information in a group construct. +The undo information usually comes from calls to rl_insert_text() +and rl_delete_text(), but could be the result of calls to +rl_add_undo(). +

+ +
+
Function: int rl_end_undo_group (void)
+

Closes the current undo group started with rl_begin_undo_group(). +There should be one call to rl_end_undo_group() +for each call to rl_begin_undo_group(). +

+ +
+
Function: void rl_add_undo (enum undo_code what, int start, int end, char *text)
+

Remember how to undo an event (according to what). +The affected text runs from start to end, +and encompasses text. +

+ +
+
Function: void rl_free_undo_list (void)
+

Free the existing undo list. +

+ +
+
Function: int rl_do_undo (void)
+

Undo the first thing on the undo list. +Returns 0 if there was nothing to undo, +non-zero if something was undone. +

+ +

Finally, if you neither insert nor delete text, but directly modify the +existing text (e.g., change its case), call rl_modifying() +once, just before you modify the text. +You must supply the indices of the text range that you are going to modify. +Readline will create an undo group for you. +

+
+
Function: int rl_modifying (int start, int end)
+

Tell Readline to save the text between start and end as a +single undo unit. +It is assumed that you will subsequently modify that text. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.6 Redisplay

+ +
+
Function: void rl_redisplay (void)
+

Change what’s displayed on the screen to reflect the current contents +of rl_line_buffer. +

+ +
+
Function: int rl_forced_update_display (void)
+

Force the line to be updated and redisplayed, whether or not +Readline thinks the screen display is correct. +

+ +
+
Function: int rl_on_new_line (void)
+

Tell the update functions that we have moved onto a new (empty) line, +usually after outputting a newline. +

+ +
+
Function: int rl_on_new_line_with_prompt (void)
+

Tell the update functions that we have moved onto a new line, with +rl_prompt already displayed. +This could be used by applications that want to output the prompt string +themselves, but still need Readline to know the prompt string length for +redisplay. +It should be used after setting rl_already_prompted. +

+ +
+
Function: int rl_clear_visible_line (void)
+

Clear the screen lines corresponding to the current line’s contents. +

+ +
+
Function: int rl_reset_line_state (void)
+

Reset the display state to a clean state and redisplay the current line +starting on a new line. +

+ +
+
Function: int rl_crlf (void)
+

Move the cursor to the start of the next screen line. +

+ +
+
Function: int rl_show_char (int c)
+

Display character c on rl_outstream. +If Readline has not been set to display meta characters directly, this +will convert meta characters to a meta-prefixed key sequence. +This is intended for use by applications which wish to do their own +redisplay. +

+ +
+
Function: int rl_message (const char *, …)
+

The arguments are a format string as would be supplied to printf, +possibly containing conversion specifications such as ‘%d’, and +any additional arguments necessary to satisfy the conversion specifications. +The resulting string is displayed in the echo area. +The echo area is also used to display numeric arguments and search strings. +You should call rl_save_prompt to save the prompt information +before calling this function. +

+ +
+
Function: int rl_clear_message (void)
+

Clear the message in the echo area. +If the prompt was saved with a call to +rl_save_prompt before the last call to rl_message, +you must call rl_restore_prompt before calling this function. +

+ +
+
Function: void rl_save_prompt (void)
+

Save the local Readline prompt display state in preparation for +displaying a new message in the message area with rl_message(). +

+ +
+
Function: void rl_restore_prompt (void)
+

Restore the local Readline prompt display state saved by the most +recent call to rl_save_prompt. +If you called rl_save_prompt to save the prompt before a call +to rl_message, you should call this function before the +corresponding call to rl_clear_message. +

+ +
+
Function: int rl_expand_prompt (char *prompt)
+

Expand any special character sequences in prompt and set up the +local Readline prompt redisplay variables. +This function is called by readline(). +It may also be called to +expand the primary prompt if the application uses the +rl_on_new_line_with_prompt() function or +rl_already_prompted variable. +It returns the number of visible characters on the last line of the +(possibly multi-line) prompt. +Applications may indicate that the prompt contains characters that take +up no physical screen space when displayed by bracketing a sequence of +such characters with the special markers RL_PROMPT_START_IGNORE +and RL_PROMPT_END_IGNORE (declared in readline.h as +‘\001’ and ‘\002’, respectively). +This may be used to embed terminal-specific escape sequences in prompts. +If you don’t use these indicators, redisplay will likely produce screen +contents that don’t match the line buffer. +

+ +
+
Function: int rl_set_prompt (const char *prompt)
+

Make Readline use prompt for subsequent redisplay. +This calls rl_expand_prompt() to expand the prompt +and sets rl_prompt to the result. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.7 Modifying Text

+ +
+
Function: int rl_insert_text (const char *text)
+

Insert text into the line at the current cursor position. +Returns the number of characters inserted. +

+ +
+
Function: int rl_delete_text (int start, int end)
+

Delete the text between start and end in the current line. +Returns the number of characters deleted. +

+ +
+
Function: char * rl_copy_text (int start, int end)
+

Return a copy of the text between start and end in +the current line. +

+ +
+
Function: int rl_kill_text (int start, int end)
+

Copy the text between start and end in the current line +to the kill ring, appending or prepending to the last kill if the +last command was a kill command. +This deletes the text from the line. +If start is less than end, the text is appended, +otherwise it is prepended. +If the last command was not a kill, this uses a new kill ring slot. +

+ +
+
Function: void rl_replace_line (const char *text, int clear_undo)
+

Replace the contents of rl_line_buffer with text. +This preserves the point and mark, if possible. +If clear_undo is non-zero, this clears the undo list associated +with the current line. +

+ +
+
Function: int rl_push_macro_input (char *macro)
+

Insert macro into the line, as if it had been invoked +by a key bound to a macro. +Not especially useful; use rl_insert_text() instead. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.8 Character Input

+ +
+
Function: int rl_read_key (void)
+

Return the next character available from Readline’s current input stream. +This handles input inserted into +the input stream via rl_pending_input (see Readline Variables) +and rl_stuff_char(), macros, and characters read from the keyboard. +While waiting for input, this function will call any function assigned to +the rl_event_hook variable. +

+ +
+
Function: int rl_getc (FILE *stream)
+

Return the next character available from stream, which is assumed to +be the keyboard. +

+ +
+
Function: int rl_stuff_char (int c)
+

Insert c into the Readline input stream. +It will be "read" before Readline attempts to read characters +from the terminal with rl_read_key(). +Applications can push back up to 512 characters. +rl_stuff_char returns 1 if the character was successfully inserted; +0 otherwise. +

+ +
+
Function: int rl_execute_next (int c)
+

Make c be the next command to be executed when rl_read_key() +is called. +This sets rl_pending_input. +

+ +
+
Function: int rl_clear_pending_input (void)
+

Unset rl_pending_input, effectively negating the effect of any +previous call to rl_execute_next(). +This works only if the pending input has not already been read +with rl_read_key(). +

+ +
+
Function: int rl_set_keyboard_input_timeout (int u)
+

While waiting for keyboard input in rl_read_key(), Readline will +wait for u microseconds for input before calling any function +assigned to rl_event_hook. +u must be greater than or equal +to zero (a zero-length timeout is equivalent to a poll). +The default waiting period is one-tenth of a second. +Returns the old timeout value. +

+ +
+
Function: int rl_set_timeout (unsigned int secs, unsigned int usecs)
+

Set a timeout for subsequent calls to readline(). +If Readline does not read a complete line, or the number of characters +specified by rl_num_chars_to_read, +before the duration specified by secs (in seconds) +and usecs (microseconds), it returns and sets +RL_STATE_TIMEOUT in rl_readline_state. +Passing 0 for secs and usecs cancels any previously set +timeout; the convenience macro rl_clear_timeout() is shorthand +for this. +Returns 0 if the timeout is set successfully. +

+ +
+
Function: int rl_timeout_remaining (unsigned int *secs, unsigned int *usecs)
+

Return the number of seconds and microseconds remaining in the current +timeout duration in *secs and *usecs, respectively. +Both *secs and *usecs must be non-NULL to return any values. +The return value is -1 on error or when there is no timeout set, +0 when the timeout has expired (leaving *secs and *usecs +unchanged), +and 1 if the timeout has not expired. +If either of secs and usecs is NULL, +the return value indicates whether the timeout has expired. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.9 Terminal Management

+ +
+
Function: void rl_prep_terminal (int meta_flag)
+

Modify the terminal settings for Readline’s use, so readline() +can read a single character at a time from the keyboard +and perform redisplay. +The meta_flag argument should be non-zero if Readline should +read eight-bit input. +

+ +
+
Function: void rl_deprep_terminal (void)
+

Undo the effects of rl_prep_terminal(), leaving the terminal in +the state in which it was before the most recent call to +rl_prep_terminal(). +

+ +
+
Function: void rl_tty_set_default_bindings (Keymap kmap)
+

Read the operating system’s terminal editing characters (as would be +displayed by stty) to their Readline equivalents. +The bindings are performed in kmap. +

+ +
+
Function: void rl_tty_unset_default_bindings (Keymap kmap)
+

Reset the bindings manipulated by rl_tty_set_default_bindings so +that the terminal editing characters are bound to rl_insert. +The bindings are performed in kmap. +

+ +
+
Function: int rl_tty_set_echoing (int value)
+

Set Readline’s idea of whether or not it is +echoing output to its output stream (rl_outstream). +If value is 0, +Readline does not display output to rl_outstream; any other +value enables output. +The initial value is set when Readline initializes the terminal settings. +This function returns the previous value. +

+ +
+
Function: int rl_reset_terminal (const char *terminal_name)
+

Reinitialize Readline’s idea of the terminal settings using +terminal_name as the terminal type (e.g., xterm). +If terminal_name is NULL, Readline uses the value of the +TERM environment variable. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.10 Utility Functions

+ +
+
Function: int rl_save_state (struct readline_state *sp)
+

Save a snapshot of Readline’s internal state to sp. +The contents of the readline_state structure are +documented in readline.h. +The caller is responsible for allocating the structure. +

+ +
+
Function: int rl_restore_state (struct readline_state *sp)
+

Restore Readline’s internal state to that stored in sp, +which must have been saved by a call to rl_save_state. +The contents of the readline_state structure are documented in +readline.h. +The caller is responsible for freeing the structure. +

+ +
+
Function: void rl_free (void *mem)
+

Deallocate the memory pointed to by mem. +mem must have been allocated by malloc. +

+ +
+
Function: void rl_extend_line_buffer (int len)
+

Ensure that rl_line_buffer has enough space to hold len +characters, reallocating it if necessary. +

+ +
+
Function: int rl_initialize (void)
+

Initialize or re-initialize Readline’s internal state. +It’s not strictly necessary to call this; +readline() calls it before reading any input. +

+ +
+
Function: int rl_ding (void)
+

Ring the terminal bell, obeying the setting of bell-style. +

+ +
+
Function: int rl_alphabetic (int c)
+

Return 1 if c is an alphabetic character. +

+ +
+
Function: void rl_display_match_list (char **matches, int len, int max)
+

A convenience function for displaying a list of strings in +columnar format on Readline’s output stream. +matches is the list of strings, in argv format, +such as a list of completion matches. +len is the number of strings in matches, and max +is the length of the longest string in matches. +This function uses the setting of print-completions-horizontally +to select how the matches are displayed (see Readline Init File Syntax). +When displaying completions, this function sets the number of columns used +for display to the value of completion-display-width, the value of +the environment variable COLUMNS, or the screen width, in that order. +

+ +

The following are implemented as macros, defined in chardefs.h. +Applications should refrain from using them. +

+
+
Function: int _rl_uppercase_p (int c)
+

Return 1 if c is an uppercase alphabetic character. +

+ +
+
Function: int _rl_lowercase_p (int c)
+

Return 1 if c is a lowercase alphabetic character. +

+ +
+
Function: int _rl_digit_p (int c)
+

Return 1 if c is a numeric character. +

+ +
+
Function: int _rl_to_upper (int c)
+

If c is a lowercase alphabetic character, return the corresponding +uppercase character. +

+ +
+
Function: int _rl_to_lower (int c)
+

If c is an uppercase alphabetic character, return the corresponding +lowercase character. +

+ +
+
Function: int _rl_digit_value (int c)
+

If c is a number, return the value it represents. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.11 Miscellaneous Functions

+ +
+
Function: int rl_macro_bind (const char *keyseq, const char *macro, Keymap map)
+

Bind the key sequence keyseq to invoke the macro macro. +The binding is performed in map. +When keyseq is invoked, the macro will be inserted into the line. +This function is deprecated; use rl_generic_bind instead. +

+ +
+
Function: void rl_macro_dumper (int readable)
+

Print the key sequences bound to macros and their values, using +the current keymap, to rl_outstream. +If the application has assigned a value to rl_macro_display_hook, +rl_macro_dumper calls it instead of printing anything. +If readable is greater than zero, the list is formatted in such a way +that it can be made part of an inputrc file and re-read. +

+ +
+
Function: int rl_variable_bind (const char *variable, const char *value)
+

Make the Readline variable variable have value. +This behaves as if the Readline command +‘set variable value’ had been executed in an inputrc +file (see Readline Init File Syntax) +or by rl_parse_and_bind. +

+ +
+
Function: char * rl_variable_value (const char *variable)
+

Return a string representing the value of the Readline variable variable. +For boolean variables, this string is either ‘on’ or ‘off’. +

+ +
+
Function: void rl_variable_dumper (int readable)
+

Print the Readline variable names and their current values +to rl_outstream. +If readable is non-zero, the list is formatted in such a way +that it can be made part of an inputrc file and re-read. +

+ +
+ +

Set the time interval (in microseconds) that Readline waits when showing +a balancing character when blink-matching-paren has been enabled. +

+ +
+
Function: char * rl_get_termcap (const char *cap)
+

Retrieve the string value of the termcap capability cap. +Readline fetches the termcap entry for the current terminal name and +uses those capabilities to move around the screen line and perform other +terminal-specific operations, like erasing a line. +Readline does not fetch or use all of a terminal’s capabilities, +and this function will return +values for only those capabilities Readline fetches. +

+ +
+
Function: void rl_reparse_colors (void)
+

Read or re-read color definitions from LS_COLORS. +

+ +
+
Function: void rl_clear_history (void)
+

Clear the history list by deleting all of the entries, in the same manner +as the History library’s clear_history() function. +This differs from clear_history because it frees private data +Readline saves in the history list. +

+ +
+
Function: void rl_activate_mark (void)
+

Enable an active region. +When this is enabled, the text between point and mark (the region) is +displayed using the color specified by the value of the +active-region-start-color variable (a face). +The default face is the terminal’s standout mode. +This is called by various Readline functions that set the mark and insert +text, and is available for applications to call. +

+ +
+
Function: void rl_deactivate_mark (void)
+

Turn off the active region. +

+ +
+
Function: void rl_keep_mark_active (void)
+

Indicate that the mark should remain active when the current Readline +function completes and after redisplay occurs. +In most cases, the mark remains active for only the duration of a single +bindable Readline function. +

+ +
+
Function: int rl_mark_active_p (void)
+

Return a non-zero value if the mark is currently active; zero otherwise. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.12 Alternate Interface

+ +

For applications that need more granular control than +plain readline() provides, there is +an alternate interface. +Some applications need to interleave keyboard I/O with file, device, +or window system I/O, typically by using a main loop to select() +on various file descriptors. +To accommodate this use case, Readline can +also be invoked as a ‘callback’ function from an event loop. +There are functions available to make this easy. +

+
+
Function: void rl_callback_handler_install (const char *prompt, rl_vcpfunc_t *line_handler)
+

Set up the terminal for Readline I/O and display the initial +expanded value of prompt. +Save the value of line_handler to +use as a handler function to call when a complete line of input has been +entered. +The handler function receives the text of the line as an argument. +As with readline(), the handler function should free the +line when it it finished with it. +

+ +
+
Function: void rl_callback_read_char (void)
+

Whenever an application determines that keyboard input is available, it +should call rl_callback_read_char(), which will read the next +character from the current input source. +If that character completes the line, rl_callback_read_char will +invoke the line_handler function installed by +rl_callback_handler_install to process the line. +Before calling the line_handler function, Readline resets +the terminal settings to the values they had before calling +rl_callback_handler_install. +If the line_handler function returns, +and the line handler remains installed, +Readline modifies the terminal settings for its use again. +EOF is indicated by calling line_handler with a +NULL line. +

+ +
+
Function: void rl_callback_sigcleanup (void)
+

Clean up any internal state the callback interface uses to maintain state +between calls to rl_callback_read_char (e.g., the state of any active +incremental searches). +This is intended to be used by applications that +wish to perform their own signal handling; +Readline’s internal signal handler calls this when appropriate. +

+ +
+
Function: void rl_callback_handler_remove (void)
+

Restore the terminal to its initial state and remove the line handler. +You may call this function from within a callback as well as independently. +If the line_handler installed by rl_callback_handler_install +does not exit the program, your program should call +either this function or the function referred +to by the value of rl_deprep_term_function +before the program exits to reset the terminal settings. +

+ +
+
+
+
+

+Next: , Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.13 A Readline Example

+ +

Here is a function which changes lowercase characters to their uppercase +equivalents, and uppercase characters to lowercase. +If this function was bound to ‘M-c’, then typing ‘M-c’ would +change the case of the character under point. +Typing ‘M-1 0 M-c’ would change the case +of the following 10 characters, leaving the cursor on +the last character changed. +

+
+
/* Invert the case of the COUNT following characters. */
+int
+invert_case_line (count, key)
+     int count, key;
+{
+  int start, end, i;
+
+  start = rl_point;
+
+  if (rl_point >= rl_end)
+    return (0);
+
+  /* Find the end of the range to modify. */
+  end = start + count;
+
+  /* Force it to be within range. */
+  if (end > rl_end)
+    end = rl_end;
+  else if (end < 0)
+    end = 0;
+
+  if (start == end)
+    return (0);
+
+  /* For positive arguments, put point after the last changed character. For
+     negative arguments, put point before the last changed character. */
+  rl_point = end;
+
+  /* Swap start and end if we are moving backwards */
+  if (start > end)
+    {
+      int temp = start;
+      start = end;
+      end = temp;
+    }
+
+  /* Tell readline that we are modifying the line,
+     so it will save the undo information. */
+  rl_modifying (start, end);
+
+  for (i = start; i != end; i++)
+    {
+      if (_rl_uppercase_p (rl_line_buffer[i]))
+        rl_line_buffer[i] = _rl_to_lower (rl_line_buffer[i]);
+      else if (_rl_lowercase_p (rl_line_buffer[i]))
+        rl_line_buffer[i] = _rl_to_upper (rl_line_buffer[i]);
+    }
+
+  return (0);
+}
+
+ +
+
+
+
+

+Previous: , Up: Readline Convenience Functions   [Contents][Index]

+
+

2.4.14 Alternate Interface Example

+ +

Here is a complete program that illustrates Readline’s alternate interface. +It reads lines from the terminal and displays them, providing the +standard history and TAB completion functions. +It understands the EOF character or "exit" to exit the program. +

+
+
/* Standard include files. stdio.h is required. */
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+/* Used for select(2) */
+#include <sys/types.h>
+#include <sys/select.h>
+
+#include <signal.h>
+
+#include <errno.h>
+#include <stdio.h>
+
+#include <locale.h>
+
+/* Standard readline include files. */
+#include <readline/readline.h>
+#include <readline/history.h>
+
+#if !defined (errno)
+extern int errno;
+#endif
+
+static void cb_linehandler (char *);
+static void sighandler (int);
+
+int running;
+int sigwinch_received;
+const char *prompt = "rltest$ ";
+
+/* Handle SIGWINCH and window size changes when readline is not active and
+   reading a character. */
+static void
+sighandler (int sig)
+{
+  sigwinch_received = 1;
+}
+
+/* Callback function called for each line when accept-line executed, EOF
+   seen, or EOF character read.  This sets a flag and returns; it could
+   also call exit(3). */
+static void
+cb_linehandler (char *line)
+{
+  /* Can use ^D (stty eof) or `exit' to exit. */
+  if (line == NULL || strcmp (line, "exit") == 0)
+    {
+      if (line == 0)
+        printf ("\n");
+      printf ("exit\n");
+      /* This function needs to be called to reset the terminal settings,
+         and calling it from the line handler keeps one extra prompt from
+         being displayed. */
+      rl_callback_handler_remove ();
+
+      running = 0;
+    }
+  else
+    {
+      if (*line)
+        add_history (line);
+      printf ("input line: %s\n", line);
+      free (line);
+    }
+}
+
+int
+main (int c, char **v)
+{
+  fd_set fds;
+  int r;
+
+  /* Set the default locale values according to environment variables. */
+  setlocale (LC_ALL, "");
+
+  /* Handle window size changes when readline is not active and reading
+     characters. */
+  signal (SIGWINCH, sighandler);
+
+  /* Install the line handler. */
+  rl_callback_handler_install (prompt, cb_linehandler);
+
+  /* Enter a simple event loop.  This waits until something is available
+     to read on readline's input stream (defaults to standard input) and
+     calls the builtin character read callback to read it.  It does not
+     have to modify the user's terminal settings. */
+  running = 1;
+  while (running)
+    {
+      FD_ZERO (&fds);
+      FD_SET (fileno (rl_instream), &fds);
+
+      r = select (FD_SETSIZE, &fds, NULL, NULL, NULL);
+      if (r < 0 && errno != EINTR)
+        {
+          perror ("rltest: select");
+          rl_callback_handler_remove ();
+          break;
+        }
+      if (sigwinch_received)
+	{
+	  rl_resize_terminal ();
+	  sigwinch_received = 0;
+	}
+      if (r < 0)
+	continue;     
+
+      if (FD_ISSET (fileno (rl_instream), &fds))
+        rl_callback_read_char ();
+    }
+
+  printf ("rltest: Event loop has exited\n");
+  return 0;
+}
+
+ +
+
+
+
+
+

+Next: , Previous: , Up: Programming with GNU Readline   [Contents][Index]

+
+

2.5 Readline Signal Handling

+ +

Signals are asynchronous events sent to a process by the Unix kernel, +sometimes on behalf of another process. +They are intended to indicate exceptional events, +like a user pressing the terminal’s interrupt key, +or a network connection being broken. +There is a class of signals that can +be sent to the process currently reading input from the keyboard. +Since Readline changes the terminal attributes when it is called, it needs +to perform special processing when such a signal is received in order to +restore the terminal to a sane state, or provide applications using +Readline with functions to do so manually. +

+

Readline contains an internal signal handler that is installed for a +number of signals (SIGINT, SIGQUIT, SIGTERM, +SIGHUP, +SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU). +When Readline receives one of these signals, the signal handler +will reset the terminal attributes to those that were in effect before +readline() was called, reset the signal handling to what it was +before readline() was called, and resend the signal to the calling +application. +If and when the calling application’s signal handler returns, Readline +will reinitialize the terminal and continue to accept input. +When a SIGINT is received, the Readline signal handler performs +some additional work, which will cause any partially-entered line to be +aborted (see the description of rl_free_line_state() below). +

+

There is an additional Readline signal handler, for SIGWINCH, which +the kernel sends to a process whenever the terminal’s size changes (for +example, if a user resizes an xterm). +The Readline SIGWINCH handler updates +Readline’s internal screen size information, and then calls any +SIGWINCH signal handler the calling application has installed. +Readline calls the application’s SIGWINCH signal handler without +resetting the terminal to its original state. +If the application’s signal +handler does more than update its idea of the terminal size and return +(for example, a longjmp back to a main processing loop), +it must call rl_cleanup_after_signal() (described below), +to restore the terminal state. +

+

When an application is using the callback interface +(see Alternate Interface), Readline installs signal handlers only for +the duration of the call to rl_callback_read_char. +Applications using the callback interface should be prepared +to clean up Readline’s state if they wish to handle the signal +before the line handler completes and restores the terminal state. +

+

If an application using the callback interface wishes to have Readline +install its signal handlers at the time the application calls +rl_callback_handler_install and remove them only when a complete +line of input has been read, it should set the +rl_persistent_signal_handlers variable to a non-zero value. +This allows an application to defer all of the handling of the signals +Readline catches to Readline. +Applications should use this variable with care; it can result in Readline +catching signals and not acting on them (or allowing the application to react +to them) until the application calls rl_callback_read_char. +This can result in an application becoming less responsive to keyboard +signals like SIGINT. +If an application does not want or need to perform any signal handling, or +does not need to do any processing +between calls to rl_callback_read_char, +setting this variable may be appropriate. +

+

Readline provides two variables that allow application writers to +control whether or not it will catch certain signals and act on them +when they are received. +It is important that applications change the +values of these variables only when calling readline(), +not in a signal handler, so Readline’s internal signal state +is not corrupted. +

+
+
Variable: int rl_catch_signals
+

If this variable is non-zero, Readline will install signal handlers for +SIGINT, SIGQUIT, SIGTERM, SIGHUP, SIGALRM, +SIGTSTP, SIGTTIN, and SIGTTOU. +

+

The default value of rl_catch_signals is 1. +

+ +
+
Variable: int rl_catch_sigwinch
+

If this variable is set to a non-zero value, +Readline will install a signal handler for SIGWINCH. +

+

The default value of rl_catch_sigwinch is 1. +

+ +
+
Variable: int rl_persistent_signal_handlers
+

If an application using the callback interface wishes Readline’s signal +handlers to be installed and active during the set of calls to +rl_callback_read_char that constitutes an entire single line, +it should set this variable to a non-zero value. +

+

The default value of rl_persistent_signal_handlers is 0. +

+ +
+
Variable: int rl_change_environment
+

If this variable is set to a non-zero value, +and Readline is handling SIGWINCH, Readline will modify the +LINES and COLUMNS environment variables upon receipt of a +SIGWINCH. +

+

The default value of rl_change_environment is 1. +

+ +

If an application does not wish to have Readline catch any signals, or +to handle signals other than those Readline catches (SIGHUP, +for example), +Readline provides convenience functions to do the necessary terminal +and internal state cleanup upon receipt of a signal. +

+
+
Function: int rl_pending_signal (void)
+

Return the signal number of the most recent signal Readline received but +has not yet handled, or 0 if there is no pending signal. +

+ +
+
Function: void rl_cleanup_after_signal (void)
+

This function will reset the state of the terminal to what it was before +readline() was called, and remove the Readline signal handlers for +all signals, depending on the values of rl_catch_signals and +rl_catch_sigwinch. +

+ +
+
Function: void rl_free_line_state (void)
+

This will free any partial state associated with the current input line +(undo information, any partial history entry, any partially-entered +keyboard macro, and any partially-entered numeric argument). +This should be called before rl_cleanup_after_signal(). +The Readline signal handler for SIGINT calls this to abort +the current input line. +

+ +
+
Function: void rl_reset_after_signal (void)
+

This will reinitialize the terminal and reinstall any Readline signal +handlers, depending on the values of rl_catch_signals and +rl_catch_sigwinch. +

+ +

If an application wants to force Readline to handle any signals that +have arrived while it has been executing, rl_check_signals() +will call Readline’s internal signal handler if there are any pending +signals. +This is primarily intended for those applications that use +a custom rl_getc_function (see Readline Variables) and wish +to handle signals received while waiting for input. +

+
+
Function: void rl_check_signals (void)
+

If there are any pending signals, call Readline’s internal signal +handling functions to process them. +rl_pending_signal() can be used independently +to determine whether or not there are any pending signals. +

+ +

If an application does not wish Readline to catch SIGWINCH, +it may call rl_resize_terminal() or rl_set_screen_size() +to force Readline to update its idea of the terminal size when it receives +a SIGWINCH. +

+
+
Function: void rl_echo_signal_char (int sig)
+

If an application wishes to install its own signal handlers, but still +have Readline display characters that generate signals, calling this +function with sig set to SIGINT, SIGQUIT, or +SIGTSTP will display the character generating that signal. +

+ +
+
Function: void rl_resize_terminal (void)
+

Update Readline’s internal screen size by reading values from the kernel. +

+ +
+
Function: void rl_set_screen_size (int rows, int cols)
+

Set Readline’s idea of the terminal size to rows rows and +cols columns. +If either rows or columns is less than or equal to 0, +Readline doesn’t change that terminal dimension. +This is intended to tell Readline the physical dimensions of the terminal, +and is used internally to calculate the maximum number of characters that +may appear on a single line and on the screen. +

+ +

If an application does not want to install a SIGWINCH handler, but +is still interested in the screen dimensions, it may query Readline’s idea +of the screen size. +

+
+
Function: void rl_get_screen_size (int *rows, int *cols)
+

Return Readline’s idea of the terminal’s size in the +variables pointed to by the arguments. +

+ +
+
Function: void rl_reset_screen_size (void)
+

Cause Readline to reobtain the screen size and recalculate its dimensions. +

+ +

The following functions install and remove Readline’s signal handlers. +

+
+
Function: int rl_set_signals (void)
+

Install Readline’s signal handler for SIGINT, SIGQUIT, +SIGTERM, SIGHUP, SIGALRM, SIGTSTP, SIGTTIN, +SIGTTOU, and SIGWINCH, depending on the values of +rl_catch_signals and rl_catch_sigwinch. +

+ +
+
Function: int rl_clear_signals (void)
+

Remove all of the Readline signal handlers installed by +rl_set_signals(). +

+ +
+
+
+
+

+Previous: , Up: Programming with GNU Readline   [Contents][Index]

+
+

2.6 Custom Completers

+ + +

Typically, a program that reads commands from the user has a way of +disambiguating commands and data. +If your program is one of these, then +it can provide completion for commands, data, or both. +The following sections describe how your program and Readline +cooperate to provide this service. +

+ + +
+
+
+

+Next: , Up: Custom Completers   [Contents][Index]

+
+

2.6.1 How Completing Works

+ +

In order to complete some text, the full list of possible completions +must be available. +That is, it is not possible to accurately +expand a partial word without knowing all of the possible words +which make sense in that context. +The Readline library provides +the user interface to completion, and two of the most common +completion functions: filename and username. +For completing other types +of text, you must write your own completion function. +This section +describes exactly what such functions must do, and provides an example. +

+

There are three major functions used to perform completion: +

+
    +
  1. The user-interface function rl_complete(). +This function is called with the same arguments as other bindable +Readline functions: count and invoking_key. +It isolates the word to be completed and calls +rl_completion_matches() to generate a list of possible completions. +It then either lists the possible completions, inserts the possible +completions, or actually performs the +completion, depending on which behavior is desired. + +
  2. The internal function rl_completion_matches() uses an +application-supplied generator function to generate the list of +possible matches, and then returns the array of these matches. +The caller should place the address of its generator function in +rl_completion_entry_function. + +
  3. The generator function is called repeatedly from +rl_completion_matches(), returning a string each time. +The arguments to the generator function are text and state. +text is the partial word to be completed. +state is zero the first time the function is called, +allowing the generator to perform any necessary initialization, +and a positive integer for each subsequent call. +The generator function returns +(char *)NULL to inform rl_completion_matches() that there are +no more possibilities left. +Usually the generator function computes the +list of possible completions when state is zero, and returns them +one at a time on subsequent calls. +Each string the generator function +returns as a match must be allocated with malloc(); Readline +frees the strings when it has finished with them. +Such a generator function is referred to as an +application-specific completion function. + +
+ +
+
Function: int rl_complete (int ignore, int invoking_key)
+

Complete the word at or before point. +You have supplied the function that does the initial simple matching +selection algorithm (see rl_completion_matches()). +The default is to do filename completion. +

+ +
+
Variable: rl_compentry_func_t * rl_completion_entry_function
+

This is a pointer to the generator function for +rl_completion_matches(). +If the value of rl_completion_entry_function is +NULL then Readline uses the default filename generator +function, rl_filename_completion_function(). +An application-specific completion function is a function whose +address is assigned to rl_completion_entry_function and whose +return values are used to generate possible completions. +

+ +
+
+
+
+

+Next: , Previous: , Up: Custom Completers   [Contents][Index]

+
+

2.6.2 Completion Functions

+ +

Here is the complete list of callable completion functions present in +Readline. +

+
+
Function: int rl_complete_internal (int what_to_do)
+

Complete the word at or before point. +what_to_do says what to do with the completion. +A value of ‘?’ means list the possible completions. +‘TAB’ means do standard completion. +‘*’ means insert all of the possible completions. +‘!’ means to display all of the possible completions, +if there is more than one, as well as performing partial completion. +‘@’ is similar to ‘!’, but does not list possible completions +if the possible completions share a common prefix. +

+ +
+
Function: int rl_complete (int ignore, int invoking_key)
+

Complete the word at or before point. +You have supplied the function that does the initial simple +matching selection algorithm (see rl_completion_matches() and +rl_completion_entry_function). +The default is to do filename completion. +This calls rl_complete_internal() with an +argument depending on invoking_key. +

+ +
+
Function: int rl_possible_completions (int count, int invoking_key)
+

List the possible completions. +See description of rl_complete(). +This calls rl_complete_internal() with an argument of ‘?’. +

+ +
+
Function: int rl_insert_completions (int count, int invoking_key)
+

Insert the list of possible completions into the line, deleting the +partially-completed word. +See description of rl_complete(). +This calls rl_complete_internal() with an argument of ‘*’. +

+ +
+
Function: int rl_completion_mode (rl_command_func_t *cfunc)
+

Returns the appropriate value to pass to rl_complete_internal() +depending on whether cfunc was called twice in succession and +the values of the show-all-if-ambiguous and +show-all-if-unmodified variables. +Application-specific completion functions may use this function to present +the same interface as rl_complete(). +

+ +
+
Function: char ** rl_completion_matches (const char *text, rl_compentry_func_t *entry_func)
+

Returns an array of strings which is a list of completions for text. +If there are no completions, returns NULL. +The first entry in the returned array is the substitution for text. +The remaining entries are the possible completions. +The array is terminated with a NULL pointer. +

+

entry_func is a function of two args, and returns a char *. +The first argument is text. +The second is a state argument; +it is zero on the first call, and non-zero on subsequent calls. +entry_func returns a NULL pointer to the caller +when there are no more matches. +

+ +
+
Function: char * rl_filename_completion_function (const char *text, int state)
+

A generator function for filename completion in the general case. +text is a partial filename. +The Bash source is a useful reference for writing application-specific +completion functions (the Bash completion functions call this and other +Readline functions). +

+ +
+
Function: char * rl_username_completion_function (const char *text, int state)
+

A completion generator for usernames. +text contains a partial username preceded by a +random character (usually ‘~’). +As with all completion generators, +state is zero on the first call and non-zero for subsequent calls. +

+ +
+
+
+
+

+Next: , Previous: , Up: Custom Completers   [Contents][Index]

+
+

2.6.3 Completion Variables

+ +
+
Variable: rl_compentry_func_t * rl_completion_entry_function
+

A pointer to the generator function for rl_completion_matches(). +NULL means to use rl_filename_completion_function(), +the default filename completer. +

+ +
+
Variable: rl_completion_func_t * rl_attempted_completion_function
+

A pointer to an alternative function to create matches. +The function is called with text, start, and end. +start and end are indices in rl_line_buffer defining +the boundaries of text, which is a character string. +If this function exists and returns NULL, or if this variable is +set to NULL, then rl_complete() will call the value of +rl_completion_entry_function to generate matches, otherwise +completion will use the array of strings this function returns. +If this function sets the rl_attempted_completion_over +variable to a non-zero value, Readline will not perform its default +completion even if this function returns no matches. +

+ +
+
Variable: rl_quote_func_t * rl_filename_quoting_function
+

A pointer to a function that will quote a filename in an +application-specific fashion. +Readline calls this function during filename completion +if one of the characters in rl_filename_quote_characters +appears in a completed filename. +The function is called with +text, match_type, and quote_pointer. +The text is the filename to be quoted. +The match_type is either SINGLE_MATCH, +if there is only one completion match, or MULT_MATCH. +Some functions use this to decide whether or not to +insert a closing quote character. +The quote_pointer is a pointer +to any opening quote character the user typed. +Some functions choose to reset this character if they decide to quote +the filename in a different style. +It’s preferable to preserve the user’s quoting as much as possible – +it’s less disruptive. +

+ +
+
Variable: rl_dequote_func_t * rl_filename_dequoting_function
+

A pointer to a function that will remove application-specific quoting +characters from a filename before attempting completion, +so those characters do not interfere with matching the text against +names in the filesystem. +It is called with text, the text of the word +to be dequoted, and quote_char, which is the quoting character +that delimits the filename (usually ‘'’ or ‘"’). +If quote_char is zero, the filename was not in a quoted string. +

+ +
+
Variable: rl_linebuf_func_t * rl_char_is_quoted_p
+

A pointer to a function to call that determines whether or not a specific +character in the line buffer is quoted, according to whatever quoting +mechanism the application uses. +The function is called with two arguments: +text, the text of the line, +and index, the index of the character in the line. +It is used to decide whether a character found in +rl_completer_word_break_characters should be +used to break words for the completer. +

+ +
+
Variable: rl_compignore_func_t * rl_ignore_some_completions_function
+

Readline calls this function, if defined, when filename +completion is done, after all the matching names have been generated. +It is passed a NULL terminated array of matches. +The first element (matches[0]) is the maximal substring +common to all matches. +This function can re-arrange the list of matches as required, but +must free each element it deletes from the array. +

+ +
+
Variable: rl_icppfunc_t * rl_directory_completion_hook
+

This function, if defined, is allowed to modify the directory portion +of filenames during completion. +It could be used to expand symbolic links or shell variables in pathnames. +It is called with the address of a string (the current directory name) as an +argument, and may modify that string. +If the function replaces the string with a new string, it +should free the old value. +Any modified directory name should have a trailing slash. +The modified value will be used as part of the completion, replacing +the directory portion of the pathname the user typed. +At the least, even if no other expansion is performed, this function should +remove any quote characters from the directory name, because its result will +be passed directly to opendir(). +

+

The directory completion hook returns an integer that should be non-zero if +the function modifies its directory argument. +The function should not modify the directory argument if it returns 0. +

+ +
+
Variable: rl_icppfunc_t * rl_directory_rewrite_hook;
+

If non-zero, this is the address of a function to call when completing +a directory name. +This function takes the address of the directory name +to be modified as an argument. +Unlike rl_directory_completion_hook, +it only modifies the directory name used in opendir(), +not what Readline displays when it prints or inserts +the possible completions. +Readline calls this before rl_directory_completion_hook. +At the least, even if no other expansion is performed, this function should +remove any quote characters from the directory name, because its result will +be passed directly to opendir(). +

+

The directory rewrite hook returns an integer that should be non-zero if +the function modifies its directory argument. +The function should not modify the directory argument if it returns 0. +

+ +
+
Variable: rl_icppfunc_t * rl_filename_stat_hook
+

If non-zero, this is the address of a function for the completer to +call before deciding which character to append to a completed name. +This function modifies its filename name argument, and Readline passes +the modified value to stat() +to determine the file’s type and characteristics. +This function does not need to remove quote characters from the filename. +

+

The stat hook returns an integer that should be non-zero if +the function modifies its directory argument. +The function should not modify the directory argument if it returns 0. +

+ +
+
Variable: rl_dequote_func_t * rl_filename_rewrite_hook
+

If non-zero, this is the address of a function +for Readline to call when reading +directory entries from the filesystem for completion and comparing +them to the filename portion of the partial word being completed. +It modifies the filesystem entries, +as opposed to rl_completion_rewrite_hook, +which modifies the word being completed. +The function takes two arguments: +fname, the filename to be converted, +and fnlen, its length in bytes. +It must either return its first argument (if no conversion takes place) +or the converted filename in newly-allocated memory. +The function should perform any necessary application or system-specific +conversion on the filename, such as converting between character sets +or converting from a filesystem format to a character input format. +Readline compares the converted form against the word to be completed, +and, if it matches, adds it to the list of matches. +Readline will free the allocated string. +

+ +
+
Variable: rl_dequote_func_t * rl_completion_rewrite_hook
+

If non-zero, this is the address of a function +for Readline to call before +comparing the filename portion of a word to be completed with directory +entries from the filesystem. +It modifies the word being completed, +as opposed to rl_filename_rewrite_hook, +which modifies filesystem entries. +The function takes two arguments: +fname, the word to be converted, +after any rl_filename_dequoting_function has been applied, +and fnlen, its length in bytes. +It must either return its first argument (if no conversion takes place) +or the converted filename in newly-allocated memory. +The function should perform any necessary application or system-specific +conversion on the filename, such as converting between character sets or +converting from a character input format to some other format. +Readline compares the converted form against directory entries, after +their potential modification by rl_filename_rewrite_hook, +and adds any matches to the list of matches. +Readline will free the allocated string. +

+ +
+
Variable: rl_compdisp_func_t * rl_completion_display_matches_hook
+

If non-zero, then this is the address of a function to call when +completing a word would normally display the list of possible matches. +Readline calls this function instead of displaying the list itself. +It takes three arguments: +(char **matches, int num_matches, int max_length) +where matches is the array of matching strings, +num_matches is the number of strings in that array, and +max_length is the length of the longest string in that array. +Readline provides a convenience function, rl_display_match_list, +that takes care of doing the display to Readline’s output stream. +You may call that function from this hook. +

+ +
+
Variable: const char * rl_basic_word_break_characters
+

The basic list of characters that signal a break between words for the +completer routine. +The default value of this variable is the characters +which break words for completion in Bash: +" \t\n\"\\'`@$><=;|&{(". +

+ +
+
Variable: const char * rl_basic_quote_characters
+

A list of quote characters which can cause a word break. +The default value includes single and double quotes. +

+ +
+
Variable: const char * rl_completer_word_break_characters
+

The list of characters that signal a break between words for +rl_complete_internal(). +These characters determine how Readline decides what to complete. +The default list is the value of +rl_basic_word_break_characters. +

+ +
+
Variable: rl_cpvfunc_t * rl_completion_word_break_hook
+

If non-zero, this is the address of a function to call when Readline is +deciding where to separate words for word completion. +It should return a character string like +rl_completer_word_break_characters to be +used to perform the current completion. +The function may choose to set +rl_completer_word_break_characters itself. +If the function returns NULL, Readline uses +rl_completer_word_break_characters. +

+ +
+
Variable: const char * rl_completer_quote_characters
+

A list of characters which can be used to quote a substring of the line. +Completion occurs on the entire substring, and within the substring, +rl_completer_word_break_characters are treated as any other character, +unless they also appear within this list. +

+ +
+
Variable: const char * rl_filename_quote_characters
+

A list of characters that cause Readline to quote a filename +when they appear in a completed filename. +The default is the null string. +

+ +
+
Variable: const char * rl_special_prefixes
+

The list of characters that are word break characters, but should be +left in text when it is passed to the completion function. +Programs can use this to help determine what kind of completing to do. +For instance, Bash sets this variable to "$@" so that it can complete +shell variables and hostnames. +

+ +
+
Variable: int rl_completion_query_items
+

This determines the maximum number of items +that possible-completions will display unconditionally. +If there are more possible completions than this, +Readline asks the user for confirmation before displaying them. +The default value is 100. +A negative value +indicates that Readline should never ask for confirmation. +

+ +
+
Variable: int rl_completion_append_character
+

When a single completion alternative matches at the end of the command +line, Readline appends this character to the inserted completion text. +The default is a space character (‘ ’). +Setting this to the null +character (‘\0’) prevents anything being appended automatically. +This can be changed in application-specific completion functions to +provide the “most sensible word separator character” according to +an application-specific command line syntax specification. +It is set to the default before calling any application-specific completion +function, and may only be changed within such a function. +

+ +
+
Variable: int rl_completion_suppress_append
+

If non-zero, Readline will not append the +rl_completion_append_character to +matches at the end of the command line, as described above. +It is set to 0 before calling any application-specific completion function, +and may only be changed within such a function. +

+ +
+
Variable: int rl_completion_suppress_quote
+

If non-zero, Readline does not append a matching quote character when +performing completion on a quoted string. +It is set to 0 before calling any application-specific completion function, +and may only be changed within such a function. +

+ +
+
Variable: int rl_completion_found_quote
+

When Readline is completing quoted text, it sets this variable +to a non-zero value if the word being completed contains or is delimited +by any quoting characters, including backslashes. +This is set before calling any application-specific completion function. +

+ +
+
Variable: int rl_completion_quote_character
+

When Readline is completing quoted text, as delimited by one of the +characters in rl_completer_quote_characters, it sets this variable +to the quoting character it found. +This is set before calling any application-specific completion function. +

+ +
+ +

If non-zero, Readline appends a slash to completed filenames that are +symbolic links to directory names, subject to the value of the +user-settable mark-directories variable. +This variable exists so that application-specific completion functions +can override the user’s global preference (set via the +mark-symlinked-directories Readline variable) if appropriate. +This variable is set to the user’s preference before calling any +application-specific completion function, +so unless that function modifies the value, +Readline will honor the user’s preferences. +

+ +
+
Variable: int rl_ignore_completion_duplicates
+

If non-zero, then Readline removes duplicates in the set of possible +completions. +The default is 1. +

+ +
+
Variable: int rl_filename_completion_desired
+

A non-zero value means that Readline should treat the results of the +matches as filenames. +This is always zero when completion is attempted, +and can only be changed +within an application-specific completion function. +If it is set to a +non-zero value by such a function, Readline +appends a slash to directory names +and attempts to quote completed filenames if they contain any +characters in rl_filename_quote_characters and +rl_filename_quoting_desired is set to a non-zero value. +

+ +
+
Variable: int rl_filename_quoting_desired
+

A non-zero value means that Readline should quote the results of the +matches using double quotes (or an application-specific quoting mechanism) +if the completed filename contains any characters in +rl_filename_quote_chars. +This is always non-zero when completion is attempted, +and can only be changed within an +application-specific completion function. +The quoting is performed via a call to the function pointed to +by rl_filename_quoting_function. +

+ +
+
Variable: int rl_full_quoting_desired
+

A non-zero value means that Readline should apply filename-style quoting, +including any application-specified quoting mechanism, +to all completion matches even if it is not otherwise treating the +matches as filenames. +This is always zero when completion is attempted, +and can only be changed within an +application-specific completion function. +The quoting is performed via a call to the function pointed to +by rl_filename_quoting_function. +

+ +
+
Variable: int rl_attempted_completion_over
+

If an application-specific completion function assigned to +rl_attempted_completion_function sets this variable to a non-zero +value, Readline will not perform its default filename completion even +if the application’s completion function returns no matches. +It should be set only by an application’s completion function. +

+ +
+
Variable: int rl_sort_completion_matches
+

If an application sets this variable to 0, Readline will not sort the +list of completions (which implies that it cannot remove any duplicate +completions). +The default value is 1, which means that Readline will +sort the completions and, depending on the value of +rl_ignore_completion_duplicates, will attempt to remove +duplicate matches. +

+ +
+
Variable: int rl_completion_type
+

Set to a character describing the type of completion Readline is currently +attempting; see the description of rl_complete_internal() +(see Completion Functions) for the list of characters. +This is set to the appropriate value before calling +any application-specific completion function, +so these functions can present +the same interface as rl_complete(). +

+ +
+
Variable: int rl_completion_invoking_key
+

Set to the final character in the key sequence that invoked one of the +completion functions that call rl_complete_internal(). +This is set to the appropriate value before calling +any application-specific completion function. +

+ +
+
Variable: int rl_inhibit_completion
+

If this variable is non-zero, Readline does not perform completion, +even if a key binding indicates it should. +The completion character +is inserted as if it were bound to self-insert. +

+ +
+
+
+
+

+Previous: , Up: Custom Completers   [Contents][Index]

+
+

2.6.4 A Short Completion Example

+ +

Here is a small application demonstrating the use of the GNU Readline +library. +It is called fileman, and the source code resides in +examples/fileman.c. +This sample application provides +command name completion, line editing features, +and access to the history list. +

+
+
/* fileman.c -- A tiny application which demonstrates how to use the
+   GNU Readline library.  This application interactively allows users
+   to manipulate files and their modes. */
+
+#ifdef HAVE_CONFIG_H
+#  include <config.h>
+#endif
+
+#include <sys/types.h>
+#ifdef HAVE_SYS_FILE_H
+#  include <sys/file.h>
+#endif
+#include <sys/stat.h>
+
+#ifdef HAVE_UNISTD_H
+#  include <unistd.h>
+#endif
+
+#include <fcntl.h>
+#include <stdio.h>
+#include <errno.h>
+#include <locale.h>
+
+#if defined (HAVE_STRING_H)
+#  include <string.h>
+#else /* !HAVE_STRING_H */
+#  include <strings.h>
+#endif /* !HAVE_STRING_H */
+
+#ifdef HAVE_STDLIB_H
+#  include <stdlib.h>
+#endif
+
+#include <time.h>
+
+#include <readline/readline.h>
+#include <readline/history.h>
+
+extern char *xmalloc PARAMS((size_t));
+
+/* The names of functions that actually do the manipulation. */
+int com_list PARAMS((char *));
+int com_view PARAMS((char *));
+int com_rename PARAMS((char *));
+int com_stat PARAMS((char *));
+int com_pwd PARAMS((char *));
+int com_delete PARAMS((char *));
+int com_help PARAMS((char *));
+int com_cd PARAMS((char *));
+int com_quit PARAMS((char *));
+
+/* A structure which contains information on the commands this program
+   can understand. */
+
+typedef struct {
+  char *name;			/* User printable name of the function. */
+  rl_icpfunc_t *func;		/* Function to call to do the job. */
+  char *doc;			/* Documentation for this function.  */
+} COMMAND;
+
+COMMAND commands[] = {
+  { "cd", com_cd, "Change to directory DIR" },
+  { "delete", com_delete, "Delete FILE" },
+  { "help", com_help, "Display this text" },
+  { "?", com_help, "Synonym for `help'" },
+  { "list", com_list, "List files in DIR" },
+  { "ls", com_list, "Synonym for `list'" },
+  { "pwd", com_pwd, "Print the current working directory" },
+  { "quit", com_quit, "Quit using Fileman" },
+  { "rename", com_rename, "Rename FILE to NEWNAME" },
+  { "stat", com_stat, "Print out statistics on FILE" },
+  { "view", com_view, "View the contents of FILE" },
+  { (char *)NULL, (rl_icpfunc_t *)NULL, (char *)NULL }
+};
+
+/* Forward declarations. */
+char *stripwhite (char *);
+COMMAND *find_command (char *);
+
+/* The name of this program, as taken from argv[0]. */
+char *progname;
+
+/* When non-zero, this global means the user is done using this program. */
+int done;
+
+char *
+dupstr (char *s)
+{
+  char *r;
+
+  r = xmalloc (strlen (s) + 1);
+  strcpy (r, s);
+  return (r);
+}
+
+int
+main (int argc, char **argv)
+{
+  char *line, *s;
+
+  setlocale (LC_ALL, "");
+
+  progname = argv[0];
+
+  initialize_readline ();	/* Bind our completer. */
+
+  /* Loop reading and executing lines until the user quits. */
+  for ( ; done == 0; )
+    {
+      line = readline ("FileMan: ");
+
+      if (!line)
+        break;
+
+      /* Remove leading and trailing whitespace from the line.
+         Then, if there is anything left, add it to the history list
+         and execute it. */
+      s = stripwhite (line);
+
+      if (*s)
+        {
+          add_history (s);
+          execute_line (s);
+        }
+
+      free (line);
+    }
+  exit (0);
+}
+
+/* Execute a command line. */
+int
+execute_line (char *line)
+{
+  register int i;
+  COMMAND *command;
+  char *word;
+
+  /* Isolate the command word. */
+  i = 0;
+  while (line[i] && whitespace (line[i]))
+    i++;
+  word = line + i;
+
+  while (line[i] && !whitespace (line[i]))
+    i++;
+
+  if (line[i])
+    line[i++] = '\0';
+
+  command = find_command (word);
+
+  if (!command)
+    {
+      fprintf (stderr, "%s: No such command for FileMan.\n", word);
+      return (-1);
+    }
+
+  /* Get argument to command, if any. */
+  while (whitespace (line[i]))
+    i++;
+
+  word = line + i;
+
+  /* Call the function. */
+  return ((*(command->func)) (word));
+}
+
+/* Look up NAME as the name of a command, and return a pointer to that
+   command.  Return a NULL pointer if NAME isn't a command name. */
+COMMAND *
+find_command (char *name)
+{
+  register int i;
+
+  for (i = 0; commands[i].name; i++)
+    if (strcmp (name, commands[i].name) == 0)
+      return (&commands[i]);
+
+  return ((COMMAND *)NULL);
+}
+
+/* Strip whitespace from the start and end of STRING.  Return a pointer
+   into STRING. */
+char *
+stripwhite (char *string)
+{
+  register char *s, *t;
+
+  for (s = string; whitespace (*s); s++)
+    ;
+    
+  if (*s == 0)
+    return (s);
+
+  t = s + strlen (s) - 1;
+  while (t > s && whitespace (*t))
+    t--;
+  *++t = '\0';
+
+  return s;
+}
+
+/* **************************************************************** */
+/*                                                                  */
+/*                  Interface to Readline Completion                */
+/*                                                                  */
+/* **************************************************************** */
+
+char *command_generator (const char *, int);
+char **fileman_completion (const char *, int, int);
+
+/* Tell the GNU Readline library how to complete.  We want to try to complete
+   on command names if this is the first word in the line, or on filenames
+   if not. */
+void
+initialize_readline (void)
+{
+  /* Allow conditional parsing of the ~/.inputrc file. */
+  rl_readline_name = "FileMan";
+
+  /* Tell the completer that we want a crack first. */
+  rl_attempted_completion_function = fileman_completion;
+}
+
+/* Attempt to complete on the contents of TEXT.  START and END bound the
+   region of rl_line_buffer that contains the word to complete.  TEXT is
+   the word to complete.  We can use the entire contents of rl_line_buffer
+   in case we want to do some simple parsing.  Return the array of matches,
+   or NULL if there aren't any. */
+char **
+fileman_completion (const char *text, int start, int end)
+{
+  char **matches;
+
+  matches = (char **)NULL;
+
+  /* If this word is at the start of the line, then it is a command
+     to complete.  Otherwise it is the name of a file in the current
+     directory. */
+  if (start == 0)
+    matches = rl_completion_matches (text, command_generator);
+
+  return (matches);
+}
+
+/* Generator function for command completion.  STATE lets us know whether
+   to start from scratch; without any state (i.e. STATE == 0), then we
+   start at the top of the list. */
+char *
+command_generator (const char *text, int state)
+{
+  static int list_index, len;
+  char *name;
+
+  /* If this is a new word to complete, initialize now.  This includes
+     saving the length of TEXT for efficiency, and initializing the index
+     variable to 0. */
+  if (!state)
+    {
+      list_index = 0;
+      len = strlen (text);
+    }
+
+  /* Return the next name which partially matches from the command list. */
+  while (name = commands[list_index].name)
+    {
+      list_index++;
+
+      if (strncmp (name, text, len) == 0)
+        return (dupstr(name));
+    }
+
+  /* If no names matched, then return NULL. */
+  return ((char *)NULL);
+}
+
+/* **************************************************************** */
+/*                                                                  */
+/*                       FileMan Commands                           */
+/*                                                                  */
+/* **************************************************************** */
+
+/* String to pass to system ().  This is for the LIST, VIEW and RENAME
+   commands. */
+static char syscom[1024];
+
+/* List the file(s) named in arg. */
+int
+com_list (char *arg)
+{
+  if (!arg)
+    arg = "";
+
+  snprintf (syscom, sizeof (syscom), "ls -FClg %s", arg);
+  return (system (syscom));
+}
+
+int
+com_view (char *arg)
+{
+  if (!valid_argument ("view", arg))
+    return 1;
+
+#if defined (__MSDOS__)
+  /* more.com doesn't grok slashes in pathnames */
+  snprintf (syscom, sizeof (syscom), "less %s", arg);
+#else
+  snprintf (syscom, sizeof (syscom), "more %s", arg);
+#endif
+  return (system (syscom));
+}
+
+int
+com_rename (char *arg)
+{
+  too_dangerous ("rename");
+  return (1);
+}
+
+int
+com_stat (char *arg)
+{
+  struct stat finfo;
+
+  if (!valid_argument ("stat", arg))
+    return (1);
+
+  if (stat (arg, &finfo) == -1)
+    {
+      perror (arg);
+      return (1);
+    }
+
+  printf ("Statistics for `%s':\n", arg);
+
+  printf ("%s has %d link%s, and is %d byte%s in length.\n",
+	  arg,
+          finfo.st_nlink,
+          (finfo.st_nlink == 1) ? "" : "s",
+          finfo.st_size,
+          (finfo.st_size == 1) ? "" : "s");
+  printf ("Inode Last Change at: %s", ctime (&finfo.st_ctime));
+  printf ("      Last access at: %s", ctime (&finfo.st_atime));
+  printf ("    Last modified at: %s", ctime (&finfo.st_mtime));
+  return (0);
+}
+
+int
+com_delete (char *arg)
+{
+  too_dangerous ("delete");
+  return (1);
+}
+
+/* Print out help for ARG, or for all of the commands if ARG is
+   not present. */
+int
+com_help (char *arg)
+{
+  register int i;
+  int printed = 0;
+
+  for (i = 0; commands[i].name; i++)
+    {
+      if (!*arg || (strcmp (arg, commands[i].name) == 0))
+        {
+          printf ("%s\t\t%s.\n", commands[i].name, commands[i].doc);
+          printed++;
+        }
+    }
+
+  if (!printed)
+    {
+      printf ("No commands match `%s'.  Possibilities are:\n", arg);
+
+      for (i = 0; commands[i].name; i++)
+        {
+          /* Print in six columns. */
+          if (printed == 6)
+            {
+              printed = 0;
+              printf ("\n");
+            }
+
+          printf ("%s\t", commands[i].name);
+          printed++;
+        }
+
+      if (printed)
+        printf ("\n");
+    }
+  return (0);
+}
+
+/* Change to the directory ARG. */
+int
+com_cd (char *arg)
+{
+  if (chdir (arg) == -1)
+    {
+      perror (arg);
+      return 1;
+    }
+
+  com_pwd ("");
+  return (0);
+}
+
+/* Print out the current working directory. */
+int
+com_pwd (char *ignore)
+{
+  char dir[1024], *s;
+
+  s = getcwd (dir, sizeof(dir) - 1);
+  if (s == 0)
+    {
+      printf ("Error getting pwd: %s\n", dir);
+      return 1;
+    }
+
+  printf ("Current directory is %s\n", dir);
+  return 0;
+}
+
+/* The user wishes to quit using this program.  Just set DONE non-zero. */
+int
+com_quit (char *arg)
+{
+  done = 1;
+  return (0);
+}
+
+/* Function which tells you that you can't do this. */
+void
+too_dangerous (char *caller)
+{
+  fprintf (stderr,
+           "%s: Too dangerous for me to distribute.  Write it yourself.\n",
+           caller);
+}
+
+/* Return non-zero if ARG is a valid argument for CALLER, else print
+   an error message and return zero. */
+int
+valid_argument (char *caller, char *arg)
+{
+  if (!arg || !*arg)
+    {
+      fprintf (stderr, "%s: Argument required.\n", caller);
+      return (0);
+    }
+
+  return (1);
+}
+
+ +
+
+
+
+
+
+

+Next: , Previous: , Up: GNU Readline Library   [Contents][Index]

+
+

Appendix A GNU Free Documentation License

+ +
Version 1.3, 3 November 2008 +
+ +
+
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+http://fsf.org/
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+ +
    +
  1. PREAMBLE + +

    The purpose of this License is to make a manual, textbook, or other +functional and useful document free in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. +

    +

    This License is a kind of “copyleft”, which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. +

    +

    We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. +

    +
  2. APPLICABILITY AND DEFINITIONS + +

    This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The “Document”, below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as “you”. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. +

    +

    A “Modified Version” of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. +

    +

    A “Secondary Section” is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document’s overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. +

    +

    The “Invariant Sections” are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. +

    +

    The “Cover Texts” are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. +

    +

    A “Transparent” copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not “Transparent” is called “Opaque”. +

    +

    Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. +

    +

    The “Title Page” means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, “Title Page” means +the text near the most prominent appearance of the work’s title, +preceding the beginning of the body of the text. +

    +

    The “publisher” means any person or entity that distributes copies +of the Document to the public. +

    +

    A section “Entitled XYZ” means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as “Acknowledgements”, +“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” +of such a section when you modify the Document means that it remains a +section “Entitled XYZ” according to this definition. +

    +

    The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. +

    +
  3. VERBATIM COPYING + +

    You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. +

    +

    You may also lend copies, under the same conditions stated above, and +you may publicly display copies. +

    +
  4. COPYING IN QUANTITY + +

    If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document’s license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. +

    +

    If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. +

    +

    If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. +

    +

    It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. +

    +
  5. MODIFICATIONS + +

    You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: +

    +
      +
    1. Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +
    2. List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +
    3. State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +
    4. Preserve all the copyright notices of the Document. + +
    5. Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +
    6. Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +
    7. Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document’s license notice. + +
    8. Include an unaltered copy of this License. + +
    9. Preserve the section Entitled “History”, Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled “History” in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +
    10. Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the “History” section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +
    11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +
    12. Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +
    13. Delete any section Entitled “Endorsements”. Such a section +may not be included in the Modified Version. + +
    14. Do not retitle any existing section to be Entitled “Endorsements” or +to conflict in title with any Invariant Section. + +
    15. Preserve any Warranty Disclaimers. +
    + +

    If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version’s license notice. +These titles must be distinct from any other section titles. +

    +

    You may add a section Entitled “Endorsements”, provided it contains +nothing but endorsements of your Modified Version by various +parties—for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. +

    +

    You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. +

    +

    The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. +

    +
  6. COMBINING DOCUMENTS + +

    You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. +

    +

    The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. +

    +

    In the combination, you must combine any sections Entitled “History” +in the various original documents, forming one section Entitled +“History”; likewise combine any sections Entitled “Acknowledgements”, +and any sections Entitled “Dedications”. You must delete all +sections Entitled “Endorsements.” +

    +
  7. COLLECTIONS OF DOCUMENTS + +

    You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. +

    +

    You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. +

    +
  8. AGGREGATION WITH INDEPENDENT WORKS + +

    A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an “aggregate” if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation’s users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. +

    +

    If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document’s Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. +

    +
  9. TRANSLATION + +

    Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. +

    +

    If a section in the Document is Entitled “Acknowledgements”, +“Dedications”, or “History”, the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. +

    +
  10. TERMINATION + +

    You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. +

    +

    However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. +

    +

    Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. +

    +

    Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. +

    +
  11. FUTURE REVISIONS OF THIS LICENSE + +

    The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +http://www.gnu.org/copyleft/. +

    +

    Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License “or any later version” applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy’s public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. +

    +
  12. RELICENSING + +

    “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +“Massive Multiauthor Collaboration” (or “MMC”) contained in the +site means any set of copyrightable works thus published on the MMC +site. +

    +

    “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. +

    +

    “Incorporate” means to publish or republish a Document, in whole or +in part, as part of another Document. +

    +

    An MMC is “eligible for relicensing” if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. +

    +

    The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. +

    +
+ +

ADDENDUM: How to use this License for your documents

+ +

To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: +

+
+
  Copyright (C)  year  your name.
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.3
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+  Texts.  A copy of the license is included in the section entitled ``GNU
+  Free Documentation License''.
+
+ +

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the “with…Texts.” line with this: +

+
+
    with the Invariant Sections being list their titles, with
+    the Front-Cover Texts being list, and with the Back-Cover Texts
+    being list.
+
+ +

If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. +

+

If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. +

+ + +
+
+ +
+
+

+Previous: , Up: GNU Readline Library   [Contents][Index]

+
+

Function and Variable Index

+
+
Jump to:   _ +   +
+A +   +B +   +C +   +D +   +E +   +F +   +H +   +I +   +K +   +M +   +N +   +O +   +P +   +Q +   +R +   +S +   +T +   +U +   +V +   +Y +   +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index EntrySection
_
_rl_digit_pUtility Functions
_rl_digit_valueUtility Functions
_rl_lowercase_pUtility Functions
_rl_to_lowerUtility Functions
_rl_to_upperUtility Functions
_rl_uppercase_pUtility Functions
A
abort (C-g)Miscellaneous Commands
accept-line (Newline or Return)Commands For History
active-region-end-colorReadline Init File Syntax
active-region-start-colorReadline Init File Syntax
B
backward-char (C-b)Commands For Moving
backward-delete-char (Rubout)Commands For Text
backward-kill-line (C-x Rubout)Commands For Killing
backward-kill-word (M-DEL)Commands For Killing
backward-word (M-b)Commands For Moving
beginning-of-history (M-<)Commands For History
beginning-of-line (C-a)Commands For Moving
bell-styleReadline Init File Syntax
bind-tty-special-charsReadline Init File Syntax
blink-matching-parenReadline Init File Syntax
bracketed-paste-begin ()Commands For Text
C
call-last-kbd-macro (C-x e)Keyboard Macros
capitalize-word (M-c)Commands For Text
character-search (C-])Miscellaneous Commands
character-search-backward (M-C-])Miscellaneous Commands
clear-display (M-C-l)Commands For Moving
clear-screen (C-l)Commands For Moving
colored-completion-prefixReadline Init File Syntax
colored-statsReadline Init File Syntax
comment-beginReadline Init File Syntax
complete (TAB)Commands For Completion
completion-display-widthReadline Init File Syntax
completion-ignore-caseReadline Init File Syntax
completion-map-caseReadline Init File Syntax
completion-prefix-display-lengthReadline Init File Syntax
completion-query-itemsReadline Init File Syntax
convert-metaReadline Init File Syntax
copy-backward-word ()Commands For Killing
copy-forward-word ()Commands For Killing
copy-region-as-kill ()Commands For Killing
D
delete-char (C-d)Commands For Text
delete-char-or-list ()Commands For Completion
delete-horizontal-space ()Commands For Killing
digit-argument (M-0, M-1, … M--)Numeric Arguments
disable-completionReadline Init File Syntax
do-lowercase-version (M-A, M-B, M-x, …)Miscellaneous Commands
downcase-word (M-l)Commands For Text
dump-functions ()Miscellaneous Commands
dump-macros ()Miscellaneous Commands
dump-variables ()Miscellaneous Commands
E
echo-control-charactersReadline Init File Syntax
editing-modeReadline Init File Syntax
emacs-editing-mode (C-e)Miscellaneous Commands
emacs-mode-stringReadline Init File Syntax
enable-active-region TheReadline Init File Syntax
enable-bracketed-pasteReadline Init File Syntax
enable-keypadReadline Init File Syntax
enable-meta-keyReadline Init File Syntax
end-kbd-macro (C-x ))Keyboard Macros
end-of-file (usually C-d)Commands For Text
end-of-history (M->)Commands For History
end-of-line (C-e)Commands For Moving
exchange-point-and-mark (C-x C-x)Miscellaneous Commands
execute-named-command (M-x)Miscellaneous Commands
expand-tildeReadline Init File Syntax
export-completions ()Commands For Completion
F
fetch-history ()Commands For History
force-meta-prefixReadline Init File Syntax
forward-backward-delete-char ()Commands For Text
forward-char (C-f)Commands For Moving
forward-search-history (C-s)Commands For History
forward-word (M-f)Commands For Moving
H
history-preserve-pointReadline Init File Syntax
history-search-backward ()Commands For History
history-search-forward ()Commands For History
history-sizeReadline Init File Syntax
history-substring-search-backward ()Commands For History
history-substring-search-forward ()Commands For History
horizontal-scroll-modeReadline Init File Syntax
I
input-metaReadline Init File Syntax
insert-comment (M-#)Miscellaneous Commands
insert-completions (M-*)Commands For Completion
isearch-terminatorsReadline Init File Syntax
K
keymapReadline Init File Syntax
kill-line (C-k)Commands For Killing
kill-region ()Commands For Killing
kill-whole-line ()Commands For Killing
kill-word (M-d)Commands For Killing
M
mark-modified-linesReadline Init File Syntax
mark-symlinked-directoriesReadline Init File Syntax
match-hidden-filesReadline Init File Syntax
menu-complete ()Commands For Completion
menu-complete-backward ()Commands For Completion
menu-complete-display-prefixReadline Init File Syntax
meta-flagReadline Init File Syntax
N
next-history (C-n)Commands For History
next-screen-line ()Commands For Moving
non-incremental-forward-search-history (M-n)Commands For History
non-incremental-reverse-search-history (M-p)Commands For History
O
operate-and-get-next (C-o)Commands For History
output-metaReadline Init File Syntax
overwrite-mode ()Commands For Text
P
page-completionsReadline Init File Syntax
possible-completions (M-?)Commands For Completion
prefix-meta (ESC)Miscellaneous Commands
previous-history (C-p)Commands For History
previous-screen-line ()Commands For Moving
print-last-kbd-macro ()Keyboard Macros
Q
quoted-insert (C-q or C-v)Commands For Text
R
re-read-init-file (C-x C-r)Miscellaneous Commands
readlineBasic Behavior
redraw-current-line ()Commands For Moving
reverse-search-history (C-r)Commands For History
revert-all-at-newlineReadline Init File Syntax
revert-line (M-r)Miscellaneous Commands
rl_activate_markMiscellaneous Functions
rl_add_defunFunction Naming
rl_add_funmap_entryAssociating Function Names and Bindings
rl_add_undoAllowing Undoing
rl_alphabeticUtility Functions
rl_already_promptedReadline Variables
rl_attempted_completion_functionCompletion Variables
rl_attempted_completion_overCompletion Variables
rl_basic_quote_charactersCompletion Variables
rl_basic_word_break_charactersCompletion Variables
rl_begin_undo_groupAllowing Undoing
rl_bind_keyBinding Keys
rl_bind_key_if_unboundBinding Keys
rl_bind_key_if_unbound_in_mapBinding Keys
rl_bind_key_in_mapBinding Keys
rl_bind_keyseqBinding Keys
rl_bind_keyseq_if_unboundBinding Keys
rl_bind_keyseq_if_unbound_in_mapBinding Keys
rl_bind_keyseq_in_mapBinding Keys
rl_binding_keymapReadline Variables
rl_callback_handler_installAlternate Interface
rl_callback_handler_removeAlternate Interface
rl_callback_read_charAlternate Interface
rl_callback_sigcleanupAlternate Interface
rl_catch_signalsReadline Signal Handling
rl_catch_sigwinchReadline Signal Handling
rl_change_environmentReadline Signal Handling
rl_char_is_quoted_pCompletion Variables
rl_check_signalsReadline Signal Handling
rl_cleanup_after_signalReadline Signal Handling
rl_clear_historyMiscellaneous Functions
rl_clear_messageRedisplay
rl_clear_pending_inputCharacter Input
rl_clear_signalsReadline Signal Handling
rl_clear_visible_lineRedisplay
rl_completeHow Completing Works
rl_completeCompletion Functions
rl_complete_internalCompletion Functions
rl_completer_quote_charactersCompletion Variables
rl_completer_word_break_charactersCompletion Variables
rl_completion_append_characterCompletion Variables
rl_completion_display_matches_hookCompletion Variables
rl_completion_entry_functionHow Completing Works
rl_completion_entry_functionCompletion Variables
rl_completion_found_quoteCompletion Variables
rl_completion_invoking_keyCompletion Variables
rl_completion_mark_symlink_dirsCompletion Variables
rl_completion_matchesCompletion Functions
rl_completion_modeCompletion Functions
rl_completion_query_itemsCompletion Variables
rl_completion_quote_characterCompletion Variables
rl_completion_rewrite_hookCompletion Variables
rl_completion_suppress_appendCompletion Variables
rl_completion_suppress_quoteCompletion Variables
rl_completion_typeCompletion Variables
rl_completion_word_break_hookCompletion Variables
rl_copy_keymapKeymaps
rl_copy_textModifying Text
rl_crlfRedisplay
rl_deactivate_markMiscellaneous Functions
rl_delete_textModifying Text
rl_deprep_term_functionReadline Variables
rl_deprep_terminalTerminal Management
rl_dingUtility Functions
rl_directory_completion_hookCompletion Variables
rl_directory_rewrite_hook;Completion Variables
rl_discard_keymapKeymaps
rl_dispatchingReadline Variables
rl_display_match_listUtility Functions
rl_display_promptReadline Variables
rl_do_undoAllowing Undoing
rl_doneReadline Variables
rl_echo_signal_charReadline Signal Handling
rl_editing_modeReadline Variables
rl_empty_keymapKeymaps
rl_endReadline Variables
rl_end_undo_groupAllowing Undoing
rl_eof_foundReadline Variables
rl_erase_empty_lineReadline Variables
rl_event_hookReadline Variables
rl_execute_nextCharacter Input
rl_executing_keyReadline Variables
rl_executing_keymapReadline Variables
rl_executing_keyseqReadline Variables
rl_executing_macroReadline Variables
rl_expand_promptRedisplay
rl_explicit_argReadline Variables
rl_extend_line_bufferUtility Functions
rl_filename_completion_desiredCompletion Variables
rl_filename_completion_functionCompletion Functions
rl_filename_dequoting_functionCompletion Variables
rl_filename_quote_charactersCompletion Variables
rl_filename_quoting_desiredCompletion Variables
rl_filename_quoting_functionCompletion Variables
rl_filename_rewrite_hookCompletion Variables
rl_filename_stat_hookCompletion Variables
rl_forced_update_displayRedisplay
rl_freeUtility Functions
rl_free_keymapKeymaps
rl_free_line_stateReadline Signal Handling
rl_free_undo_listAllowing Undoing
rl_full_quoting_desiredCompletion Variables
rl_function_dumperAssociating Function Names and Bindings
rl_function_of_keyseqAssociating Function Names and Bindings
rl_function_of_keyseq_lenAssociating Function Names and Bindings
rl_funmap_namesAssociating Function Names and Bindings
rl_generic_bindBinding Keys
rl_get_keymapKeymaps
rl_get_keymap_by_nameKeymaps
rl_get_keymap_nameKeymaps
rl_get_screen_sizeReadline Signal Handling
rl_get_termcapMiscellaneous Functions
rl_getcCharacter Input
rl_getc_functionReadline Variables
rl_gnu_readline_pReadline Variables
rl_ignore_completion_duplicatesCompletion Variables
rl_ignore_some_completions_functionCompletion Variables
rl_inhibit_completionCompletion Variables
rl_initializeUtility Functions
rl_input_available_hookReadline Variables
rl_insert_completionsCompletion Functions
rl_insert_textModifying Text
rl_instreamReadline Variables
rl_invoking_keyseqsAssociating Function Names and Bindings
rl_invoking_keyseqs_in_mapAssociating Function Names and Bindings
rl_keep_mark_activeMiscellaneous Functions
rl_key_sequence_lengthReadline Variables
rl_kill_textModifying Text
rl_last_funcReadline Variables
rl_library_versionReadline Variables
rl_line_bufferReadline Variables
rl_list_funmap_namesAssociating Function Names and Bindings
rl_macro_bindMiscellaneous Functions
rl_macro_display_hookReadline Variables
rl_macro_dumperMiscellaneous Functions
rl_make_bare_keymapKeymaps
rl_make_keymapKeymaps
rl_markReadline Variables
rl_mark_active_pMiscellaneous Functions
rl_messageRedisplay
rl_modifyingAllowing Undoing
rl_named_functionAssociating Function Names and Bindings
rl_num_chars_to_readReadline Variables
rl_numeric_argReadline Variables
rl_on_new_lineRedisplay
rl_on_new_line_with_promptRedisplay
rl_outstreamReadline Variables
rl_parse_and_bindBinding Keys
rl_pending_inputReadline Variables
rl_pending_signalReadline Signal Handling
rl_persistent_signal_handlersReadline Signal Handling
rl_pointReadline Variables
rl_possible_completionsCompletion Functions
rl_pre_input_hookReadline Variables
rl_prefer_env_winsizeReadline Variables
rl_prep_term_functionReadline Variables
rl_prep_terminalTerminal Management
rl_print_keybindingAssociating Function Names and Bindings
rl_promptReadline Variables
rl_push_macro_inputModifying Text
rl_read_init_fileBinding Keys
rl_read_keyCharacter Input
rl_readline_nameReadline Variables
rl_readline_stateReadline Variables
rl_readline_versionReadline Variables
rl_redisplayRedisplay
rl_redisplay_functionReadline Variables
rl_reparse_colorsMiscellaneous Functions
rl_replace_lineModifying Text
rl_reset_after_signalReadline Signal Handling
rl_reset_line_stateRedisplay
rl_reset_screen_sizeReadline Signal Handling
rl_reset_terminalTerminal Management
rl_resize_terminalReadline Signal Handling
rl_restore_promptRedisplay
rl_restore_stateUtility Functions
rl_save_promptRedisplay
rl_save_stateUtility Functions
rl_set_keyBinding Keys
rl_set_keyboard_input_timeoutCharacter Input
rl_set_keymapKeymaps
rl_set_keymap_nameKeymaps
rl_set_paren_blink_timeoutMiscellaneous Functions
rl_set_promptRedisplay
rl_set_screen_sizeReadline Signal Handling
rl_set_signalsReadline Signal Handling
rl_set_timeoutCharacter Input
rl_show_charRedisplay
rl_signal_event_hookReadline Variables
rl_sort_completion_matchesCompletion Variables
rl_special_prefixesCompletion Variables
rl_startup_hookReadline Variables
rl_stuff_charCharacter Input
rl_terminal_nameReadline Variables
rl_timeout_event_hookReadline Variables
rl_timeout_remainingCharacter Input
rl_trim_arg_from_keyseqAssociating Function Names and Bindings
rl_tty_set_default_bindingsTerminal Management
rl_tty_set_echoingTerminal Management
rl_tty_unset_default_bindingsTerminal Management
rl_unbind_command_in_mapBinding Keys
rl_unbind_function_in_mapBinding Keys
rl_unbind_keyBinding Keys
rl_unbind_key_in_mapBinding Keys
rl_username_completion_functionCompletion Functions
rl_variable_bindMiscellaneous Functions
rl_variable_dumperMiscellaneous Functions
rl_variable_valueMiscellaneous Functions
S
search-ignore-caseReadline Init File Syntax
self-insert (a, b, A, 1, !, …)Commands For Text
set-mark (C-@)Miscellaneous Commands
show-all-if-ambiguousReadline Init File Syntax
show-all-if-unmodifiedReadline Init File Syntax
show-mode-in-promptReadline Init File Syntax
skip-completed-textReadline Init File Syntax
skip-csi-sequence ()Miscellaneous Commands
start-kbd-macro (C-x ()Keyboard Macros
T
tab-insert (M-TAB)Commands For Text
tilde-expand (M-~)Miscellaneous Commands
transpose-chars (C-t)Commands For Text
transpose-words (M-t)Commands For Text
U
undo (C-_ or C-x C-u)Miscellaneous Commands
universal-argument ()Numeric Arguments
unix-filename-rubout ()Commands For Killing
unix-line-discard (C-u)Commands For Killing
unix-word-rubout (C-w)Commands For Killing
upcase-word (M-u)Commands For Text
V
vi-cmd-mode-stringReadline Init File Syntax
vi-editing-mode (M-C-j)Miscellaneous Commands
vi-ins-mode-stringReadline Init File Syntax
visible-statsReadline Init File Syntax
Y
yank (C-y)Commands For Killing
yank-last-arg (M-. or M-_)Commands For History
yank-nth-arg (M-C-y)Commands For History
yank-pop (M-y)Commands For Killing
+
Jump to:   _ +   +
+A +   +B +   +C +   +D +   +E +   +F +   +H +   +I +   +K +   +M +   +N +   +O +   +P +   +Q +   +R +   +S +   +T +   +U +   +V +   +Y +   +
+
+ +
+
+ + + + + diff --git a/miniconda3/envs/ladir/share/doc/readline/rluserman.html b/miniconda3/envs/ladir/share/doc/readline/rluserman.html new file mode 100644 index 0000000000000000000000000000000000000000..b79efb467d131d6b0559eca95f5339a7e58b092d --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/readline/rluserman.html @@ -0,0 +1,2708 @@ + + + + + + +GNU Readline Library + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

+Next:   [Contents]

+
+

GNU Readline Library

+ +

This document describes the end user interface of the GNU Readline Library, +a utility which aids in the consistency of user interface across discrete +programs which provide a command line interface. +The Readline home page is http://www.gnu.org/software/readline/. +

+ + + + + + +
+
+
+

+Next: , Previous: , Up: GNU Readline Library   [Contents]

+
+

1 Command Line Editing

+ +

This chapter describes the basic features of the GNU +command line editing interface. +

+ + +
+
+
+

+Next: , Up: Command Line Editing   [Contents]

+
+

1.1 Introduction to Line Editing

+ +

The following paragraphs use Emacs style to +describe the notation used to represent keystrokes. +

+

The text C-k is read as ‘Control-K’ and describes the character +produced when the k key is pressed while the Control key +is depressed. +

+

The text M-k is read as ‘Meta-K’ and describes the character +produced when the Meta key (if you have one) is depressed, and the k +key is pressed (a meta character), then both are released. +The Meta key is labeled ALT or Option on many keyboards. +On keyboards with two keys labeled ALT (usually to either side of +the space bar), the ALT on the left side is generally set to +work as a Meta key. +One of the ALT keys may also be configured +as some other modifier, such as a +Compose key for typing accented characters. +

+

On some keyboards, the Meta key modifier produces characters with +the eighth bit (0200) set. +You can use the enable-meta-key variable +to control whether or not it does this, if the keyboard allows it. +On many others, the terminal or terminal emulator converts the metafied +key to a key sequence beginning with ESC as described in the +next paragraph. +

+

If you do not have a Meta or ALT key, or another key working as +a Meta key, you can generally achieve the latter effect by typing ESC +first, and then typing k. +The ESC character is known as the meta prefix). +

+

Either process is known as metafying the k key. +

+

If your Meta key produces a key sequence with the ESC meta prefix, +you can make M-key key bindings you specify +(see Key Bindings in Readline Init File Syntax) +do the same thing by setting the force-meta-prefix variable. +

+

The text M-C-k is read as ‘Meta-Control-k’ and describes the +character produced by metafying C-k. +

+

In addition, several keys have their own names. +Specifically, +DEL, ESC, LFD, SPC, RET, and TAB all +stand for themselves when seen in this text, or in an init file +(see Readline Init File). +If your keyboard lacks a LFD key, typing C-j will +output the appropriate character. +The RET key may be labeled Return or Enter on +some keyboards. +

+
+
+
+
+

+Next: , Previous: , Up: Command Line Editing   [Contents]

+
+

1.2 Readline Interaction

+ + +

Often during an interactive session you type in a long line of text, +only to notice that the first word on the line is misspelled. +The Readline library gives you a set of commands for manipulating the text +as you type it in, allowing you to just fix your typo, and not forcing +you to retype the majority of the line. +Using these editing commands, +you move the cursor to the place that needs correction, and delete or +insert the text of the corrections. +Then, when you are satisfied with the line, you simply press RET. +You do not have to be at the +end of the line to press RET; the entire line is accepted +regardless of the location of the cursor within the line. +

+ + +
+
+
+

+Next: , Up: Readline Interaction   [Contents]

+
+

1.2.1 Readline Bare Essentials

+ + + + +

In order to enter characters into the line, simply type them. +The typed +character appears where the cursor was, and then the cursor moves one +space to the right. +If you mistype a character, you can use your +erase character to back up and delete the mistyped character. +

+

Sometimes you may mistype a character, and +not notice the error until you have typed several other characters. +In that case, you can type C-b to move the cursor to the left, +and then correct your mistake. +Afterwards, you can move the cursor to the right with C-f. +

+

When you add text in the middle of a line, you will notice that characters +to the right of the cursor are ‘pushed over’ to make room for the text +that you have inserted. +Likewise, when you delete text behind the cursor, +characters to the right of the cursor are ‘pulled back’ to fill in the +blank space created by the removal of the text. +These are the bare +essentials for editing the text of an input line: +

+
+
C-b
+

Move back one character. +

+
C-f
+

Move forward one character. +

+
DEL or Backspace
+

Delete the character to the left of the cursor. +

+
C-d
+

Delete the character underneath the cursor. +

+
Printing characters
+

Insert the character into the line at the cursor. +

+
C-_ or C-x C-u
+

Undo the last editing command. +You can undo all the way back to an empty line. +

+
+ +

Depending on your configuration, the Backspace key might be set to +delete the character to the left of the cursor and the DEL key set +to delete the character underneath the cursor, like C-d, rather +than the character to the left of the cursor. +

+
+
+
+
+

+Next: , Previous: , Up: Readline Interaction   [Contents]

+
+

1.2.2 Readline Movement Commands

+ +

The above table describes the most basic keystrokes that you need +in order to do editing of the input line. +For your convenience, many other commands are available in +addition to C-b, C-f, C-d, and DEL. +Here are some commands for moving more rapidly within the line. +

+
+
C-a
+

Move to the start of the line. +

+
C-e
+

Move to the end of the line. +

+
M-f
+

Move forward a word, where a word is composed of letters and digits. +

+
M-b
+

Move backward a word. +

+
C-l
+

Clear the screen, reprinting the current line at the top. +

+
+ +

Notice how C-f moves forward a character, while M-f moves +forward a word. +It is a loose convention that control keystrokes +operate on characters while meta keystrokes operate on words. +

+
+
+
+
+

+Next: , Previous: , Up: Readline Interaction   [Contents]

+
+

1.2.3 Readline Killing Commands

+ + + + +

Killing text means to delete the text from the line, but to save +it away for later use, usually by yanking (re-inserting) +it back into the line. +(‘Cut’ and ‘paste’ are more recent jargon for ‘kill’ and ‘yank’.) +

+

If the description for a command says that it ‘kills’ text, then you can +be sure that you can get the text back in a different (or the same) +place later. +

+

When you use a kill command, the text is saved in a kill-ring. +Any number of consecutive kills save all of the killed text together, so +that when you yank it back, you get it all. +The kill ring is not line specific; the text that you killed on a previously +typed line is available to be yanked back later, when you are typing +another line. + +

+

Here is the list of commands for killing text. +

+
+
C-k
+

Kill the text from the current cursor position to the end of the line. +

+
+
M-d
+

Kill from the cursor to the end of the current word, or, if between +words, to the end of the next word. +Word boundaries are the same as those used by M-f. +

+
+
M-DEL
+

Kill from the cursor to the start of the current word, or, if between +words, to the start of the previous word. +Word boundaries are the same as those used by M-b. +

+
+
C-w
+

Kill from the cursor to the previous whitespace. +This is different than +M-DEL because the word boundaries differ. +

+
+
+ +

Here is how to yank the text back into the line. Yanking +means to copy the most-recently-killed text from the kill buffer +into the line at the current cursor position. +

+
+
C-y
+

Yank the most recently killed text back into the buffer at the cursor. +

+
+
M-y
+

Rotate the kill-ring, and yank the new top. +You can only do this if the prior command is C-y or M-y. +

+
+ +
+
+
+
+

+Next: , Previous: , Up: Readline Interaction   [Contents]

+
+

1.2.4 Readline Arguments

+ +

You can pass numeric arguments to Readline commands. +Sometimes the +argument acts as a repeat count, other times it is the sign of the +argument that is significant. +If you pass a negative argument to a +command which normally acts in a forward direction, that command will +act in a backward direction. +For example, to kill text back to the +start of the line, you might type ‘M-- C-k’. +

+

The general way to pass numeric arguments to a command is to type meta +digits before the command. +If the first ‘digit’ typed is a minus +sign (‘-’), then the sign of the argument will be negative. +Once you have typed one meta digit to get the argument started, you can +type the remainder of the digits, and then the command. +For example, to give +the C-d command an argument of 10, you could type ‘M-1 0 C-d’, +which will delete the next ten characters on the input line. +

+
+
+
+
+

+Previous: , Up: Readline Interaction   [Contents]

+
+

1.2.5 Searching for Commands in the History

+ +

Readline provides commands for searching through the command history +for lines containing a specified string. +There are two search modes: incremental and non-incremental. +

+

Incremental searches begin before the user has finished typing the +search string. +As each character of the search string is typed, Readline displays +the next entry from the history matching the string typed so far. +An incremental search requires only as many characters as needed to +find the desired history entry. +When using emacs editing mode, type C-r +to search backward in the history for a particular string. +Typing C-s searches forward through the history. +The characters present in the value of the isearch-terminators variable +are used to terminate an incremental search. +If that variable has not been assigned a value, the ESC and +C-j characters terminate an incremental search. +C-g aborts an incremental search and restores the original line. +When the search is terminated, the history entry containing the +search string becomes the current line. +

+

To find other matching entries in the history list, type C-r or +C-s as appropriate. +This searches backward or forward in the history for the next +entry matching the search string typed so far. +Any other key sequence bound to a Readline command terminates +the search and executes that command. +For instance, a RET terminates the search and accepts +the line, thereby executing the command from the history list. +A movement command will terminate the search, make the last line found +the current line, and begin editing. +

+

Readline remembers the last incremental search string. +If two C-rs are typed without any intervening characters defining +a new search string, Readline uses any remembered search string. +

+

Non-incremental searches read the entire search string before starting +to search for matching history entries. +The search string may be typed by the user or be part of the contents of +the current line. +

+
+
+
+
+
+

+Next: , Previous: , Up: Command Line Editing   [Contents]

+
+

1.3 Readline Init File

+ + +

Although the Readline library comes with a set of Emacs-like +keybindings installed by default, it is possible to use a different set +of keybindings. +Any user can customize programs that use Readline by putting +commands in an inputrc file, conventionally in their home directory. +The name of this file is taken from the value of the +environment variable INPUTRC. +If that variable is unset, the default is ~/.inputrc. +If that file does not exist or cannot be read, Readline looks for +/etc/inputrc. +

+

When a program that uses the Readline library starts up, Readline reads +the init file and sets any variables and key bindings it contains. +

+

In addition, the C-x C-r command re-reads this init file, thus +incorporating any changes that you might have made to it. +

+ + +
+
+
+

+Next: , Up: Readline Init File   [Contents]

+
+

1.3.1 Readline Init File Syntax

+ +

There are only a few basic constructs allowed in the +Readline init file. +Blank lines are ignored. +Lines beginning with a ‘#’ are comments. +Lines beginning with a ‘$’ indicate conditional +constructs (see Conditional Init Constructs). +Other lines denote variable settings and key bindings. +

+
+
Variable Settings
+

You can modify the run-time behavior of Readline by +altering the values of variables in Readline +using the set command within the init file. +The syntax is simple: +

+
+
set variable value
+
+ +

Here, for example, is how to +change from the default Emacs-like key binding to use +vi line editing commands: +

+
+
set editing-mode vi
+
+ +

Variable names and values, where appropriate, are recognized without +regard to case. +Unrecognized variable names are ignored. +

+

Boolean variables (those that can be set to on or off) are set to on if +the value is null or empty, on (case-insensitive), or 1. +Any other value results in the variable being set to off. +

+ +

A great deal of run-time behavior is changeable with the following +variables. +

+ +
+
active-region-start-color
+

A string variable that controls the text color and background when displaying +the text in the active region (see the description of +enable-active-region below). +This string must not take up any physical character positions on the display, +so it should consist only of terminal escape sequences. +It is output to the terminal before displaying the text in the active region. +This variable is reset to the default value whenever the terminal type changes. +The default value is the string that puts the terminal in standout mode, +as obtained from the terminal’s terminfo description. +A sample value might be ‘\e[01;33m’. +

+
+
active-region-end-color
+

A string variable that “undoes” +the effects of active-region-start-color +and restores “normal” +terminal display appearance after displaying text in the active region. +This string must not take up any physical character positions on the display, +so it should consist only of terminal escape sequences. +It is output to the terminal after displaying the text in the active region. +This variable is reset to the default value whenever the terminal type changes. +The default value is the string that restores the terminal from standout mode, +as obtained from the terminal’s terminfo description. +A sample value might be ‘\e[0m’. +

+
+
bell-style
+

Controls what happens when Readline wants to ring the terminal bell. +If set to ‘none’, Readline never rings the bell. +If set to ‘visible’, Readline uses a visible bell if one is available. +If set to ‘audible’ (the default), Readline attempts to ring +the terminal’s bell. +

+
+
bind-tty-special-chars
+

If set to ‘on’ (the default), Readline attempts to bind the control +characters that are +treated specially by the kernel’s terminal driver to their +Readline equivalents. +These override the default Readline bindings described here. +Type ‘stty -a’ at a Bash prompt to see your current terminal settings, +including the special control characters (usually cchars). +

+
+
blink-matching-paren
+

If set to ‘on’, Readline attempts to briefly move the cursor to an +opening parenthesis when a closing parenthesis is inserted. +The default is ‘off’. +

+
+
colored-completion-prefix
+

If set to ‘on’, when listing completions, Readline displays the +common prefix of the set of possible completions using a different color. +The color definitions are taken from the value of the LS_COLORS +environment variable. +If there is a color definition in LS_COLORS for the custom suffix +‘readline-colored-completion-prefix’, Readline uses this color for +the common prefix instead of its default. +The default is ‘off’. +

+
+
colored-stats
+

If set to ‘on’, Readline displays possible completions using different +colors to indicate their file type. +The color definitions are taken from the value of the LS_COLORS +environment variable. +The default is ‘off’. +

+
+
comment-begin
+

The string to insert at the beginning of the line by the +insert-comment command. +The default value is "#". +

+
+
completion-display-width
+

The number of screen columns used to display possible matches +when performing completion. +The value is ignored if it is less than 0 or greater than the terminal +screen width. +A value of 0 causes matches to be displayed one per line. +The default value is -1. +

+
+
completion-ignore-case
+

If set to ‘on’, Readline performs filename matching and completion +in a case-insensitive fashion. +The default value is ‘off’. +

+
+
completion-map-case
+

If set to ‘on’, and completion-ignore-case is enabled, Readline +treats hyphens (‘-’) and underscores (‘_’) as equivalent when +performing case-insensitive filename matching and completion. +The default value is ‘off’. +

+
+
completion-prefix-display-length
+

The maximum +length in characters of the common prefix of a list of possible +completions that is displayed without modification. +When set to a value greater than zero, Readline +replaces common prefixes longer than this value +with an ellipsis when displaying possible completions. +If a completion begins with a period, +and Readline is completing filenames, +it uses three underscores instead of an ellipsis. +

+
+
completion-query-items
+

The number of possible completions that determines when the user is asked +whether the list of possibilities should be displayed. +If the number of possible completions is greater than +or equal to this value, +Readline asks whether or not the user wishes to view them; +otherwise, Readline simply lists the completions. +This variable must be set to an integer value greater than or equal to zero. +A zero value means Readline should never ask; negative +values are treated as zero. +The default limit is 100. +

+
+
convert-meta
+

If set to ‘on’, Readline converts characters it reads +that have the eighth bit set to an ASCII key sequence by +clearing the eighth bit and prefixing an ESC character, +converting them to a meta-prefixed key sequence. +The default value is ‘on’, but Readline sets it to ‘off’ +if the locale contains +characters whose encodings may include bytes with the eighth bit set. +This variable is dependent on the LC_CTYPE locale category, and +may change if the locale changes. +This variable also affects key bindings; +see the description of force-meta-prefix below. +

+
+
disable-completion
+

If set to ‘On’, Readline inhibits word completion. +Completion characters are inserted into the line as if they +had been mapped to self-insert. +The default is ‘off’. +

+
+
echo-control-characters
+

When set to ‘on’, on operating systems that indicate they support it, +Readline echoes a character corresponding to a signal generated from the +keyboard. +The default is ‘on’. +

+
+
editing-mode
+

The editing-mode variable controls the default set of +key bindings. +By default, Readline starts up in emacs editing mode, where +the keystrokes are most similar to Emacs. +This variable can be set to either ‘emacs’ or ‘vi’. +

+
+
emacs-mode-string
+

If the show-mode-in-prompt variable is enabled, +this string is displayed immediately before the last line of the primary +prompt when emacs editing mode is active. +The value is expanded like a +key binding, so the standard set of meta- and control- prefixes and +backslash escape sequences is available. +The ‘\1’ and ‘\2’ escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +The default is ‘@’. +

+
+
enable-active-region
+

point is the current cursor position, and mark refers to a +saved cursor position (see Commands For Moving). +The text between the point and mark is referred to as the region. +When this variable is set to ‘On’, Readline allows certain commands +to designate the region as active. +When the region is active, Readline highlights the text in the region using +the value of the active-region-start-color, which defaults to the +string that enables the terminal’s standout mode. +The active region shows the text inserted by bracketed-paste and any +matching text found by incremental and non-incremental history searches. +The default is ‘On’. +

+
+
enable-bracketed-paste
+

When set to ‘On’, Readline configures the terminal to insert each +paste into the editing buffer as a single string of characters, instead +of treating each character as if it had been read from the keyboard. +This is called putting the terminal into bracketed paste mode; +it prevents Readline from executing any editing commands bound +to key sequences appearing in the pasted text. +The default is ‘On’. +

+
+
enable-keypad
+

When set to ‘on’, Readline tries to enable the application +keypad when it is called. +Some systems need this to enable the arrow keys. +The default is ‘off’. +

+
+
enable-meta-key
+

When set to ‘on’, Readline tries to enable any meta +modifier key the terminal claims to support when it is called. +On many terminals, the Meta key is used to send eight-bit characters; +this variable checks for the terminal capability that indicates the +terminal can enable and disable a mode that sets the eighth bit of a +character (0200) if the Meta key is held down when the character is +typed (a meta character). +The default is ‘on’. +

+
+
expand-tilde
+

If set to ‘on’, Readline attempts tilde expansion when it +attempts word completion. +The default is ‘off’. +

+
+
force-meta-prefix
+

If set to ‘on’, Readline modifies its behavior when binding key +sequences containing \M- or Meta- +(see Key Bindings in Readline Init File Syntax) +by converting a key sequence of the form +\M-C or Meta-C to the two-character sequence +ESC C (adding the meta prefix). +If force-meta-prefix is set to ‘off’ (the default), +Readline uses the value of the convert-meta variable to determine +whether to perform this conversion: +if convert-meta is ‘on’, +Readline performs the conversion described above; +if it is ‘off’, Readline converts C to a meta character by +setting the eighth bit (0200). +The default is ‘off’. +

+
+
history-preserve-point
+

If set to ‘on’, the history code attempts to place the point (the +current cursor position) at the +same location on each history line retrieved with previous-history +or next-history. +The default is ‘off’. +

+
+
history-size
+

Set the maximum number of history entries saved in the history list. +If set to zero, any existing history entries are deleted and no new entries +are saved. +If set to a value less than zero, the number of history entries is not +limited. +By default, the number of history entries is not limited. +If you try to set history-size to a non-numeric value, +the maximum number of history entries will be set to 500. +

+
+
horizontal-scroll-mode
+

Setting this variable to ‘on’ means that the text of the lines +being edited will scroll horizontally on a single screen line when +the lines are longer than the width of the screen, instead of wrapping +onto a new screen line. +This variable is automatically set to ‘on’ for terminals of height 1. +By default, this variable is set to ‘off’. +

+
+
+input-meta
+

If set to ‘on’, Readline enables eight-bit input (that is, it +does not clear the eighth bit in the characters it reads), +regardless of what the terminal claims it can support. +The default value is ‘off’, but Readline sets it to ‘on’ +if the locale contains characters whose encodings may include bytes +with the eighth bit set. +This variable is dependent on the LC_CTYPE locale category, and +its value may change if the locale changes. +The name meta-flag is a synonym for input-meta. +

+
+
isearch-terminators
+

The string of characters that should terminate an incremental search without +subsequently executing the character as a command (see Searching for Commands in the History). +If this variable has not been given a value, the characters ESC and +C-j terminate an incremental search. +

+
+
keymap
+

Sets Readline’s idea of the current keymap for key binding commands. +Built-in keymap names are +emacs, +emacs-standard, +emacs-meta, +emacs-ctlx, +vi, +vi-move, +vi-command, and +vi-insert. +vi is equivalent to vi-command (vi-move is also a +synonym); emacs is equivalent to emacs-standard. +Applications may add additional names. +The default value is emacs; +the value of the editing-mode variable also affects the +default keymap. +

+
+
keyseq-timeout
+

Specifies the duration Readline will wait for a character when +reading an ambiguous key sequence +(one that can form a complete key sequence using the input read so far, +or can take additional input to complete a longer key sequence). +If Readline doesn’t receive any input within the timeout, it uses the +shorter but complete key sequence. +Readline uses this value to determine whether or not input is +available on the current input source (rl_instream by default). +The value is specified in milliseconds, so a value of 1000 means that +Readline will wait one second for additional input. +If this variable is set to a value less than or equal to zero, or to a +non-numeric value, Readline waits until another key is pressed to +decide which key sequence to complete. +The default value is 500. +

+
+
mark-directories
+

If set to ‘on’, completed directory names have a slash appended. +The default is ‘on’. +

+
+
mark-modified-lines
+

When this variable is set to ‘on’, Readline displays an +asterisk (‘*’) at the start of history lines which have been modified. +This variable is ‘off’ by default. +

+
+
mark-symlinked-directories
+

If set to ‘on’, completed names which are symbolic links to directories +have a slash appended, subject to the value of mark-directories. +The default is ‘off’. +

+
+
match-hidden-files
+

This variable, when set to ‘on’, forces Readline to match files whose +names begin with a ‘.’ (hidden files) when performing filename +completion. +If set to ‘off’, the user must include the leading ‘.’ +in the filename to be completed. +This variable is ‘on’ by default. +

+
+
menu-complete-display-prefix
+

If set to ‘on’, menu completion displays the common prefix of the +list of possible completions (which may be empty) before cycling through +the list. +The default is ‘off’. +

+
+
output-meta
+

If set to ‘on’, Readline displays characters with the +eighth bit set directly rather than as a meta-prefixed escape +sequence. +The default is ‘off’, but Readline sets it to ‘on’ +if the locale contains characters whose encodings may include +bytes with the eighth bit set. +This variable is dependent on the LC_CTYPE locale category, and +its value may change if the locale changes. +

+
+
page-completions
+

If set to ‘on’, Readline uses an internal pager resembling +more(1) +to display a screenful of possible completions at a time. +This variable is ‘on’ by default. +

+
+
prefer-visible-bell
+

See bell-style. +

+
+
print-completions-horizontally
+

If set to ‘on’, Readline displays completions with matches +sorted horizontally in alphabetical order, rather than down the screen. +The default is ‘off’. +

+
+
revert-all-at-newline
+

If set to ‘on’, Readline will undo all changes to history lines +before returning when executing accept-line. +By default, +history lines may be modified and retain individual undo lists across +calls to readline(). +The default is ‘off’. +

+
+
search-ignore-case
+

If set to ‘on’, Readline performs incremental and non-incremental +history list searches in a case-insensitive fashion. +The default value is ‘off’. +

+
+
show-all-if-ambiguous
+

This alters the default behavior of the completion functions. +If set to ‘on’, +words which have more than one possible completion cause the +matches to be listed immediately instead of ringing the bell. +The default value is ‘off’. +

+
+
show-all-if-unmodified
+

This alters the default behavior of the completion functions in +a fashion similar to show-all-if-ambiguous. +If set to ‘on’, +words which have more than one possible completion without any +possible partial completion (the possible completions don’t share +a common prefix) cause the matches to be listed immediately instead +of ringing the bell. +The default value is ‘off’. +

+
+
show-mode-in-prompt
+

If set to ‘on’, add a string to the beginning of the prompt +indicating the editing mode: emacs, vi command, or vi insertion. +The mode strings are user-settable (e.g., emacs-mode-string). +The default value is ‘off’. +

+
+
skip-completed-text
+

If set to ‘on’, this alters the default completion behavior when +inserting a single match into the line. +It’s only active when performing completion in the middle of a word. +If enabled, Readline does not insert characters from the completion +that match characters after point in the word being completed, +so portions of the word following the cursor are not duplicated. +For instance, if this is enabled, attempting completion when the cursor +is after the first ‘e’ in ‘Makefile’ will result in +‘Makefile’ rather than ‘Makefilefile’, +assuming there is a single possible completion. +The default value is ‘off’. +

+
+
vi-cmd-mode-string
+

If the show-mode-in-prompt variable is enabled, +this string is displayed immediately before the last line of the primary +prompt when vi editing mode is active and in command mode. +The value is expanded like a key binding, so the standard set of +meta- and control- prefixes and backslash escape sequences is available. +The ‘\1’ and ‘\2’ escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +The default is ‘(cmd)’. +

+
+
vi-ins-mode-string
+

If the show-mode-in-prompt variable is enabled, +this string is displayed immediately before the last line of the primary +prompt when vi editing mode is active and in insertion mode. +The value is expanded like a key binding, so the standard set of +meta- and control- prefixes and backslash escape sequences is available. +The ‘\1’ and ‘\2’ escapes begin and end sequences of +non-printing characters, which can be used to embed a terminal control +sequence into the mode string. +The default is ‘(ins)’. +

+
+
visible-stats
+

If set to ‘on’, a character denoting a file’s type +is appended to the filename when listing possible +completions. +The default is ‘off’. +

+
+
+ +
+
Key Bindings
+

The syntax for controlling key bindings in the init file is simple. +First you need to find the name of the command that you +want to change. +The following sections contain tables of the command +name, the default keybinding, if any, and a short description of what +the command does. +

+

Once you know the name of the command, simply place on a line +in the init file the name of the key +you wish to bind the command to, a colon, and then the name of the +command. +There can be no space between the key name and the colon – that will be +interpreted as part of the key name. +The name of the key can be expressed in different ways, depending on +what you find most comfortable. +

+

In addition to command names, Readline allows keys to be bound +to a string that is inserted when the key is pressed (a macro). +The difference between a macro and a command is that a macro is +enclosed in single or double quotes. +

+ +
+
keyname: function-name or macro
+

keyname is the name of a key spelled out in English. +For example: +

+
Control-u: universal-argument
+Meta-Rubout: backward-kill-word
+Control-o: "> output"
+
+ +

In the example above, C-u is bound to the function +universal-argument, +M-DEL is bound to the function backward-kill-word, and +C-o is bound to run the macro +expressed on the right hand side (that is, to insert the text +‘> output’ into the line). +

+

This key binding syntax recognizes a number of symbolic character names: +DEL, +ESC, +ESCAPE, +LFD, +NEWLINE, +RET, +RETURN, +RUBOUT +(a destructive backspace), +SPACE, +SPC, +and +TAB. +

+
+
"keyseq": function-name or macro
+

keyseq differs from keyname above in that strings +denoting an entire key sequence can be specified, by placing +the key sequence in double quotes. +Some GNU Emacs style key escapes can be used, +as in the following example, but none of the +special character names are recognized. +

+
+
"\C-u": universal-argument
+"\C-x\C-r": re-read-init-file
+"\e[11~": "Function Key 1"
+
+ +

In the above example, C-u is again bound to the function +universal-argument (just as it was in the first example), +‘C-x C-r’ is bound to the function re-read-init-file, +and ‘ESC [ 1 1 ~’ is bound to insert +the text ‘Function Key 1’. +

+
+
+ +

The following GNU Emacs style escape sequences are available when +specifying key sequences: +

+
+
\C-
+

A control prefix. +

+
\M-
+

Adding the meta prefix or converting the following character to a meta +character, as described above under force-meta-prefix +(see Variable Settings in Readline Init File Syntax). +

+
\e
+

An escape character. +

+
\\
+

Backslash. +

+
\"
+

", a double quotation mark. +

+
\'
+

', a single quote or apostrophe. +

+
+ +

In addition to the GNU Emacs style escape sequences, a second +set of backslash escapes is available: +

+
+
\a
+

alert (bell) +

+
\b
+

backspace +

+
\d
+

delete +

+
\f
+

form feed +

+
\n
+

newline +

+
\r
+

carriage return +

+
\t
+

horizontal tab +

+
\v
+

vertical tab +

+
\nnn
+

The eight-bit character whose value is the octal value nnn +(one to three digits). +

+
\xHH
+

The eight-bit character whose value is the hexadecimal value HH +(one or two hex digits). +

+
+ +

When entering the text of a macro, single or double quotes must +be used to indicate a macro definition. +Unquoted text is assumed to be a function name. +The backslash escapes described above are expanded +in the macro body. +Backslash will quote any other character in the macro text, +including ‘"’ and ‘'’. +For example, the following binding will make ‘C-x \’ +insert a single ‘\’ into the line: +

+
"\C-x\\": "\\"
+
+ +
+
+ +
+
+
+
+

+Next: , Previous: , Up: Readline Init File   [Contents]

+
+

1.3.2 Conditional Init Constructs

+ +

Readline implements a facility similar in spirit to the conditional +compilation features of the C preprocessor which allows key +bindings and variable settings to be performed as the result +of tests. +There are four parser directives available. +

+
+
$if
+

The $if construct allows bindings to be made based on the +editing mode, the terminal being used, or the application using +Readline. +The text of the test, after any comparison operator, +extends to the end of the line; +unless otherwise noted, no characters are required to isolate it. +

+
+
mode
+

The mode= form of the $if directive is used to test +whether Readline is in emacs or vi mode. +This may be used in conjunction +with the ‘set keymap’ command, for instance, to set bindings in +the emacs-standard and emacs-ctlx keymaps only if +Readline is starting out in emacs mode. +

+
+
term
+

The term= form may be used to include terminal-specific +key bindings, perhaps to bind the key sequences output by the +terminal’s function keys. +The word on the right side of the +‘=’ +is tested against both the full name of the terminal and the portion +of the terminal name before the first ‘-’. +This allows xterm to match both xterm and +xterm-256color, for instance. +

+
+
version
+

The version test may be used to perform comparisons against +specific Readline versions. +The version expands to the current Readline version. +The set of comparison operators includes +‘=’ (and ‘==’), ‘!=’, ‘<=’, ‘>=’, ‘<’, +and ‘>’. +The version number supplied on the right side of the operator consists +of a major version number, an optional decimal point, and an optional +minor version (e.g., ‘7.1’). +If the minor version is omitted, it +defaults to ‘0’. +The operator may be separated from the string version and +from the version number argument by whitespace. +The following example sets a variable if the Readline version being used +is 7.0 or newer: +

+
$if version >= 7.0
+set show-mode-in-prompt on
+$endif
+
+ +
+
application
+

The application construct is used to include +application-specific settings. +Each program using the Readline +library sets the application name, and you can test for +a particular value. +This could be used to bind key sequences to functions useful for +a specific program. +For instance, the following command adds a +key sequence that quotes the current or previous word in Bash: +

+
$if Bash
+# Quote the current or previous word
+"\C-xq": "\eb\"\ef\""
+$endif
+
+ +
+
variable
+

The variable construct provides simple equality tests for Readline +variables and values. +The permitted comparison operators are ‘=’, ‘==’, and ‘!=’. +The variable name must be separated from the comparison operator by +whitespace; the operator may be separated from the value on the right hand +side by whitespace. +String and boolean variables may be tested. +Boolean variables must be +tested against the values on and off. +The following example is equivalent to the mode=emacs test described +above: +

+
$if editing-mode == emacs
+set show-mode-in-prompt on
+$endif
+
+
+
+ +
+
$else
+

Commands in this branch of the $if directive are executed if +the test fails. +

+
+
$endif
+

This command, as seen in the previous example, terminates an +$if command. +

+
+
$include
+

This directive takes a single filename as an argument and reads commands +and key bindings from that file. +For example, the following directive reads from /etc/inputrc: +

+
$include /etc/inputrc
+
+
+
+ +
+
+
+
+

+Previous: , Up: Readline Init File   [Contents]

+
+

1.3.3 Sample Init File

+ +

Here is an example of an inputrc file. This illustrates key +binding, variable assignment, and conditional syntax. +

+
+
# This file controls the behavior of line input editing for
+# programs that use the GNU Readline library.  Existing
+# programs include FTP, Bash, and GDB.
+#
+# You can re-read the inputrc file with C-x C-r.
+# Lines beginning with '#' are comments.
+#
+# First, include any system-wide bindings and variable
+# assignments from /etc/Inputrc
+$include /etc/Inputrc
+
+#
+# Set various bindings for emacs mode.
+
+set editing-mode emacs 
+
+$if mode=emacs
+
+Meta-Control-h:	backward-kill-word	Text after the function name is ignored
+
+#
+# Arrow keys in keypad mode
+#
+#"\M-OD":        backward-char
+#"\M-OC":        forward-char
+#"\M-OA":        previous-history
+#"\M-OB":        next-history
+#
+# Arrow keys in ANSI mode
+#
+"\M-[D":        backward-char
+"\M-[C":        forward-char
+"\M-[A":        previous-history
+"\M-[B":        next-history
+#
+# Arrow keys in 8 bit keypad mode
+#
+#"\M-\C-OD":       backward-char
+#"\M-\C-OC":       forward-char
+#"\M-\C-OA":       previous-history
+#"\M-\C-OB":       next-history
+#
+# Arrow keys in 8 bit ANSI mode
+#
+#"\M-\C-[D":       backward-char
+#"\M-\C-[C":       forward-char
+#"\M-\C-[A":       previous-history
+#"\M-\C-[B":       next-history
+
+C-q: quoted-insert
+
+$endif
+
+# An old-style binding.  This happens to be the default.
+TAB: complete
+
+# Macros that are convenient for shell interaction
+$if Bash
+# edit the path
+"\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f"
+# prepare to type a quoted word --
+# insert open and close double quotes
+# and move to just after the open quote
+"\C-x\"": "\"\"\C-b"
+# insert a backslash (testing backslash escapes
+# in sequences and macros)
+"\C-x\\": "\\"
+# Quote the current or previous word
+"\C-xq": "\eb\"\ef\""
+# Add a binding to refresh the line, which is unbound
+"\C-xr": redraw-current-line
+# Edit variable on current line.
+"\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
+$endif
+
+# use a visible bell if one is available
+set bell-style visible
+
+# don't strip characters to 7 bits when reading
+set input-meta on
+
+# allow iso-latin1 characters to be inserted rather
+# than converted to prefix-meta sequences
+set convert-meta off
+
+# display characters with the eighth bit set directly
+# rather than as meta-prefixed characters
+set output-meta on
+
+# if there are 150 or more possible completions for a word,
+# ask whether or not the user wants to see all of them
+set completion-query-items 150
+
+# For FTP
+$if Ftp
+"\C-xg": "get \M-?"
+"\C-xt": "put \M-?"
+"\M-.": yank-last-arg
+$endif
+
+ +
+
+
+
+
+

+Next: , Previous: , Up: Command Line Editing   [Contents]

+
+

1.4 Bindable Readline Commands

+ + +

This section describes Readline commands that may be bound to key +sequences. +Command names without an accompanying key sequence are unbound by default. +

+

In the following descriptions, point refers to the current cursor +position, and mark refers to a cursor position saved by the +set-mark command. +The text between the point and mark is referred to as the region. +Readline +has the concept of an active region: +when the region is active, +Readline redisplay highlights the region using the +value of the +active-region-start-color +variable. +The enable-active-region variable turns this on and off. +Several commands set the region to active; those are noted below. +

+ +
+
+
+

+Next: , Up: Bindable Readline Commands   [Contents]

+
+

1.4.1 Commands For Moving

+
+
beginning-of-line (C-a)
+

Move to the start of the current line. +This may also be bound to the Home key on some keyboards. +

+
+
end-of-line (C-e)
+

Move to the end of the line. +This may also be bound to the End key on some keyboards. +

+
+
forward-char (C-f)
+

Move forward a character. +This may also be bound to the right arrow key on some keyboards. +

+
+
backward-char (C-b)
+

Move back a character. +This may also be bound to the left arrow key on some keyboards. +

+
+
forward-word (M-f)
+

Move forward to the end of the next word. +Words are composed of letters and digits. +

+
+
backward-word (M-b)
+

Move back to the start of the current or previous word. +Words are composed of letters and digits. +

+ +
+
previous-screen-line ()
+

Attempt to move point to the same physical screen column on the previous +physical screen line. +This will not have the desired effect if the current +Readline line does not take up more than one physical line or if point is not +greater than the length of the prompt plus the screen width. +

+
+
next-screen-line ()
+

Attempt to move point to the same physical screen column on the next +physical screen line. +This will not have the desired effect if the current +Readline line does not take up more than one physical line or if the length +of the current Readline line is not greater than the length of the prompt +plus the screen width. +

+
+
clear-display (M-C-l)
+

Clear the screen and, if possible, the terminal’s scrollback buffer, +then redraw the current line, +leaving the current line at the top of the screen. +

+
+
clear-screen (C-l)
+

Clear the screen, +then redraw the current line, +leaving the current line at the top of the screen. +If given a numeric argument, this refreshes the current line +without clearing the screen. +

+
+
redraw-current-line ()
+

Refresh the current line. By default, this is unbound. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents]

+
+

1.4.2 Commands For Manipulating The History

+ +
+
accept-line (Newline or Return)
+

Accept the line regardless of where the cursor is. +If this line is non-empty, you can add it to the history list using +add_history(). +If this line is a modified history line, then restore the history line +to its original state. +

+
+
previous-history (C-p)
+

Move ‘back’ through the history list, fetching the previous command. +This may also be bound to the up arrow key on some keyboards. +

+
+
next-history (C-n)
+

Move ‘forward’ through the history list, fetching the next command. +This may also be bound to the down arrow key on some keyboards. +

+
+
beginning-of-history (M-<)
+

Move to the first line in the history. +

+
+
end-of-history (M->)
+

Move to the end of the input history, i.e., the line currently +being entered. +

+
+
reverse-search-history (C-r)
+

Search backward starting at the current line and moving ‘up’ through +the history as necessary. +This is an incremental search. +This command sets the region to the matched text and activates the region. +

+
+
forward-search-history (C-s)
+

Search forward starting at the current line and moving ‘down’ through +the history as necessary. +This is an incremental search. +This command sets the region to the matched text and activates the region. +

+
+
non-incremental-reverse-search-history (M-p)
+

Search backward starting at the current line and moving ‘up’ +through the history as necessary using a non-incremental search +for a string supplied by the user. +The search string may match anywhere in a history line. +

+
+
non-incremental-forward-search-history (M-n)
+

Search forward starting at the current line and moving ‘down’ +through the history as necessary using a non-incremental search +for a string supplied by the user. +The search string may match anywhere in a history line. +

+
+
history-search-backward ()
+

Search backward through the history for the string of characters +between the start of the current line and the point. +The search string must match at the beginning of a history line. +This is a non-incremental search. +By default, this command is unbound, but may be bound to the Page Down +key on some keyboards. +

+
+
history-search-forward ()
+

Search forward through the history for the string of characters +between the start of the current line and the point. +The search string must match at the beginning of a history line. +This is a non-incremental search. +By default, this command is unbound, but may be bound to the Page Up +key on some keyboards. +

+
+
history-substring-search-backward ()
+

Search backward through the history for the string of characters +between the start of the current line and the point. +The search string may match anywhere in a history line. +This is a non-incremental search. +By default, this command is unbound. +

+
+
history-substring-search-forward ()
+

Search forward through the history for the string of characters +between the start of the current line and the point. +The search string may match anywhere in a history line. +This is a non-incremental search. +By default, this command is unbound. +

+
+
yank-nth-arg (M-C-y)
+

Insert the first argument to the previous command (usually +the second word on the previous line) at point. +With an argument n, +insert the nth word from the previous command (the words +in the previous command begin with word 0). +A negative argument inserts the nth word from the end of +the previous command. +Once the argument n is computed, +this uses the history expansion facilities to extract the +nth word, as if the +‘!n’ history expansion had been specified. +

+
+
yank-last-arg (M-. or M-_)
+

Insert last argument to the previous command (the last word of the +previous history entry). +With a numeric argument, behave exactly like yank-nth-arg. +Successive calls to yank-last-arg move back through the history +list, inserting the last word (or the word specified by the argument to +the first call) of each line in turn. +Any numeric argument supplied to these successive calls determines +the direction to move through the history. +A negative argument switches the direction through the history +(back or forward). +This uses the history expansion facilities to extract the +last word, as if the +‘!$’ history expansion had been specified. +

+
+
operate-and-get-next (C-o)
+

Accept the current line for return to the calling application as if a +newline had been entered, +and fetch the next line relative to the current line from the history +for editing. +A numeric argument, if supplied, specifies the history entry +to use instead of the current line. +

+
+
fetch-history ()
+

With a numeric argument, fetch that entry from the history list +and make it the current line. +Without an argument, move back to the first entry in the history list. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents]

+
+

1.4.3 Commands For Changing Text

+ +
+
end-of-file (usually C-d)
+

The character indicating end-of-file as set, for example, by +stty. +If this character is read when there are no characters +on the line, and point is at the beginning of the line, Readline +interprets it as the end of input and returns EOF. +

+
+
delete-char (C-d)
+

Delete the character at point. +If this function is bound to the +same character as the tty EOF character, as C-d +commonly is, see above for the effects. +This may also be bound to the Delete key on some keyboards. +

+
+
backward-delete-char (Rubout)
+

Delete the character behind the cursor. +A numeric argument means +to kill the characters, saving them on the kill ring, +instead of deleting them. +

+
+
forward-backward-delete-char ()
+

Delete the character under the cursor, unless the cursor is at the +end of the line, in which case the character behind the cursor is +deleted. +By default, this is not bound to a key. +

+
+
quoted-insert (C-q or C-v)
+

Add the next character typed to the line verbatim. +This is how to insert key sequences like C-q, for example. +

+
+
tab-insert (M-TAB)
+

Insert a tab character. +

+
+
self-insert (a, b, A, 1, !, …)
+

Insert the character typed. +

+
+
bracketed-paste-begin ()
+

This function is intended to be bound to the "bracketed paste" escape +sequence sent by some terminals, and such a binding is assigned by default. +It allows Readline to insert the pasted text as a single unit without treating +each character as if it had been read from the keyboard. +The characters +are inserted as if each one was bound to self-insert instead of +executing any editing commands. +

+

Bracketed paste sets the region (the characters between point and the mark) +to the inserted text. +It sets the active region. +

+
+
transpose-chars (C-t)
+

Drag the character before the cursor forward over +the character at the cursor, moving the +cursor forward as well. +If the insertion point +is at the end of the line, then this +transposes the last two characters of the line. +Negative arguments have no effect. +

+
+
transpose-words (M-t)
+

Drag the word before point past the word after point, +moving point past that word as well. +If the insertion point is at the end of the line, this transposes +the last two words on the line. +

+ +
+
upcase-word (M-u)
+

Uppercase the current (or following) word. +With a negative argument, +uppercase the previous word, but do not move the cursor. +

+
+
downcase-word (M-l)
+

Lowercase the current (or following) word. +With a negative argument, +lowercase the previous word, but do not move the cursor. +

+
+
capitalize-word (M-c)
+

Capitalize the current (or following) word. +With a negative argument, +capitalize the previous word, but do not move the cursor. +

+
+
overwrite-mode ()
+

Toggle overwrite mode. +With an explicit positive numeric argument, switches to overwrite mode. +With an explicit non-positive numeric argument, switches to insert mode. +This command affects only emacs mode; +vi mode does overwrite differently. +Each call to readline() starts in insert mode. +

+

In overwrite mode, characters bound to self-insert replace +the text at point rather than pushing the text to the right. +Characters bound to backward-delete-char replace the character +before point with a space. +

+

By default, this command is unbound, but may be bound to the Insert +key on some keyboards. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents]

+
+

1.4.4 Killing And Yanking

+ +
+
kill-line (C-k)
+

Kill the text from point to the end of the current line. +With a negative numeric argument, kill backward from the cursor to the +beginning of the line. +

+
+
backward-kill-line (C-x Rubout)
+

Kill backward from the cursor to the beginning of the current line. +With a negative numeric argument, kill forward from the cursor to the +end of the line. +

+
+
unix-line-discard (C-u)
+

Kill backward from the cursor to the beginning of the current line. +

+
+
kill-whole-line ()
+

Kill all characters on the current line, no matter where point is. +By default, this is unbound. +

+
+
kill-word (M-d)
+

Kill from point to the end of the current word, or if between +words, to the end of the next word. +Word boundaries are the same as forward-word. +

+
+
backward-kill-word (M-DEL)
+

Kill the word behind point. +Word boundaries are the same as backward-word. +

+ +
+
unix-word-rubout (C-w)
+

Kill the word behind point, using white space as a word boundary, +saving the killed text on the kill-ring. +

+
+
unix-filename-rubout ()
+

Kill the word behind point, using white space and the slash character +as the word boundaries, +saving the killed text on the kill-ring. +

+
+
delete-horizontal-space ()
+

Delete all spaces and tabs around point. +By default, this is unbound. +

+
+
kill-region ()
+

Kill the text in the current region. +By default, this command is unbound. +

+
+
copy-region-as-kill ()
+

Copy the text in the region to the kill buffer, so it can be yanked +right away. +By default, this command is unbound. +

+
+
copy-backward-word ()
+

Copy the word before point to the kill buffer. +The word boundaries are the same as backward-word. +By default, this command is unbound. +

+
+
copy-forward-word ()
+

Copy the word following point to the kill buffer. +The word boundaries are the same as forward-word. +By default, this command is unbound. +

+
+
yank (C-y)
+

Yank the top of the kill ring into the buffer at point. +

+
+
yank-pop (M-y)
+

Rotate the kill-ring, and yank the new top. +You can only do this if +the prior command is yank or yank-pop. +

+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents]

+
+

1.4.5 Specifying Numeric Arguments

+
+
digit-argument (M-0, M-1, … M--)
+

Add this digit to the argument already accumulating, or start a new +argument. +M-- starts a negative argument. +

+
+
universal-argument ()
+

This is another way to specify an argument. +If this command is followed by one or more digits, optionally with a +leading minus sign, those digits define the argument. +If the command is followed by digits, executing universal-argument +again ends the numeric argument, but is otherwise ignored. +As a special case, if this command is immediately followed by a +character that is neither a digit nor minus sign, the argument count +for the next command is multiplied by four. +The argument count is initially one, so executing this function the +first time makes the argument count four, a second time makes the +argument count sixteen, and so on. +By default, this is not bound to a key. +

+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents]

+
+

1.4.6 Letting Readline Type For You

+ +
+
complete (TAB)
+

Attempt to perform completion on the text before point. +The actual completion performed is application-specific. +The default is filename completion. +

+
+
possible-completions (M-?)
+

List the possible completions of the text before point. +When displaying completions, Readline sets the number of columns used +for display to the value of completion-display-width, the value of +the environment variable COLUMNS, or the screen width, in that order. +

+
+
insert-completions (M-*)
+

Insert all completions of the text before point that would have +been generated by possible-completions, +separated by a space. +

+
+
menu-complete ()
+

Similar to complete, but replaces the word to be completed +with a single match from the list of possible completions. +Repeatedly executing menu-complete steps through the list +of possible completions, inserting each match in turn. +At the end of the list of completions, +menu-complete rings the bell +(subject to the setting of bell-style) +and restores the original text. +An argument of n moves n positions forward in the list +of matches; a negative argument moves backward through the list. +This command is intended to be bound to TAB, but is unbound +by default. +

+
+
menu-complete-backward ()
+

Identical to menu-complete, but moves backward through the list +of possible completions, as if menu-complete had been given a +negative argument. +This command is unbound by default. +

+
+
export-completions ()
+

Perform completion on the word before point as described above +and write the list of possible completions to Readline’s output stream +using the following format, writing information on separate lines: +

+
    +
  • the number of matches N; +
  • the word being completed; +
  • S:E, +where S and E are the start and end offsets of the word +in the Readline line buffer; then +
  • each match, one per line +
+ +

If there are no matches, the first line will be “0”, +and this command does not print any output after the S:E. +If there is only a single match, this prints a single line containing it. +If there is more than one match, this prints the common prefix of the +matches, which may be empty, on the first line after the S:E, +then the matches on subsequent lines. +In this case, N will include the first line with the common prefix. +

+

The user or application +should be able to accommodate the possibility of a blank line. +The intent is that the user or application reads N lines after +the line containing S:E to obtain the match list. +This command is unbound by default. +

+
+
delete-char-or-list ()
+

Deletes the character under the cursor if not at the beginning or +end of the line (like delete-char). +At the end of the line, it behaves identically to possible-completions. +This command is unbound by default. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: Bindable Readline Commands   [Contents]

+
+

1.4.7 Keyboard Macros

+
+
start-kbd-macro (C-x ()
+

Begin saving the characters typed into the current keyboard macro. +

+
+
end-kbd-macro (C-x ))
+

Stop saving the characters typed into the current keyboard macro +and save the definition. +

+
+
call-last-kbd-macro (C-x e)
+

Re-execute the last keyboard macro defined, by making the characters +in the macro appear as if typed at the keyboard. +

+
+
print-last-kbd-macro ()
+

Print the last keyboard macro defined in a format suitable for the +inputrc file. +

+
+
+ +
+
+
+
+

+Previous: , Up: Bindable Readline Commands   [Contents]

+
+

1.4.8 Some Miscellaneous Commands

+
+
re-read-init-file (C-x C-r)
+

Read in the contents of the inputrc file, and incorporate +any bindings or variable assignments found there. +

+
+
abort (C-g)
+

Abort the current editing command and +ring the terminal’s bell (subject to the setting of +bell-style). +

+
+
do-lowercase-version (M-A, M-B, M-x, …)
+

If the metafied character x is upper case, run the command +that is bound to the corresponding metafied lower case character. +The behavior is undefined if x is already lower case. +

+
+
prefix-meta (ESC)
+

Metafy the next character typed. +Typing ‘ESC f’ is equivalent to typing M-f. +

+
+
undo (C-_ or C-x C-u)
+

Incremental undo, separately remembered for each line. +

+
+
revert-line (M-r)
+

Undo all changes made to this line. +This is like executing the undo +command enough times to get back to the initial state. +

+
+
tilde-expand (M-~)
+

Perform tilde expansion on the current word. +

+
+
set-mark (C-@)
+

Set the mark to the point. +If a numeric argument is supplied, set the mark to that position. +

+
+
exchange-point-and-mark (C-x C-x)
+

Swap the point with the mark. +Set the current cursor position to the saved position, +then set the mark to the old cursor position. +

+
+
character-search (C-])
+

Read a character and move point to the next occurrence of that character. +A negative argument searches for previous occurrences. +

+
+
character-search-backward (M-C-])
+

Read a character and move point to the previous occurrence of that character. +A negative argument searches for subsequent occurrences. +

+
+
skip-csi-sequence ()
+

Read enough characters to consume a multi-key sequence such as those +defined for keys like Home and End. +CSI sequences begin with a Control Sequence Indicator (CSI), usually +ESC [. +If this sequence is bound to "\e[", +keys producing CSI sequences have no effect +unless explicitly bound to a Readline command, +instead of inserting stray characters into the editing buffer. +This is unbound by default, but usually bound to +ESC [. +

+
+
insert-comment (M-#)
+

Without a numeric argument, insert the value of the comment-begin +variable at the beginning of the current line. +If a numeric argument is supplied, this command acts as a toggle: if +the characters at the beginning of the line do not match the value +of comment-begin, insert the value; otherwise delete +the characters in comment-begin from the beginning of the line. +In either case, the line is accepted as if a newline had been typed. +

+
+
dump-functions ()
+

Print all of the functions and their key bindings +to the Readline output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an inputrc file. +This command is unbound by default. +

+
+
dump-variables ()
+

Print all of the settable variables and their values +to the Readline output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an inputrc file. +This command is unbound by default. +

+
+
dump-macros ()
+

Print all of the Readline key sequences bound to macros and the +strings they output +to the Readline output stream. +If a numeric argument is supplied, +the output is formatted in such a way that it can be made part +of an inputrc file. +This command is unbound by default. +

+
+
execute-named-command (M-x)
+

Read a bindable Readline command name from the input and execute the +function to which it’s bound, as if the key sequence to which it was +bound appeared in the input. +If this function is supplied with a numeric argument, it passes that +argument to the function it executes. +

+ +
+
emacs-editing-mode (C-e)
+

When in vi command mode, this causes a switch to emacs +editing mode. +

+
+
vi-editing-mode (M-C-j)
+

When in emacs editing mode, this causes a switch to vi +editing mode. +

+ +
+
+ +
+
+
+
+
+

+Previous: , Up: Command Line Editing   [Contents]

+
+

1.5 Readline vi Mode

+ +

While the Readline library does not have a full set of vi +editing functions, it does contain enough to allow simple editing +of the line. +The Readline vi mode behaves as specified in the +sh description in the POSIX standard. +

+

In order to switch interactively between emacs and vi +editing modes, use the command M-C-j (bound to emacs-editing-mode +when in vi mode and to vi-editing-mode in emacs mode). +The Readline default is emacs mode. +

+

When you enter a line in vi mode, you are already placed in +‘insertion’ mode, as if you had typed an ‘i’. Pressing ESC +switches you into ‘command’ mode, where you can edit the text of the +line with the standard vi movement keys, move to previous +history lines with ‘k’ and subsequent lines with ‘j’, and +so forth. +

+ +
+
+
+
+
+

+Previous: , Up: GNU Readline Library   [Contents]

+
+

Appendix A GNU Free Documentation License

+ +
Version 1.3, 3 November 2008 +
+ +
+
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+http://fsf.org/
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+ +
    +
  1. PREAMBLE + +

    The purpose of this License is to make a manual, textbook, or other +functional and useful document free in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. +

    +

    This License is a kind of “copyleft”, which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. +

    +

    We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. +

    +
  2. APPLICABILITY AND DEFINITIONS + +

    This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The “Document”, below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as “you”. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. +

    +

    A “Modified Version” of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. +

    +

    A “Secondary Section” is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document’s overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. +

    +

    The “Invariant Sections” are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. +

    +

    The “Cover Texts” are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. +

    +

    A “Transparent” copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not “Transparent” is called “Opaque”. +

    +

    Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. +

    +

    The “Title Page” means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, “Title Page” means +the text near the most prominent appearance of the work’s title, +preceding the beginning of the body of the text. +

    +

    The “publisher” means any person or entity that distributes copies +of the Document to the public. +

    +

    A section “Entitled XYZ” means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as “Acknowledgements”, +“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” +of such a section when you modify the Document means that it remains a +section “Entitled XYZ” according to this definition. +

    +

    The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. +

    +
  3. VERBATIM COPYING + +

    You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. +

    +

    You may also lend copies, under the same conditions stated above, and +you may publicly display copies. +

    +
  4. COPYING IN QUANTITY + +

    If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document’s license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. +

    +

    If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. +

    +

    If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. +

    +

    It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. +

    +
  5. MODIFICATIONS + +

    You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: +

    +
      +
    1. Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +
    2. List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +
    3. State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +
    4. Preserve all the copyright notices of the Document. + +
    5. Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +
    6. Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +
    7. Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document’s license notice. + +
    8. Include an unaltered copy of this License. + +
    9. Preserve the section Entitled “History”, Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled “History” in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +
    10. Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the “History” section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +
    11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +
    12. Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +
    13. Delete any section Entitled “Endorsements”. Such a section +may not be included in the Modified Version. + +
    14. Do not retitle any existing section to be Entitled “Endorsements” or +to conflict in title with any Invariant Section. + +
    15. Preserve any Warranty Disclaimers. +
    + +

    If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version’s license notice. +These titles must be distinct from any other section titles. +

    +

    You may add a section Entitled “Endorsements”, provided it contains +nothing but endorsements of your Modified Version by various +parties—for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. +

    +

    You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. +

    +

    The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. +

    +
  6. COMBINING DOCUMENTS + +

    You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. +

    +

    The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. +

    +

    In the combination, you must combine any sections Entitled “History” +in the various original documents, forming one section Entitled +“History”; likewise combine any sections Entitled “Acknowledgements”, +and any sections Entitled “Dedications”. You must delete all +sections Entitled “Endorsements.” +

    +
  7. COLLECTIONS OF DOCUMENTS + +

    You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. +

    +

    You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. +

    +
  8. AGGREGATION WITH INDEPENDENT WORKS + +

    A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an “aggregate” if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation’s users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. +

    +

    If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document’s Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. +

    +
  9. TRANSLATION + +

    Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. +

    +

    If a section in the Document is Entitled “Acknowledgements”, +“Dedications”, or “History”, the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. +

    +
  10. TERMINATION + +

    You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. +

    +

    However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. +

    +

    Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. +

    +

    Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. +

    +
  11. FUTURE REVISIONS OF THIS LICENSE + +

    The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +http://www.gnu.org/copyleft/. +

    +

    Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License “or any later version” applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy’s public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. +

    +
  12. RELICENSING + +

    “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +“Massive Multiauthor Collaboration” (or “MMC”) contained in the +site means any set of copyrightable works thus published on the MMC +site. +

    +

    “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. +

    +

    “Incorporate” means to publish or republish a Document, in whole or +in part, as part of another Document. +

    +

    An MMC is “eligible for relicensing” if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. +

    +

    The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. +

    +
+ +

ADDENDUM: How to use this License for your documents

+ +

To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: +

+
+
  Copyright (C)  year  your name.
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.3
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+  Texts.  A copy of the license is included in the section entitled ``GNU
+  Free Documentation License''.
+
+ +

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the “with…Texts.” line with this: +

+
+
    with the Invariant Sections being list their titles, with
+    the Front-Cover Texts being list, and with the Back-Cover Texts
+    being list.
+
+ +

If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. +

+

If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. +

+ + +
+
+ + + + + diff --git a/miniconda3/envs/ladir/share/doc/recordproto/record.xml b/miniconda3/envs/ladir/share/doc/recordproto/record.xml new file mode 100644 index 0000000000000000000000000000000000000000..6b158957e48219bb78461f52a94e739aa73d1e1d --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/recordproto/record.xml @@ -0,0 +1,1904 @@ + + %defs; +]> + + + + + + + Record Extension Protocol Specification + X Consortium Standard + + + MarthaZimet + Network Computing Devices, Inc. + + + StephenGildea + X Consortium + + + X Version 11, Release &fullrelvers; + 1994Network Computing Devices, Inc. + + + + +Permission to use, copy, modify, distribute, and sell this +documentation for any purpose is hereby granted without fee, +provided that the above copyright notice and this permission +notice appear in all copies. Network Computing Devices, Inc. +makes no representations about the suitability for any purpose +of the information in this document. This documentation is +provided “as is” without express or implied warranty. + + + + +Copyright © 1994, 1995 X Consortium + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + + + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + + + +Except as contained in this notice, the name of the X Consortium and +shall not be used in advertising or otherwise to promote the sale, use +or other dealings in this Software without prior written authorization +from the X Consortium. + +X Window System is a trademark of The Open Group. + + + + +Introduction + +Several proposals have been written over the past few years that address some +of the issues surrounding the recording and playback of user actions +in the X Window System +X Window System is a trademark of The Open Group. + +: + + + + + +Some Proposals for a Minimal X11 Testing Extension, +Kieron Drake, UniSoft Ltd., April 1991 + + + + +X11 Input Synthesis Extension Proposal, Larry Woestman, +Hewlett Packard, November 1991 + + + + +XTrap Architecture, Dick Annicchiario, et al, Digital Equipment Corporation, +July 1991 + + + + +XTest Extension Recording Specification, Yochanan Slonim, +Mercury Interactive, December 1992 + + + + + +This document both unifies and extends the previous diverse approaches +to generate a proposal for an X extension that provides support for +the recording of all core X protocol and arbitrary extension protocol. +Input synthesis, or playback, has already been implemented in the +XTest extension, an X Consortium standard. Therefore, this extension +is limited to recording. + + + +In order to provide both record and playback functionality, a +hypothetical record application could use this extension to capture +both user actions and their consequences. For example, a button press +(a user action) may cause a window to be mapped and a corresponding +MapNotify +event to be sent (a consequence). This information could be +stored for later use by a playback application. + + + +The playback application could use the recorded actions as input for +the XTest extension's +XTestFakeInput +operation to synthesize the +appropriate input events. The "consequence" or synchronization +information is then used as a synchronization point during playback. +That is, the playback application does not generate specific +synthesized events until their matching synchronization condition +occurs. When the condition occurs the processing of synthesized +events continues. Determination that the condition has occurred may be +made by capturing the consequences of the synthesized events and +comparing them to the previously recorded synchronization information. +For example, if a button press was followed by a +MapNotify +event on a +particular window in the recorded data, the playback application might +synthesize the button press then wait for the +MapNotify +event on the +appropriate window before proceeding with subsequent synthesized +input. + + + +Because +it is impossible to predict what synchronization information will be +required by a particular application, the extension provides +facilities to record any subset of core X protocol and arbitrary +extension protocol. +As such, this extension does not enforce a specific +synchronization methodology; any method based on information in the X +protocol stream (e.g., watching for window mapping/unmapping, cursor +changes, drawing of certain text strings, etc.) can capture the +information it needs using RECORD facilities. + + + +Acknowledgements + +The document represents the culmination of two years of debate and +experiments done under the auspices of the X Consortium xtest working +group. Although this was a group effort, the author remains +responsible for any errors or omissions. +Two years ago, Robert Chesler of Absol-puter, Kieron Drake of UniSoft +Ltd., Marc Evans of Synergytics and Ken Miller of Digital shared the +vision of a standard extension for recording and were all instrumental +in the early protocol development. During the last two years, Bob +Scheifler of the X Consortium and Jim Fulton of NCD continuously +provided input to the protocol design, as well as encouragement to the +author. In the last few months, Stephen Gildea and Dave Wiggins, +both X Consortium staff, have spent considerable time fine tuning the +protocol design and reviewing the protocol specifications. Most +recently, Amnon Cohen of Mercury Interactive has assisted in +clarification of the recorded event policy, and Kent Siefkes of +Performance Awareness has assisted in clarification of the timestamp +policy. + + + + +Goals + + + +To provide a standard for recording, +whereby both device events and synchronization information in the +form of device event consequences are recorded. + + + + +To record contextual information used in synchronized playback +without prior knowledge of the application +that +is being recorded. + + + + +To provide the ability to record arbitrary X protocol extensions. + + + + + + + +Requirements + +The extension should function as follows: + + + + + +It should +not be dependent on other clients or extensions for its operation. + + + + +It should +not significantly impact performance. + + + + +It should +support the recording of all device input (core devices and XInput devices). + + + + +It should +be extendible. + + + + +It should +support the recording of synchronization information for user events. + + + + + + + +Design + +This section gives an overview of the RECORD extension and discusses +its overall operation and data types. + + + +Overview + +The mechanism used by this extension for recording is to intercept +core X protocol and arbitrary X extension protocol entirely within the X server +itself. When the extension has been requested to intercept specific +protocol by one or more clients, the protocol data are formatted and +returned to the recording clients. + + + +The extension provides a mechanism for capturing all events, including +input device events that go to no clients, that is analogous to a client +expressing "interest" in all events in all windows, including the root +window. Event filtering in the extension provides a mechanism for feeding +device events to recording clients; it does not provide a mechanism for +in-place, synchronous event substitution, modification, or withholding. +In addition, the +extension does not provide data compression before intercepted protocol +is returned to the recording clients. + + +Data Delivery + + + + + +Because +events are limited in size to +32 bytes, using events to return intercepted protocol data to recording +clients is prohibitive in terms of performance. Therefore, intercepted +protocol data are returned to recording clients through multiple replies +to the extension request to begin protocol interception and reporting. +This utilization is consistent with +ListFontsWithInfo , +for example, where a +single request has multiple replies. + + + +Individual requests, replies, events or errors intercepted by the extension +on behalf of recording clients cannot be split across reply packets. In order +to reduce overhead, multiple intercepted requests, replies, events and errors +might be collected +into a single reply. +Nevertheless, all data are returned to the client in a timely manner. + + + +Record Context + + + + + +The extension adds a record context resource (RC) +to the set of resources managed by the server. All the +extension operations take an RC as an argument. Although the protocol +permits sharing of RCs between clients, it is expected that clients will +use their own RCs. The attributes used in extension operations are stored +in the RCs, and these attributes include the protocol and clients to +intercept. + + + +The terms "register" and "unregister" are used to describe the +relationship between clients to intercept and the RC. To register +a client with an RC means the client is added to the list +of clients to intercept; to unregister a client means the client +is deleted from the list of clients to intercept. When the +server is requested to register or unregister clients from an RC, +it is required to do so immediately. That is, it is not permissible for +the server to wait until recording is enabled to register clients +or recording is disabled to unregister clients. + + + + +Record Client Connections + + + + + +The typical communication model for a recording client is to open +two connections to the server and use one for RC control and +the other for reading protocol data. + + + +The "control" connection can execute requests to obtain information about +the supported protocol version, create and destroy RCs, specify protocol +types to intercept and clients to be recorded, query the current state +of an RC, and to stop interception and reporting of protocol data. The +"data" connection can execute a request to +enable interception +and reporting of specified protocol for a particular RC. When the +"enable" request is issued, intercepted protocol is sent back on the +same connection, generally in more than one reply packet. Until the last +reply to the "enable" request is sent by the server, signifying that +the request execution is complete, no other requests will be executed by +the server on that connection. That is, the connection that data are being +reported on cannot issue the "disable" request until the last reply +to the "enable" request is sent by the server. Therefore, unless a +recording client never has the need to disable the interception and reporting +of protocol data, two client connections are necessary. + + + +Events + + + + + +The terms "delivered events" and "device events" are used +to describe the two event classes recording clients may +select for interception. These event classes are handled differently +by the extension. Delivered events are core X events or X extension events +the server actually delivers to one or more clients. Device events are +events generated by core X devices or extension input devices that the +server may or may not deliver to any clients. When device events +are selected for interception by a recording client, the extension +guarantees each device event is recorded and will be forwarded +to the recording client in the same order it is generated by the +device. + + + +The recording of selected device events is not affected +by server grabs. Delivered events, on the other hand, can be affected +by server grabs. +If a recording client selects both +a device event and delivered events that result from that device +event, the delivered events are recorded after the device event. +In the absence of grabs, the delivered events for a +device event precede later device events. + + + +Requests that have side effects on +devices, such as +WarpPointer +and +GrabPointer +with a confine-to window, +will cause RECORD to record an associated device event. +The XTEST extension request +XTestFakeInput +causes a device event to be recorded; the +device events are recorded in the same order that the +XTestFakeInput +requests are received by the server. + + + +If a key autorepeats, multiple +KeyPress +and +KeyRelease +device events are reported. + + + + +Timing + + + + +Requests are recorded just before +they are executed; the time associated with a request is the server +time when it is recorded. + + + + + +Types + +The following new types are used in the request definitions that appear +in section 3. + + +RC: CARD32 + + +The +"RC" +type is a resource identifier for a server record context. + + + + + + + + + + + RANGE8: + [first, last: + CARD8] + + + RANGE16: + [first, last: + CARD16] + + + EXTRANGE: + [major: + RANGE8 + + + + minor: + RANGE16] + + + + + + + + + + + + + + RECORDRANGE: + [core-requests: + RANGE8 + + + + core-replies: + RANGE8 + + + + ext-requests: + EXTRANGE + + + + ext-replies: + EXTRANGE + + + + delivered-events: + RANGE8 + + + + device-events: + RANGE8 + + + + errors: + RANGE8 + + + + client-started: + BOOL + + + + client-died: + BOOL] + + + + + + +The +"RECORDRANGE" +structure contains the protocol values to intercept. Typically, +this structure is sent by recording clients over the control connection +when creating or modifying an RC. + + + + + + + +Specifies core X protocol requests with an opcode field between first +and last inclusive. If first is equal to 0 and last is equal to 0, no +core requests are specified by this RECORDRANGE. If first is greater +than last, a +"Value" +error results. + + + + + + +Specifies replies resulting from core X protocol requests with an opcode +field between first and last inclusive. If first is equal to 0 and last +is equal to 0, no core replies are specified by this RECORDRANGE. If +first is greater than last, a +"Value" +error results. + + + + + + +Specifies extension protocol requests with a major opcode field between +major.first and major.last and a minor opcode field between minor.first +and minor.last inclusive. +If major.first and major.last are equal to 0, no +extension protocol requests are specified by this RECORDRANGE. If +major.first or major.last is less than 128 and greater than 0, +if major.first is greater than major.last, +or if minor.first +is greater than minor.last, a +"Value" +error results. + + + + + + +Specifies replies resulting from extension protocol requests with a +major opcode field between major.first and major.last and +a minor opcode field between minor.first and minor.last +inclusive. If major.first and major.last are equal to 0, +no extension protocol replies are specified by this RECORDRANGE. If +major.first or major.last is less than 128 and greater +than 0, +if major.first is greater than major.last, +or if minor.first is greater than minor.last, a +"Value" +error results. + + + + + + +This is used for both core X protocol events and arbitrary extension +events. Specifies events that are delivered to at least one client +that have a code field between first and last +inclusive. If first is equal to 0 and last is equal to 0, +no events are specified by this RECORDRANGE. +Otherwise, if first is less than 2 +or last is less than 2, or if +first is greater than last, a +"Value" +error results. + + + + + + +This is used for both core X device events and X extension device +events that may or may not be delivered to a client. +Specifies device events that have a code field between first and +last inclusive. If first is equal to 0 and last +is equal to 0, no device events are specified by this RECORDRANGE. +Otherwise, +if first is less than 2 or last is less +than 2, or if first is greater than last, a +"Value" +error results. + + + + +Because +the generated device event may or may not be associated with a +client, unlike other RECORDRANGE components, which select protocol for a +specific client, selecting for device events in any RECORDRANGE in an RC +causes the recording client to receive one instance for each device event +generated that is in the range specified. + + + + + + +This is used for both core X protocol errors and arbitrary extension +errors. Specifies errors that have a code field between first and +last inclusive. If first is equal to 0 and last is equal to 0, no +errors are specified by this RECORDRANGE. If first is greater +than last, a +"Value" +error results. + + + + + + +Specifies the connection setup reply. +If +False , +the connection setup reply is not specified by +this RECORDRANGE. + + + + + + +Specifies notification when a client disconnects. +If +False , +notification when a client disconnects is not specified by +this RECORDRANGE. + + + + + + + + + + + + + ELEMENT_HEADER: + [from-server-time: + BOOL + + + + from-client-time: + BOOL + + + + from-client-sequence: + BOOL] + + + + + + +The +ELEMENT_HEADER +structure specifies additional data that precedes each protocol +element in the data field of a +RecordEnableContext +reply. + + + + + +If from-server-time is +True , +each intercepted protocol element +with category +FromServer +is preceded by the server time when the protocol was recorded. + + + + +If from-client-time is +True , +each intercepted protocol element +with category +FromClient +is preceded by the server time when the protocol was recorded. + + + + +If from-client-sequence is +True , +each intercepted protocol +element with category +FromClient +or +ClientDied +is preceded by the +32-bit sequence number of the recorded client's most recent request +processed by the server at that time. +For +FromClient , +this will be one less than the sequence number of the +following request. +For +ClientDied , +the sequence number will be the only data, because no +protocol is recorded. + + + + + +Note that a reply containing device events is treated the same as +other replies with category +FromServer +for purposes of these flags. +Protocol with category +FromServer +is never preceded by a sequence +number because almost all such protocol has a sequence number in it anyway. + + + + +If both a server time and a sequence number have been requested for a +reply, each protocol request is +preceded first by the time and second by the sequence number. + + +XIDBASE: CARD32 + + + +The XIDBASE type is used to identify a particular client. Valid +values are any existing resource identifier +of any connected client, +in which case the client +that created the resource is specified, or the resource identifier +base sent to the target client from the server in the connection setup +reply. A value of 0 (zero) is valid when the XIDBASE is associated +with device events that may not have been delivered to a client. + + + +CLIENTSPEC: XIDBASE or {CurrentClients, +FutureClients, AllClients} + + + +The CLIENTSPEC type defines the set of clients the RC attributes are +associated with. This type is used by recording clients when creating +an RC or when changing RC attributes. XIDBASE specifies that the RC +attributes apply to a single client only. +CurrentClients +specifies +that the RC attributes apply to current client connections; +FutureClients +specifies future client connections; +AllClients +specifies all client connections, which includes current and future. + + + +The numeric values for +CurrentClients , +FutureClients +and +AllClients +are +defined such that there will be no intersection with valid XIDBASEs. + + + + +When the context is enabled, the data connection is unregistered if it +was registered. +If the context is enabled, +CurrentClients +and +AllClients +silently exclude the recording data connection. +It is an error to explicitly register the data connection. + + + + + + + + + + + CLIENT_INFO: + [client-resource: + CLIENTSPEC + + + + intercepted-protocol: + LISTofRECORDRANGE] + + + + + + +This structure specifies an intercepted client and the protocol to be +intercepted for the client. The client-resource field is a +resource base that identifies the intercepted client. The +intercepted-protocol field specifies the protocol to intercept +for the client-resource. + + + + +Errors + +RecordContext + + + + + + + +This error is returned if the value for an RC argument +in a request does not name a defined record context. + + + + + + + +Protocol Requests + + + + + +RecordQueryVersion + + + + + +major-version, +minor-version: CARD16 + + + + +-> + + + + +major-version, +minor-version: CARD16 + + + + + +This request specifies the RECORD extension protocol version the client +would like to use. When the specified protocol version is supported +by the extension, the protocol version the server expects from the +client is returned. Clients must use this request before other RECORD +extension requests. + + + +This request also determines whether or not the RECORD extension protocol +version specified by the client is supported by the extension. If the +extension supports the version specified by the client, this version number +should be returned. If the client has requested a higher version than is +supported by the server, the server's highest version should be returned. +Otherwise, if the client has requested a lower version than is supported +by the server, the server's lowest version should be returned. This document +defines major version one (1), +minor version thirteen (13). + + + +RecordCreateContext + + + + + + + + + +context: RC + + + + +element-header: ELEMENT_HEADER + + + + +client-specifiers: LISTofCLIENTSPEC + + + + +ranges: LISTofRECORDRANGE + + + + +Errors: +Match , +Value , +IDChoice , +Alloc + + + + + + + +This request creates a new +record context +within the server and assigns the identifier context to +it. After the context is created, this request registers the +set of clients in client-specifiers with the context and +specifies the protocol to intercept for those clients. +The recorded protocol elements will be preceded by data as specified +by element-header. +Typically, +this request is used by a recording client over the control +connection. Multiple RC +objects can exist simultaneously, containing overlapping sets of +protocol and clients to intercept. + + + +If any of the values in +element-header or +ranges is invalid, a +"Value" +error results. Duplicate items in the list of client-specifiers are +ignored. If any item in the client-specifiers list is not a valid +CLIENTSPEC, a +"Match" +error results. Otherwise, each item in the client-specifiers list is +processed as follows: + + + + + +If the item is an XIDBASE identifying a particular client, the +specified client is registered with the context and the protocol +to intercept for the client is then set to ranges. + + + + +If the item is +CurrentClients , +all existing clients are registered with the +context at this time. +The protocol to intercept for all clients registered +with the context is then set to ranges. + + + + +If the item is +FutureClients , +all clients that connect to the server +after this request executes will be automatically registered with the +context. The protocol to intercept for such clients will be set to +ranges in the context. + + + + +If the item is +AllClients , +the effect is as if the actions described +for +FutureClients +are performed, followed by the actions for +CurrentClients . + + + + + +The +"Alloc" +error results when the server is unable to allocate the necessary +resources. + + + +RecordRegisterClients + + + + + + + + + +context: RC + + + + +element-header: ELEMENT_HEADER + + + + +client-specifiers: LISTofCLIENTSPEC + + + + +ranges: LISTofRECORDRANGE + + + + +Errors: +Match , +Value , +RecordContext , +Alloc + + + + + + + +This request registers the set of clients in client-specifiers with +the given context and specifies the protocol to intercept for those +clients. +The header preceding each recorded protocol element is set as specified +by element-header. +These flags affect the entire +context; their effect is not limited to the clients registered by +this request. +Typically, this request is used by a recording client over +the control connection. + + + +If context does not name a valid RC, a +"RecordContext" +error results. If any of the values in +element-header or ranges is invalid, a +"Value" +error results. Duplicate items in the list of client-specifiers are +ignored. If any item in the list of client-specifiers is not a +valid CLIENTSPEC, a +"Match" +error results. +If the context is enabled and the XID of the enabling connection +is specified, a +"Match" +error results. +Otherwise, each item in the client-specifiers list is +processed as follows: + + + + + +If the item is an XIDBASE identifying a particular client, the +specified client is registered with the context if it is not already +registered. The protocol to intercept for the client is then set to +ranges. + + + + +If the item is +CurrentClients , +all existing clients that are not +already registered with the specified context, +except the enabling connection if the context is enabled, +are registered at this +time. The protocol to intercept for all clients registered with the +context is then set to ranges. + + + + +If the item is +FutureClients , +all clients that connect to the server +after this request executes will be automatically registered with the +context. The protocol to intercept for such clients will be set to +ranges in the context. +The set of clients that are registered with the +context and their corresponding sets +of protocol to intercept are left intact. + + + + +If the item is +AllClients , +the effect is as if the actions described +for +FutureClients +are performed, followed by the actions for +CurrentClients . + + + + +The +"Alloc" +error results when the server is unable to allocate the necessary +resources. + + + +RecordUnregisterClients + + + + + + + + + +context: RC + + + + +client-specifiers: LISTofCLIENTSPEC + + + + +Errors: +Match , +RecordContext + + + + + + + + +This request removes the set of clients in client-specifiers from the +given context's set of registered clients. Typically, this request is +used by a recording client over the control connection. + + + +If context does not name a valid RC, a +"RecordContext" +error results. Duplicate items in the list of client-specifiers are +ignored. If any item in the list is not a valid CLIENTSPEC, a +"Match" +error results. Otherwise, each item in the client-specifiers list is +processed as follows: + + + + + +If the item is an XIDBASE identifying a particular client, and the +specified client is currently registered with the context, it is +unregistered, and the set of protocol to intercept for the client is +deleted from the context. If the specified client is not registered +with the context, the item has no effect. + + + + +If the item is +CurrentClients , +all clients currently registered with +the context are unregistered from it, and their corresponding sets of +protocol to intercept are deleted from the context. + + + + +If the item is +FutureClients , +clients that connect to the server after +this request executes will not automatically be registered with the +context. The set of clients that are registered with this context +and their corresponding sets of protocol that will be +intercepted are left intact. + + + + +If the item is +AllClients , +the effect is as if the actions described +for +FutureClients +are performed, followed by the actions for +CurrentClients . + + + + + +A client is unregistered automatically when it disconnects. + + + +RecordGetContext + + + + + + + + + +context: RC + + + + +-> + + + + +enabled: BOOL + + + + +element-header: ELEMENT_HEADER + + + + +intercepted-clients: LISTofCLIENT_INFO + + + + +Errors: + + + + +RecordContext + + + + + + + +This request queries the current state of the specified context +and is typically used by a recording client over the control connection. +The enabled field +specifies the state of data transfer between the extension and the +recording client, and is either enabled +( True ) +or disabled +( False ). +The initial state is disabled. +When enabled, all core X protocol and +extension protocol received from (requests) or sent to (replies, +errors, events) a particular client, and requested to be intercepted +by the recording client, is reported to the recording client over the +data connection. +The element-header specifies the header that precedes each +recorded protocol element. +The +intercepted-clients field specifies the list of clients currently +being recorded and the protocol associated with each client. +If future clients will be automatically registered with the context, +one of the returned CLIENT_INFO structures has a client-resource value +of FutureClients and an intercepted-protocol giving the protocol to +intercept for future clients. +Protocol ranges may be decomposed, coalesced, or otherwise modified +by the server from how they were specified by the client. +All CLIENTSPECs registered with the server are returned, even if the +RECORDRANGE(s) associated with them specify no protocol to record. + + + +When the context argument is not valid, a +RecordContext +error results. + + + +RecordEnableContext + + + + + + + + +context: RC + + + + +->+ + + + + +category: +{FromServer, FromClient, +ClientStarted, ClientDied, +StartOfData, +EndOfData} + + + + + +element-header: ELEMENT_HEADER + + + + +client-swapped: BOOL + + + + +id-base: XIDBASE + + + + +server-time: TIMESTAMP + + + + +recorded-sequence-number: CARD32 + + + + +data: LISTofBYTE + + + + +Errors: +Match, +RecordContext + + + + + + + +This request enables data transfer between the recording client +and the extension and returns the protocol data the recording client +has previously expressed interest in. Typically, this request is +executed by the recording client over the data connection. + + + +If the client is registered on the context, it is unregistered +before any recording begins. + + + +Once the server receives this request, it begins intercepting +and reporting to the recording client all core and extension protocol +received from or sent to clients registered with the RC that the +recording client has expressed interest in. All intercepted protocol data +is returned in the byte-order of the recorded client. Therefore, +recording clients are responsible for all byte swapping, if required. +More than one recording client cannot enable data transfer on the +same RC at the same time. Multiple intercepted requests, replies, +events and errors might be packaged into a single reply before +being returned to the recording clients. + + + +The +category field determines the possible +types of the data. +When a context is enabled, the server will immediately send a reply of +category +StartOfData +to notify the client that recording is enabled. +A category of +FromClient +means the data are from the client +(requests); +FromServer +means data are from the server (replies, +errors, events, or device events). +For a new client, the category is +ClientStarted +and the data are the connection setup reply. +When +the recorded client connection is closed, category is +set to the value +ClientDied +and no protocol is included in this reply. +When the disable request is made over the control connection, +a final reply is sent over the data connection with category +EndOfData +and no protocol. + + + +The element-header field returns the value currently set for the +context, which tells what header information precedes each recorded +protocol element in this reply. + + + +The client-swapped field is +True +if the byte order of +the protocol being recorded +is swapped +relative to the recording client; +otherwise, client-swapped is +False . +The recorded protocol +is in the byte order of the client being +recorded; device events are in the byte order of the +recording client. +For replies of category +StartOfData +and +EndOfData +the +client-swapped bit is set +according +to the byte order of the server relative to the recording client. +The id-base field is the resource identifier base +sent to the client from the server in the +connection setup reply, and hence, identifies the client being +recorded. The id-base field is 0 (zero) when the protocol +data being +returned are device events. +The server-time field is set to the time of the +server when the first protocol element in this reply was intercepted. +The server-time +of reply N+1 is greater than or equal to the server-time of reply N, +and is greater than or equal to the time of the last protocol +element in reply N. + + + +The recorded-sequence-number field is set to the sequence number +of the recorded client's most recent request processed by the server. + + + +The data field +contains the raw protocol data being returned to the recording client. +If requested by the element-header of this record context, each +protocol element may be preceded by a 32-bit timestamp and/or +a 32-bit sequence number. +If present, both the timestamp and sequence number are always in the +byte order of the recording client. + + + +For the core X events +KeyPress , +KeyRelease , +ButtonPress , +and +ButtonRelease , +the fields of a device event that contain +valid information are time and detail. +For the core X event +MotionNotify , +the fields of a device event that contain +valid information are time, root, +root-x and root-y. +The time field refers to the time the event was generated by the +device. + + + +For the extension input device events +DeviceKeyPress , +DeviceKeyRelease , +DeviceButtonPress , +and +DeviceButtonRelease , +the fields of a device event that contain valid information are +device, time and detail. +For +DeviceMotionNotify , +the valid device event fields are +device and time. +For the extension input device events +ProximityIn +and +ProximityOut , +the fields of a device event that contain valid +information are device and time. +For the extension input device event +DeviceValuator , +the fields of a device event that contain valid information are +device, +num_valuators, first_valuator, and valuators. +The time field refers to the time the event was generated by the +device. + + + +The error +"Match" +is returned when data transfer is already enabled. +When the context argument is not valid, a +RecordContext +error results. + + + +RecordDisableContext + + + + + + + + + +context: RC + + + + +Errors: +RecordContext + + + + + + + +This request is typically executed by the recording client over the +control connection. This request directs the extension to immediately +send any complete protocol elements currently buffered, +to send a final reply with category +EndOfData , +and to discontinue +data transfer between the extension and the recording client. +Protocol reporting is disabled +on the data connection that is currently enabled for the given +context. Once the extension completes +processing this request, no additional recorded protocol will +be reported to the recording client. If a data connection is not +currently enabled when this request is executed, then this request has +no affect on the state of data transfer. +An RC is disabled automatically when the connection to the enabling +client is closed down. + + + +When the context argument is not valid, a +RecordContext +error results. + + + +RecordFreeContext + + + + + +context RC + + + + + +Errors: +RecordContext + + + + + +This request deletes the association between the resource ID and the +RC and destroys the RC. +If a client has enabled data transfer on this context, the actions +described in +RecordDisableContext +are performed before the context +is freed. + + + +An RC is destroyed automatically when the connection to the creating client +is closed down and the close-down mode is DestroyAll. When the +context argument is not valid, a +RecordContext +error results. + + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this document uses +conventions established there. + + + +The name of this extension is "RECORD". + + + +Types + +RC: CARD32 + + + +RANGE8 + 1 CARD8 first + 1 CARD8 last + + + +RANGE16 + 2 CARD16 first + 2 CARD16 last + + + +EXTRANGE + 2 RANGE8 major + 4 RANGE16 minor + + + +RECORDRANGE + 2 RANGE8 core-requests + 2 RANGE8 core-replies + 6 EXTRANGE ext-requests + 6 EXTRANGE ext-replies + 2 RANGE8 delivered-events + 2 RANGE8 device-events + 2 RANGE8 errors + 1 BOOL client-started + 1 BOOL client-died + + + +ELEMENT_HEADER + 1 CARD8 + 0x01 from-server-time + 0x02 from-client-time + 0x04 from-client-sequence + + + +XIDBASE: CARD32 + + + +CLIENTSPEC + 4 XIDBASE client-id-base + 1 CurrentClients + 2 FutureClients + 3 AllClients + + + +CLIENT_INFO + 4 CLIENTSPEC client-resource + 4 CARD32 n, number of record ranges in + intercepted-protocol + 24n LISTofRECORDRANGE intercepted-protocol + + + + +Errors + + +RecordContext + 1 0 Error + 1 CARD8 extension's base error code + 0 + 2 CARD16 sequence number + 4 CARD32 invalid record context + 24 unused + + + + +Requests + + +RecordQueryVersion + 1 CARD8 major opcode + 1 0 minor opcode + 2 2 request length + 2 CARD16 major version + 2 CARD16 minor version + => + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 major version + 2 CARD16 minor version + 20 unused + + + +RecordCreateContext + 1 CARD8 major opcode + 1 1 minor opcode + 2 5+m+6n request length + 4 RC context + 1 ELEMENT_HEADER element-header + 3 unused + 4 CARD32 m, number of client-specifiers + 4 CARD32 n, number of ranges + 4m LISTofCLIENTSPEC client-specifiers + 24n LISTofRECORDRANGE ranges + + + +RecordRegisterClients + 1 CARD8 major opcode + 1 2 minor opcode + 2 5+m+6n request length + 4 RC context + 1 ELEMENT_HEADER element-header + 3 unused + 4 CARD32 m, number of client-specifiers + 4 CARD32 n, number of ranges + 4m LISTofCLIENTSPEC client-specifiers + 24n LISTofRECORDRANGE ranges + + + +RecordUnregisterClients + 1 CARD8 major opcode + 1 3 minor opcode + 2 3+m request length + 4 RC context + 4 CARD32 m, number of client-specifiers + 4m LISTofCLIENTSPEC client-specifiers + + + +RecordGetContext + 1 CARD8 major opcode + 1 4 minor opcode + 2 2 request length + 4 RC context + => + 1 1 Reply + 1 BOOL enabled + 2 CARD16 sequence number + 4 j reply length + 1 ELEMENT_HEADER element-header + 3 unused + 4 CARD32 n, number of intercepted-clients + 16 unused + 4j LISTofCLIENT_INFO intercepted-clients + + + +RecordEnableContext + 1 CARD8 major opcode + 1 5 minor opcode + 2 2 request length + 4 RC context + =>+ + 1 1 Reply + 1 category + 0 FromServer + 1 FromClient + 2 ClientStarted + 3 ClientDied + 4 StartOfData + 5 EndOfData + 2 CARD16 sequence number + 4 n reply length + 1 ELEMENT_HEADER element-header + 1 BOOL client-swapped + 2 unused + 4 XIDBASE id-base + 4 TIMESTAMP server-time + 4 CARD32 recorded-sequence-number + 8 unused + 4n BYTE data + + + +RecordDisableContext + 1 CARD8 major opcode + 1 6 minor opcode + 2 2 request length + 4 RC context + + + +RecordFreeContext + 1 CARD8 major opcode + 1 7 minor opcode + 2 2 request length + 4 RC context + + + + + diff --git a/miniconda3/envs/ladir/share/doc/scrnsaverproto/saver.xml b/miniconda3/envs/ladir/share/doc/scrnsaverproto/saver.xml new file mode 100644 index 0000000000000000000000000000000000000000..b19f0f91cf8ee4f5fa5d77dd2d0f1b369e9d9fdf --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/scrnsaverproto/saver.xml @@ -0,0 +1,943 @@ + + %defs; +]> + + + + + X11 Screen Saver Extension + MIT X Consortium Proposed Standard + X Version 11, Release &fullrelvers; + Version 1.0 + + + JimFulton + Network Computing Devices, Inc + + + KeithPackard + +X Consortium, Laboratory for Computer Science, Massachusetts Institute of Technology + + + + + 1992 + Massachusetts Institute of Technology + Network Computing Devices, Inc + + + + + +Permission to use, copy, modify, and distribute this documentation for any +purpose and without fee is hereby granted, provided that the above copyright +notice and this permission notice appear in all copies. MIT and +Network Computing Devices, Inc. make no +representations about the suitability for any purpose of the information in +this document. This documentation is provided "as is" without express or +implied warranty. + + + + + + +Introduction + +The X Window System provides support for changing the image on a display screen +after a user-settable period of inactivity to avoid burning the cathode ray +tube phosphors. However, no interfaces are provided for the user to control +the image that is drawn. This extension allows an external "screen saver" +client to detect when the alternate image is to be displayed and to provide the +graphics. + + +Current X server implementations typically provide at least one form of +"screen saver" image. Historically, this has been a copy of the X logo +drawn against the root background pattern. However, many users have asked +for the mechanism to allow them to write screen saver programs that provide +capabilities similar to those provided by other window systems. In +particular, such users often wish to be able to display corporate logos, +instructions on how to reactivate the screen, and automatic screen-locking +utilities. This extension provides a means for writing such clients. + + + + +Assumptions + +This extension exports the notion of a special screen saver window that is +mapped above all other windows on a display. This window has the +override-redirect attribute set so that it is not subject to manipulation by +the window manager. Furthermore, the X identifier for the window is never +returned by QueryTree requests on the root window, so it is typically +not visible to other clients. + + + + +Overview + +The core +SetScreenSaver +request can be used to set the length of time without +activity on any input devices after which the screen saver should "activate" +and alter the image on the screen. This image periodically "cycles" to +reduce +the length of time that any particular pixel is illuminated. Finally, the +screen saver is "deactivated" in response to activity on any of the input +devices +or particular X requests. + + + +Screen saving is typically done by disabling video output to the display tube +or by drawing a changing pattern onto the display. If the server chooses the +latter approach, a window with a special identifier is created and mapped at +the top of the stacking order where it remains until the screen saver +deactivates. At this time, the window is unmapped and is not accessible to any +client requests. + + +The server's default mechanism is referred to as the internal screen +saver. An external +screen saver client requires a means of determining the window +id for the screen saver window and setting the attributes (e.g. size, +location, visual, colormap) to be used when the window is mapped. These +requirements form the basis of this extension. + + + + +Issues + +This extension raises several interesting issues. First is the question of +what should be done if some other client has the server grabbed when the screen +saver is supposed to activate? This commonly occurs with window managers that +automatically ask the user to position a window when it is first mapped by +grabbing the server and drawing XORed lines on the root window. + + +Second, a screen saver program must control the actual RGB values sent to the +display tube to ensure that the values change periodically to avoid phosphor +burn in. Thus, the client must have a known colormap installed whenever the +screen saver window is displayed. To prevent screen flashing, the visual type +of the screen saver window should also be controllable. + + +Third, some implementations may wish to destroy the screen saver window when +it is not mapped so that it need not be avoided during event delivery. Thus, +screen saver clients may find that the requests that reference the screen +saver window may fail when the window is not displayed. + + + + +Protocol + +The Screen Saver extension is as follows: + + + +Types + +In addition to the common types described in the core protocol, the following +type is used in the request and event definitions in subsequent sections. + + + + + + + + + + Name + Value + + + + + SCREENSAVEREVENT + ScreenSaverNotify, + ScreenSaverCycle + + + + + + + +Errors + +The Screen Saver extension adds no errors beyond the core protocol. + + + + +Requests + +The Screen Saver extension adds the following requests: + + + +ScreenSaverQueryVersion + client-major-version: CARD8 + client-minor-version: CARD8 +-> + server-major-version: CARD8 + server-minor-version: CARD8 + + + +This request allows the client and server to determine which version of +the protocol should be used. The client sends the version that it +prefers; if the server understands that +version, it returns the same values and interprets subsequent requests +for this extension according to the specified version. Otherwise, +the server returns the closest version of the protocol that it can +support and interprets subsequent requests according to that version. +This document describes major version 1, minor version 0; the major +and minor revision numbers should only be incremented in response to +incompatible and compatible changes, respectively. + + + +ScreenSaverQueryInfo +drawable DRAWABLE + +saver-window: WINDOW +state: {Disabled, Off, On} +kind: {Blanked, Internal, External} +til-or-since: CARD32 +idle: CARD32 +event-mask: SETofSCREENSAVEREVENT + +Errors: Drawable + + + +This request returns information about the state of the screen +saver on the screen associated with drawable. The saver-window +is the XID that is associated with the screen saver window. This +window is not guaranteed to exist +except when external screen saver is active. Although it is a +child of the root, this window is not returned by +QueryTree +requests on the root. Whenever this window is mapped, it is always above +any of its siblings in the stacking order. XXX - TranslateCoords? + + +The state field specifies whether or not the screen saver is currently +active and how the til-or-since value should be interpreted: + + + + + + + + + + Off + +The screen is not currently being saved; +til-or-since +specifies the number of milliseconds until the screen saver is expected to +activate. + + + + On + +The screen is currently being saved; +til-or-since specifies +the number of milliseconds since the screen saver activated. + + + + Disabled + +The screen saver is currently disabled; +til-or-since is zero. + + + + + + + +The kind field specifies the mechanism that either is currently being +used or would have been were the screen being saved: + + + + + + + + + + Blanked + The video signal to the display monitor was disabled. + + + Internal + A server-dependent, built-in screen saver image was displayed; either no + client had set the screen saver window attributes or a different client + had the server grabbed when the screen saver activated. + + + External + The screen saver window was mapped with attributes set by a + client using the ScreenSaverSetAttributes request. + + + + + + +The idle field specifies the number of milliseconds since the last +input was received from the user on any of the input devices. + + + +The event-mask field specifies which, if any, screen saver +events this client has requested using ScreenSaverSelectInput. + + + +If drawable is not a valid drawable identifier, a Drawable +error is returned and the request is ignored. + + + +ScreenSaverSelectInput +drawable: DRAWABLE +event-mask: SETofSCREENSAVEREVENT + + + +Errors: +Drawable, +Match + + + +This request specifies which Screen Saver extension events on the screen +associated with drawable should be generated for this client. If +no bits are set in event-mask, then no events will be generated. +Otherwise, any combination of the following bits may be set: + + + + + + + + + + ScreenSaverNotify + +If this bit is set, ScreenSaverNotify events are generated whenever +the screen saver is activated or deactivated. + + + + ScreenSaverCycle + +If this bit is set, ScreenSaverNotify events are generated whenever +the screen saver cycle interval passes. + + + + + + + +If drawable is not a valid drawable identifier, a Drawable +error is returned. If any undefined bits are set in event-mask, +a Value error is returned. If an error is returned, +the request is ignored. + + + +ScreenSaverSetAttributes + + +drawable: DRAWABLE +class: +{InputOutput, InputOnly, CopyFromParent} +depth: CARD8 +visual: VISUALID or CopyFromParent +x, y: INT16 +width, height, border-width: CARD16 +value-mask: BITMASK +value-list: LISTofVALUE + +Access, Window, Pixmap, Colormap, Cursor, Match, Value, Alloc + + + +This request sets the attributes that this client would like to see +used in creating the screen saver window on the screen associated +with drawable. If another client currently has the attributes set, +an Access error is generated and the request is ignored. + + + +Otherwise, the specified window attributes are checked as if +they were used in a core CreateWindow request whose +parent is the root. The override-redirect field is ignored as +it is implicitly set to True. If the window attributes result in an +error according to the rules for CreateWindow, the request is ignored. + + +Otherwise, the attributes are stored and will take effect on the next +activation that occurs when the server is not grabbed by another client. +Any resources specified for the +background-pixmap or cursor attributes may be +freed immediately. The server is free to copy the background-pixmap +or cursor resources or to use them in place; therefore, the effect of +changing the contents of those resources is undefined. If the +specified colormap no longer exists when the screen saver activates, +the parent's colormap is used instead. If no errors are generated by this +request, any previous +screen saver window attributes set by this client are released. + + +When the screen saver next activates and the server is not grabbed by +another client, the screen saver window is +created, if necessary, and set to the specified attributes and events +are generated as usual. The colormap +associated with the screen saver window is +installed. Finally, the screen saver window is mapped. + + +The window remains mapped and at the top of the stacking order +until the screen saver is deactivated in response to activity on +any of the user input devices, a ForceScreenSaver request with +a value of Reset, or any request that would cause the window to be +unmapped. + + +If the screen saver activates while the server is grabbed by another +client, the internal saver mechanism is used. The ForceScreenSaver +request may be used with a value of Active to +deactivate the internal saver and activate the external saver. + + +If the screen saver client's connection to the server is broken +while the screen saver is activated and the client's close down mode has not +been RetainPermanent or RetainTemporary, the current screen saver +is deactivated and the internal screen saver is immediately activated. + + +When the screen saver deactivates, the screen saver window's colormap +is uninstalled and the window is unmapped (except as described below). +The screen saver XID is disassociated +with the window and the server may, but is not required to, +destroy the window along with any children. + + +When the screen saver is being deactivated and then immediately +reactivated (such as when switching screen savers), the server +may leave the screen saver window mapped (typically to avoid +generating exposures). + + + +ScreenSaverUnsetAttributes + + + +drawble: DRAWABLE + +Errors: Drawable + + + +This request notifies the server that this client no longer +wishes to control the screen saver window. Any screen saver +attributes set by this client and any descendents of the screen +saver window created by this client should be released +immediately if the screen saver is not active, else upon +deactivation. + + +This request is ignored if the client has not previously set the screen saver +window attributes. + + + + +Events + +The Screen Saver extension adds one event: + + +ScreenSaverNotify + + + +root: WINDOW +window: WINDOW +state: {Off, On, Cycle} +kind: { Blanked, Internal , External } +forced: BOOL +time: TIMESTAMP + + +This event is delivered to clients that have requested +ScreenSaverNotify events using the ScreenSaverSelectInput request +whenever the screen saver activates or deactivates. + + +The root field specifies root window of the screen for +which the event was generated. The window field specifies +the value that is returned by ScreenSaverQueryInfo as +the identifier for the screen saver window. This window is not +required to exist if the external screen saver is not active. + + +The state field specifies the cause of the event: + + + + + + + + + + Off + +The screen saver deactivated; this event is sent if the client has set the +ScreenSaverNotify bit in its event mask. + + + + On + +The screen saver activated. This event is sent if the client has set the +ScreenSaverNotify bit in its event mask. + + + + Cycle + +The cycle interval passed and the client is expected to change the image on +the screen. This event is sent if the client has set the +ScreenSaverCycle bit in its event mask. + + + + + + + +If state is set to +On or +Off +then forced indicates whether or not +activation or deactivation was caused by a core +ForceScreenSaver +request; otherwise, forced is set to False. + + + +The kind field specifies mechanism that was used to save the screen +when the screen saver was activated, as described in +ScreenSaverQueryInfo. + + + +The time field indicates the server time +when the event was generated. + + + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this document uses +conventions established there. + + +The name of this extension is "SCREEN-SAVER". + + + +Common Types + +SETofSCREENSAVEREVENT + #x00000001 ScreenSaverNotifyMask + #x00000002 ScreenSaverCycleMask + + + + +Requests + +ScreenSaverQueryVersion +1 CARD8 screen saver opcode +1 0 minor opcode +2 2 request length +1 CARD8 client major version +1 CARD8 client minor version +2 unused +-> +1 1 Reply +1 unused +2 CARD16 sequence number +4 0 reply length +1 CARD8 server major version +1 CARD8 server minor version +22 unused + +ScreenSaverQueryInfo +1 CARD8 screen saver opcode +1 1 minor opcode +2 2 request length +4 DRAWABLE drawable associated with screen +-> +1 1 Reply +1 CARD8 state + 0 Off + 1 On + 3 Disabled +2 CARD16 sequence number +4 0 reply length +4 WINDOW saver window +4 CARD32 milliseconds until saver or since saver +4 CARD32 milliseconds since last user device input +4 SETofSCREENSAVEREVENT event mask +1 CARD8 kind + 0 Blanked + 1 Internal + 2 External +10 unused + +ScreenSaverSelectInput +1 CARD8 screen saver opcode +1 2 minor opcode +2 3 request length +4 DRAWABLE drawable associated with screen +4 SETofSCREENSAVEREVENT event mask + +ScreenSaverSetAttributes +1 CARD8 screen saver opcode +1 3 minor opcode +2 6+n request length +4 DRAWABLE drawable associated with screen +2 INT16 x +2 INT16 y +2 CARD16 width +2 CARD16 height +2 CARD16 border-width +1 class + 0 CopyFromParent + 1 InputOutput + 2 InputOnly +1 CARD8 depth +4 VISUALID visual + 0 CopyFromParent +4 BITMASK value-mask (has n bits set to 1) + encodings are the same as for core CreateWindow +4n LISTofVALUE value-list + encodings are the same as for core CreateWindow + +ScreenSaverUnsetAttributes +1 CARD8 screen saver opcode +1 4 minor opcode +2 3 request length +4 DRAWABLE drawable associated with screen + + + + +Events + + +ScreenSaverNotify +1 CARD8 code assigned by core +1 CARD8 state + 0 Off + 1 On + 2 Cycle +2 CARD16 sequence number +4 TIMESTAMP time +4 WINDOW root +4 WINDOW screen saver window +1 CARD8 kind + 0 Blanked + 1 Internal + 2 External +1 BOOL forced +14 unused + + + + + +Inter-Client Communications Conventions + +Screen saver clients should create at least one resource value whose +identifier can be stored in a property named +_SCREEN_SAVER_ID +on the root of each screen it is managing. +This property should have one 32-bit value corresponding to the resource +identifier; the type of the property should indicate the type of the +resource and should be one of the following: +WINDOW, +PIXMAP, +CURSOR, +FONT, or +COLORMAP. + + + + +C language binding + + +The C binding for this extension simply provide access to the protocol; they +add no semantics beyond what is described above. + + + +The include file for this extension is +<X11/extensions/scrnsaver.h>. + + + + + + Bool XScreenSaverQueryExtension + Display *display + int *event_base + int *error_base + + + + +This routine returns +True +if the specified display supports the +SCREEN-SAVER extension; otherwise it returns +False. +If the extension is supported, the event number for +ScreenSaverNotify +events is returned in the value pointed to by +event_base. Since +no additional errors are defined by this extension, the results +of error_base are not defined. + + + + + Status XScreenSaverQueryVersion + Display *display + int *major + int *minor + + + + +If the specified display supports the +extension, the version numbers of the protocol +expected by the server are returned in +major and +minor and +a non-zero value is returned. Otherwise, the arguments are not +set and 0 is returned. + + +XScreenSaverInfo * +XScreenSaverAllocInfo() + + +This routine allocates and returns an +XScreenSaverInfo structure +for use in calls to . +All fields in the +structure are initialized to zero. If insufficient memory is available, +NULL is returned. The results of this routine can be released +using XFree. + + + + + Status XScreenSaverQueryInfo + Display *display + Drawable drawable + XScreenSaverInfo *saver_info + + + + +If the specified display supports the extension, +information about the current state of the +screen server is returned in saver_info and a non-zero value is +returned. The XScreenSaverInfo structure is +defined as follows: + + + +typedef struct { + Window window; /* screen saver window */ + int state; /* ScreenSaver{Off,On,Disabled} */ + int kind; /* ScreenSaver{Blanked,Internal,External} */ + unsigned long til_or_since; /* milliseconds */ + unsigned long idle; /* milliseconds */ + unsigned long event_mask; /* events */ +} XScreenSaverInfo; + + + +See the ScreenSaverQueryInfo request for a +description of the fields. If the extension is not supported, +saver_info is not changed and 0 +is returned. + + + + + void XScreenSaverSelectInput + Display *display + Drawable drawable + unsigned long event_mask + + + + +If the specified display supports the extension, +this routine asks that events related to +the screen saver be generated for this client. +The format of the events generated is: + + + +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 request */ + Display *display; /* Display the event was read from */ + Window window; /* screen saver window */ + Window root; /* root window of event screen */ + int state; /* ScreenSaver{Off,On,Cycle} */ + int kind; /* ScreenSaver{Blanked,Internal,External} */ + Bool forced; /* extents of new region */ + Time time; /* event timestamp */ +} XScreenSaverNotifyEvent; + + + +See the definition of the +ScreenSaverSelectInput request for descriptions +of the allowed event masks. + + + + + void XScreenSaverSetAttributes + Display *dpy + Drawable drawable + int x + int y + unsigned int width + unsigned int height + unsigned int border_width + int depth + unsigned int class + Visual *visual + unsigned long valuemask + XSetWindowAttributes *attributes + + + + +If the specified display supports the +extension, this routine sets the attributes to be used +the next time the external screen saver is activated. See the definition +of the ScreenSaverSetAttributes request for a +description of each of the arguments. + + + + + void XScreenSaverUnsetAttributes + Display *display + Drawable drawable + + + + +If the specified display supports the +extension, this routine instructs the server to discard +any previous screen saver window attributes set by this client. + + + + + Status XScreenSaverRegister + Display *display + int screen + XID xid + Atom type + + + + +This routine stores the given XID in the +_SCREEN_SAVER_ID property (of the given +type) on the root window of the specified +screen. It returns zero if an error +is encountered and the property is not changed, otherwise it returns +non-zero. + + + + + Status XScreenSaverUnregister + Display *display + int screen + + + + +This routine removes any _SCREEN_SAVER_ID from the +root window of the specified screen. +It returns zero if an error is encountered and the property is changed, +otherwise it returns non-zero. + + + + + Status XScreenSaverGetRegistered + Display *display + int screen + XID *xid + ATOM *type + + + + + +This routine returns the +XID and +type stored in the +_SCREEN_SAVER_ID property on the +root window of the specified screen. +It returns zero if an error +is encountered or if the property does not exist or is not of the correct +format; otherwise it returns non-zero. + + + + diff --git a/miniconda3/envs/ladir/share/doc/xcmiscproto/xc-misc.xml b/miniconda3/envs/ladir/share/doc/xcmiscproto/xc-misc.xml new file mode 100644 index 0000000000000000000000000000000000000000..f2dfec2b8f4b0dfbd57467410f0949a865d60c5d --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xcmiscproto/xc-misc.xml @@ -0,0 +1,201 @@ + + %defs; +]> + + + + + + XC-MISC Extension + X Consortium Standard + + + BobScheifler + X Consortium + + + DavidP.Wiggins + X Consortium + + + X Version 11, Release &fullrelvers; + Version 1.1 + 1994X Consortium + + + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +Except as contained in this notice, the name of the X Consortium shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the X Consortium. + +X Window System is a trademark of The Open Group. + + + + + +Overview + +When an X client connects to an X server, it receives a fixed range of +resource IDs to use to identify the client's resources inside the X +server. Xlib hands these out sequentially as needed. When it +overruns the end of the range, an IDChoice protocol error results. +Long running clients, or clients that use resource IDs at a rapid +rate, may encounter this circumstance. When it happens, there are +usually many resource IDs available, but Xlib doesn't know about them. + +One approach to solving this problem would be to have Xlib notice when +a resource is freed and recycle its ID for future use. This strategy +runs into difficulties because sometimes freeing one resource causes +others to be freed (for example, when a window is destroyed, so are +its children). To do a complete job, Xlib would have to maintain a +large amount of state that currently resides only in the server (the +entire window tree in the above example). Even if a less +comprehensive strategy was adopted, such as recycling only those IDs +that Xlib can identify without maintaining additional state, the +additional bookkeeping at resource creation and destruction time +would likely introduce unacceptable overhead. + +To avoid the problems listed above, the server's complete knowledge of +all resource IDs in use by a client is leveraged. This extension +provides two ways for Xlib to query the server for available resource +IDs. Xlib can use these extension requests behind the scenes when it has +exhausted its current pool of resource IDs. + + + +Requests + + +XCMiscGetVersion + + + client_major_version: CARD16 + client_minor_version: CARD16 + + => + + client_major_version: CARD16 + client_minor_version: CARD16 + + +If supplied, the client_major_version and +client_minor_version indicate what version of +the protocol the client wants the server to implement. The server version +numbers returned indicate the protocol this extension actually supports. This +might not equal the version sent by the client. An implementation can +(but need not) support more than one version simultaneously. The +server_major_version and the server_minor_version are a +mechanism to support future revisions of the XC-MISC protocol +which may be necessary. In general, the major version would increment +for incompatible changes, and the minor version would increment for +small, upward-compatible changes. Servers that support the protocol +defined in this document will return a +server_major_version of one (1), and a +server_minor_version of one (1). + +XCMiscGetXIDRange + + => + + start_id: XID + count: CARD32 + + +This request returns a range of available resource IDs for the client +issuing the request. start_id is the first +ID in the range. count is the number of IDs +in the range. The returned range may or may not be the largest possible +range. + +XCMiscGetXIDList + + + count: CARD32 + + => + + ids: LISTofXID + + +This request returns the a list of individual resource IDs in +ids. +count is the number of resource IDs requested. +The number returned may be smaller than the number requested. + + + +Events and Errors + +No new events or errors are defined by this extension. + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this document uses +conventions established there. + +The name of this extension is “XC-MISC”. + + +XCMiscGetVersion + 1 CARD8 opcode + 1 0 XC-MISC opcode + 2 2 request length + 2 CARD16 client_major_version + 2 CARD16 client_minor_version + + => + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 2 CARD16 server_major_version + 2 CARD16 server_minor_version + 20 unused + + + +XCMiscGetXIDRange + 1 CARD8 opcode + 1 1 XC-MISC opcode + 2 1 request length + + => + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 4 XID start_id + 4 CARD32 count + 16 unused + + + + +XCMiscGetXIDList + 1 CARD8 opcode + 1 2 XC-MISC opcode + 2 2 request length + 4 CARD32 count + + => + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 CARD32 length + 4 CARD32 number of XIDs in ids + 20 unused + 4n LISTofXID ids + + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/appendix.xml b/miniconda3/envs/ladir/share/doc/xextproto/appendix.xml new file mode 100644 index 0000000000000000000000000000000000000000..b6c0f1de3205533ce8368ed9a05dc6be72f0e090 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/appendix.xml @@ -0,0 +1,61 @@ + + + +System Window Encodings + + +The AppGroupCreateAssoc request has the following possible variations: + + + +AppGroupCreateAssoc (X11) + 1 CARD8 opcode + 1 6 XC-APPGROUP opcode + 2 n length + 4 WINDOW window + 2 0 window_type + 2 4 system_window_len + 4 WINDOW Window + + + +AppGroupCreateAssoc (Macintosh) + 1 CARD8 opcode + 1 6 XC-APPGROUP opcode + 2 n length + 4 WINDOW window + 2 1 window_type + 2 12 system_window_len + 4 CARD32 WindowPtr + 2 INT16 Rect.top + 2 INT16 Rect.left + 2 INT16 Rect.bottom + 2 INT16 Rect.right + + + +AppGroupCreateAssoc (Win32) + 1 CARD8 opcode + 1 6 XC-APPGROUP opcode + 2 n length + 4 WINDOW window + 2 2 window_type + 2 4 system_window_len + 4 CARD32 HWND + + + +AppGroupCreateAssoc (Win16) + 1 CARD8 opcode + 1 6 XC-APPGROUP opcode + 2 n length + 4 WINDOW window + 2 3 window_type + 2 4 system_window_len + 2 CARD16 HWND offset + 2 CARD16 HWND segment + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/appgrp.xml b/miniconda3/envs/ladir/share/doc/xextproto/appgrp.xml new file mode 100644 index 0000000000000000000000000000000000000000..5e27a63fcde8f0f6782525588ae642f6de447782 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/appgrp.xml @@ -0,0 +1,1041 @@ + + %defs; +]> + +
+ + + Application Group Extension to the X Protocol + X Consortium Standard + + + Kaleb + S. + KEITHLEY + X Consortium, Inc + kaleb@x.org + + + X Version 11, Release &fullrelvers; + Version 1.0 + 1996X Consortium, Inc. + + + + +All Rights Reserved. + + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, +DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT +OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE +OR THE USE OF OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the name of the X Consortium shall not be used in advertising +or otherwise to promote the sale, use or other dealings in this Software without prior written +authorization from the X Consortium. + +X Window System is a trademark of The OpenGroup. + + +27 September 1996 + + + +The Application Group Extension to the X protocol is intended to provide a framework to allow +more than one program to manage X applications on the desktop. The initial use of this extension +will be to insert or embed the windows of X programs into the windows of another program, such +as a web browser. This extension is not intended to address larger embedding issues that, for +example, OpenDoc does, such as shared menu bars, etc. + + + + + +Purpose and Goals + + +The Application Group Extension to the X protocol is intended to provide +a framework to allow more than one program to manage X applications on +the desktop. The initial use of this extension will be to insert or embed +the windows of X programs into the windows of another program, such as a +web browser. This extension is not intended to address larger embedding +issues that, for example, OpenDoc does, such as shared menu bars, etc. +Using X programs on the World Wide Web allows for greater control of the +presentation and takes advantage of the existing body of X programs rather +than re-implement them in another language. In addition it allows the +embedding of non-X programs into web browsers by using third party products +like Wabi, MAE, and WinCenter. + +Wabi is a trademark of Sun Microsystems, Inc. MAE is a trademark of Apple +Computer, Inc. WinCenter is a trademark of Network Computing Devices, Inc. + + + + + + +Overview of the protocol. + + +This extension introduces the concept of an Application Group. An Application Group is a set of one or more applications that are primarily managed by a special application known as the Application Group Leader, which, for example, might be a web browser. The primary purpose of Application Groups is to provide a means of sharing the Substructure-Redirect attribute of the root window between the window manager and one or more Application Group Leaders. + + + +To join an Application Group an application must present the proper authorization during the connection setup. Authorizations are generated by the X server at the request of an Application Group Leader, and are then stored for the application to use to establish its connection to the X server. To generate an authorization the Application Group Leader sends a request to the server naming the Application Group to which the authorization will be bound, and any applications that connect using that authorization will automatically become part of the associated Application Group. The protocol to generate an authorization is defined in the Security Extension specification. + + + +As a member of an Application Group, when an application creates and maps a window as a child of the root window, the MapRequest and ConfigureRequest events are delivered to the Application Group Leader instead of the window manager. The Application Group Leader may then reparent the window into its own window hierarchy; or reissue the map request, in which case the window comes under the control of the window manager. + + + + +Requests + + +AppGroupQueryVersion + + + + + + + + client_major_version: CARD16 + + + client_minor_version: CARD16 + + + => + + + server_major_version: CARD16 + + + server_minor_version: CARD16 + + + + + + +If supplied, the client_major_version and client_minor_version indicate what version of the protocol the application wants the server to implement. The server version numbers returned indicate the version of the protocol the X server actually supports. This may not match the versions requested by the application. An implementation may (but need not) support more than one version simultaneously. The server_major_version and server_minor_version numbers are a mechanism to support any future revisions of the Application Group extension protocol which may be necessary. In general, the major version would increment for incompatible changes, and the minor version would increment for small, upward-compatible changes. X servers that support the protocol defined in this document will return a server_major_version of 1 and a server_minor_version of 0. + + + +AppGroupCreate + + + + + + + + app_group: APPGROUP + + + value_mask: BITMASK + + + value_list: LISTofVALUE + + + + + + +This request creates an Application Group using app_group as the Application Group ID. + + + + +  + + + + +The value_mask and value_list specify attributes of the Application Group that are to be explicitly initialized. The attributes, their types, and the default values are: + + + + + + + + + + + Attribute + Type + Default + + + app_group_leader + Bool + True + + + single_screen + Bool + True + + + default_root + Window + None + + + root_visual + VisualID + None + + + default_colormap + Colormap + None + + + black_pixel + Pixel + 0 + + + white_pixel + Pixel + 0 + + + + + + +If the single_screen attribute is True then the number of video screens returned to a program in the Application Group in the connection setup message is one, irrespective of how many video screens the server actually has. If a server supports both video and print screens, then all print screens will always be returned. If single_screen is specified as True then the connection setup message will contain only the information about the video screen which has default_root as its root window, plus any print screens. + + + +The intent is to allow an embedding manager to ensure that it will be able to reparent any top-level windows that Application Group members create. By hiding the fact that there are other screens it can be reasonably assured that applications will only create top-level windows on the same screen that it itself appears on. An embedding manager should take care not to supply an invalid display, e.g. :0.1, to a program that will be in an Application Group where the single_screen attribute is True. + + + +If single_screen is set to True default_root specifies which screen will be returned as screen zero in the connection setup message for applications in the Application Group. If set to None, then the real screen zero is used, otherwise the screen which has default_root as its root window will be used. + + + + +If single_screen is set to True the root_visual and default_colormap attributes may be used to over-ride the default values that are returned in the connection setup information returned to new programs in the Application Group. If None is specified for root_visual or default_colormap then the normal default values for the screen (possibly specified by default_root) are used, otherwise the specified values are used. If root_visual and/or default_colormap are specified they must be valid, i.e. root_visual must be a visual type available on the screen, and the colormap, if specified, must be a valid colormap for the visual that is used. + + + +IF single_screen is set to True and default_colormap is not specified as None, the black_pixel and white_pixel attributes must be specified, and they will over-ride the default values that are returned in the connection setup returned to new programs in the Application Group. If default_colormap is specified as None and black_pixel and/or white_pixel are specified, they will be ignored. + + + +The app_group_leader attribute is used to identify the Application Group Leader program for the app_group. By specifying True the server will identify the program making the request as the Application Group Leader for the application group. The Application Group Leader receives MapRequest and ConfigureRequest events from the server when an attempt is made to map or configure top-level windows of a program in an Application Group, instead of being sent to a window manager that has selected SubstructureRedirect events on the root window. The parent window field in these events will contain the Application Group ID. + + +AppGroupDestroy + +app_group: APPGROUP + + + +This request destroys the app_group. If the app_group_leader attribute for the app_group is True, then any applications in the Application Group that are still connected will be killed as if a KillClient request had been received for that application. + + + +If the application that created a non-embedded Application Group exits, and therefore any Authorizations to be cancelled, and any applications that attempt to open new connections to the X server using one of those Authorizations will be unable to do so. + + +AppGroupGetAttr + + + + + + + + + >app_group: APPGROUP + + + => + + + LISTofVALUE + + + + + + +This request returns the application group attributes for app_group. + + +AppGroupQuery + + + + + + + + resource: XID + + + => + + + app_group: APPGROUP + + + + + + +This request returns the Application Group ID of the application that created resource or None if that application is not associated with any Application Group. The resource value may be the resource base of the application. + + +AppGroupCreateAssociation + + + + + + + + window: WINDOW + + + window_type: CARD32 + + + system_window: LISTofCARD8 + + + + + + +This request associates window with system_window. The window_type indicates the native window system of the application making the request. For non-X window_types both the embedding manager and the server must be executing on the same host. When system_window is Microsoft Windows or OS/2 Presentation Manager, the system_window is an HWND; when the native window system is Macintosh, the system_window is a WindowPtr and a Rect. The window may be used for any X request that takes a Window. + + +AppGroupDestroyAssociation + + + + + + + + window: WINDOW + + + + + + +This request destroys the association created with AppGroupCreateAssociation. The window is destroyed. The system_window that was specified in the AppGroupCreateAssociation request is not affected. + + + + + +Changes to Existing Requests + + +MapWindow + + +If the override-redirect attribute of the window is False and if the window is a child of a root window and if the window belongs to an application that is in an application group and if some other application is the application group leader for that group, then a MapRequest event is generated and the window remains unmapped. Otherwise, the core protocol semantics apply. + + + + +ConfigureWindow + + +If the override-redirect attribute of the window is False and if the window is a child of a root window and if the window belongs to an application that is in an application group and if some other application is the application group leader for that group, then a ConfigureRequest event is generated and the window remains unchanged. Otherwise, the core protocol semantics apply. + + + + +CreateWindow + + +When a program in an Application Group creates a window that is a child of a root window and specifies CopyFromParent for the Visual, if the single_screen attribute is True and the root_visual attribute is set to something other than None, then the window will be created using the Application Group’s root_visual, otherwise core protocol semantics apply. + + + +When a program in an Application Group creates a window that is a child of a root window and specifies CopyFromParent for the Colormap, if the single_screen attribute is True, the default_colormap attribute is set to something other than None, and the window’s Visual is the same as the Application Group’s root_visual attribute, then the window will be created using the Application Group’s default_colormap, otherwise core protocol semantics apply. + + + + + +ChangeWindowAttributes + + +When a program in an Application Group changes the attributes of a window that is a child of a root window and specifies CopyFromParent for the Colormap, if the single_screen attribute is True, the default_colormap attribute is set to something other than None, and the window’s Visual is the same as the Application Group’s root_visual attribute, then the window will be created using the Application Group’s default_colormap, otherwise core protocol semantics apply. + + + + + + + +Changes to Existing Events + + +When the top-level window of an application that is a member of an Application Group is the target of a MapWindow or ConfigureWindow request, if there is an Application Group Leader then MapRequest and ConfigureRequest events are automatically delivered to it, otherwise the core protocol semantics apply, i.e. they are delivered to the client, if any, that has SubstructureRedirect set in its root-window event mask, e.g. the window manager. + + + +The Application Group Leader must not select SubstructuRedirect events on a root window as doing so would result in a core protocol error; only one client is permitted to do so, and that is usually the window manager. + + + + +MapRequest + + +When a MapWindow request is received for a window whose override-redirect attribute is set to False and whose parent is the root window and the window belongs to an application that is in an application group and there is an application group leader for the group, then this event is delivered to the Application Group Leader with the parent field in the event set to the AppGroup ID. Otherwise the core protocol semantics apply. + + + + +ConfigureRequest + + +When a ConfigureWindow request is received for a window whose override-redirect attribute is set to False and whose parent is the root window and the window belongs to an application that is in an application group and there is an application group leader for the group, then this event is delivered to the Application Group Leader with the parent field in the event set to the AppGroup ID. Otherwise the core protocol semantics apply. + + + + + + +Errors + + +AppGroupQueryVersion + + +There are no errors for AppGroupQueryVersion. + + + + + +AppGroupCreate + + +A Window error is returned if default_root is specified and is not a valid root window.. + + + +A Color error is returned default_colormap is specified but default_colormap is not a valid colormap for the screen of default_root. + + + +A Match error is returned if root_visual and default_colormap are both specified, but + + + +default_colormap’s visual is not root_visual. + + + +A Match error is returned if root_visual does not exist for the screen of the default_root. + + + + + +AppGroupDestroy + + +An AppGroup error is returned if app_group is not a valid Application Group. + + + +An Access error is returned if an untrusted application attempts to destroy an Application Group created by a trusted application. + + + + + +AppGroupGetAttr + + +An AppGroup error is returned if app_group is not a valid Application Group. + + + +An Access error is returned if an untrusted application attempts to get the attributes of an Application Group created by a trusted application. + + + + + +AppGroupQuery + + +An Access error is returned if an untrusted application attempts to query the Application Group of a trusted application. + + + + + +AppGroupCreateAssociation + + +A Match error is returned if the X server does not support the window_type. + + + +An Access error may be returned if the X server only supports the window_type on the local host and the program making the request is on a non-local host. + + + +A Window error may be returned for system-specific errors related to system_window, e.g. system_window does not represent a valid native window. + + + + + +AppGroupDestroyAssociation + + +A Window error is returned if window was not specified in a previous AppGroupCreateAssociation request. + + + + + + +Encoding + + +Please refer to the X11 Protocol encoding document as this document uses conventions established there. + + + + +The name of this extension is XC-APPGROUP + + + + +AppGroupQueryVersion + 1 CARD8 opcode + 1 0 XC-APPGROUP opcode + 2 3 length + 2 CARD16 client_major_version + 2 CARD16 client_minor_version +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence_number + 4 0 length + 2 CARD16 server_major_version + 2 CARD16 server_minor_version + 20 unused + + + + +AppGroupCreate + 1 CARD8 opcode + 1 1 XC-APPGROUP opcode + 2 8+n length + 4 XID app_group + 4 BITMASK attrib_mask + #x00000001 app_group_leader + #x00000002 single_screen + #0x0000004 default_root + #x00000008 root_visual + #x00000010 default_colormap + #x00000020 black_pixel + #x00000040 white_pixel + n LISTofVALUE value-list +VALUEs + 4 BOOL app_group_leader + 4 BOOL single_screen + 4 WINDOW default_root + 4 VISUALID root_visual + 4 COLORMAP default_colormap + 4 CARD32 black_pixel + 4 CARD32 white_pixel + + + + +AppGroupDestroy + 1 CARD8 opcode + 1 2 XC-APPGROUP opcode + 2 2 length + 4 XID app_group + + + +AAppGroupGetAttr + 1 CARD8 opcode + 1 4 XC-APPGROUP opcode + 2 2 length + 4 XID app_group +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence_number + 4 0 length + 4 WINDOW default_root + 4 VISUALID root_visual + 4 COLORMAP default_colormap + 4 CARD32 black_pixel + 4 CARD32 whte_pixel + 1 BOOL single_screen + 1 BOOL app_group_leader + 2 unused + + + + +AppGroupQuery + 1 CARD8 opcode + 1 5 XC-APPGROUP opcode + 2 2 length + 4 XID resource +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence_number + 4 0 length + 4 XID app_group + 20 unused + + + +AppGroupCreateAssoc + 1 CARD8 opcode + 1 6 XC-APPGROUP opcode + 2 n length + 4 WINDOW window + 2 CARD16 window_type + #0 X11 + #1 Macintosh + #2 Win32, OS/2 PM 2.x + #3 Win16, OS/2 PM 1.x + 2 n system_window_len + n LISTofCARD8 system_window + + + + +AppGroupDestroyAssoc + 1 CARD8 opcode + 1 7 XC-APPGROUP opcode + 2 2 length + 4 WINDOW window + + + + + +Library API + + + + + + + + +Status XagQueryVersion ( xkb, keycode) /* macro */ + + + + +Display dpy; + + + + +int * major_version_return; + + + + +int * minor_version_return; + + + + + + + +XagQueryVersion sets major_version_return and minor_version_return to the major and minor Application Group protocol version supported by the server. If the Xag library is compatible with the version returned by the server it returns non-zero. If dpy does not support the Application Group extension, or if the server and library protocol versions are incompatible, or if there was an error during communication with the server, it returns zero. No other Xag functions may be called before this function. If a program violates this rule, the effects of all subsequent Xag calls that it makes are undefined. + + + +An embedding manager in, e.g. a Personal Computer Web Browser, will need to open a connection to the Personal Computer X server by calling XOpenDisplay() before using the Application Group extension. + + + +An embedding manager such as a web browser that intends to embed programs in an Application Group should create the Application Group with XagCreateEmbeddedApplicationGroup. + + + + + + + + + + +Status XagCreateEmbeddedApplicationGroup( + + + + + Display* dpy, + + + + + VisualID root_visual, + + + + + Colormap default_colormap, + + + + + unsigned long black_pixel, + + + + + unsigned long white_pixel, + + + + + XAppGroup* app_group_return); + + + + + + + + +XagCreateEmbeddedApplicationGroup creates an Application Group for an embedding manager with the attributes specified. It also sets the default_root attribute to DefaultRoot(dpy, DefaultsScreen(dpy)) and the single_screen and app_group_leader attributes to True. It returns the Application Group ID in app_group_return. + + + +You can create an Application Group without intending to do embedding. One reason for doing this is to give a group of clients their own font-path. + + + +A special font-path can be created by creating an Application Group, getting an Authorization using XSecurityGenerateAuthorization, and then running ‘xset fp+ <new font path>’ as a member of the Application Group. Font-path elements added in this way will be "private" to the Application Group. + + + + + + + + + +Status XagCreateNonembeddedApplicationGroup( + + + + + Display* dpy, + + + + + XAppGroup* app_group_return); + + + + + + + +An Application Group created with XagCreateNonembeddedApplicationGroup will have the default_root, root_visual, and default_colormap attributes all set to None; the single_screen and app_group_leader attributes are set to False, and the black_pixel and white_pixel attributes are not used since the default_colormap attribute is None. + + + +To destroy an Application Group use XagDestroyApplicationGroup. + + + + + + + + + +Status XagDestroyApplicationGroup( + + + + + Display* dpy, + + + + + XAppGroup app_group); + + + + + + + +The Application Group specified by app_group is destroyed. If the Application Group was created using XagCreateEmbeddingApplicationGroup, i.e. and therefore the app_group_leader attribute is True, all programs that are members of the Application Group are killed as if a KillClient request had been issued. + + + + +To retrieve the attributes of an Application Group use XagGetApplicationGroupAttributes. + + + + + + + + + + +Status XagGetApplicationGroupAttributes( + + + + + Display* dpy, + + + + + XAppGroup app_group, + + + + + ...); + + + + + + + + + +XagGetApplicationGroupAttributes is a varargs function that retrieves the Application Group’s attributes specified in the vararg parameter list. + + + +The attributes that may be specified are: XagNappGroupLeader, XagNsingleScreen, XagNdefaultRoot, XagNrootVisual, XagNdefaultColormap, XagNblackPixel, and XagNwhitePixel; which correspond to app_group_leader, single_screen, default_root, root_visual, default_colormap, black_pixel, and white_pixel respectively. See AppGroupCreate in Section 3 for a description of each attribute. + + + +The types for each of the parameters are pointers to the following: + + + + single_screen Bool + default_root Window + root_visual VisualID + default_colormap Colormap + black_pixel unsigned long + white_pixel unsigned long + app_group_leader Bool + + + +Example: + ... + Boolean app_group_leader, single_screen; + Window default_root; + VisualID root_visual; + Colormap default_colormap; + Pixel black_pixel, white_pixel; + ... + status = XagGetApplicationGroupAttributes(dpy, app_group, + XagNappGroupLeader, &app_group_leader, + XagNsingleScreen, &single_screen, + XagNdefault_root, &default_root, + XagNrootVisual, &root_visual, + XagNdefaultColormap, &default_colormap, + XagNblackPixel, &black_pixel, + XagNwhitePixel, &white_pixel, + NULL); + ... + + + + +To determine which Application Group a resource (such as a window) belongs to, use XagQueryApplicationGroup. + + + + + + + + + +Status XagQueryApplicationGroup( + + + + + Display* dpy, + + + + + XID resource, + + + + + XAppGroup* app_group_return); + + + + + + + + +The Application Group is returned in app_group_return, if the resource is not in any Application Group then app_group_return will be set to None. + + + +To associate an X Window ID with a system-specific window ID, such as a HWND or a WindowPtr, use XagCreateAssociation. + + + + + + + + + +Status XagCreateAssociation( + + + + + Display* dpy, + + + + + Window* window_return, + + + + + void* system_window); + + + + + + + + +The window_ret may be used as the target for a ReparentWindow request. + + + +Because XReparentWindow is not constrained in the same way that Win32’s SetParent and the Macintosh are, there is no reason to call XagCreateAssociation in an X-based embedding manager. As such if XagCreateAssociation is called in a native X program, the window_return will be the same as the system_window, and the implementation may even elect to not generate any protocol. + + +To create an association on the Macintosh: + + + struct { + WindowPtr win; + Rect rect; + } system_window; + system_window.win = win_ptr; + system_window.rect.top = system_window.rect.left = 20; + system_window.rect.bottom = 180; + system_window.rect.right = 380; + + + + status = XagCreateAssociation (dpy, &window, (void*)&system_window); + + + +To create an association using a Win16, Win32, or OS/2 PM: + + + + HWND system_window; + status = XagCreateAssociation (dpy, &window, (void*)&system_window); + + + +To destroy the association created with XagCreateAssociation use XagDestroyAssociation. + + + + + + + + + + +Status XagDestroyAssociation( + + + + + Display* dpy, + + + + + Window window); + + + + + + + +After calling XagDestroyAssociation the window may no longer be used to +reparent windows with XReparentWindow. + + + +Like XagCreateAssociation, if the native window system is X11 the implementation may elect to not generate any protocol as a result of this function call in order to avoid unintentionally destroying the the system_window that was specified in the prior XagCreateAssociation call. + + + +
diff --git a/miniconda3/envs/ladir/share/doc/xextproto/dbe.xml b/miniconda3/envs/ladir/share/doc/xextproto/dbe.xml new file mode 100644 index 0000000000000000000000000000000000000000..f0b345c3a0099c3f72c3dccdd0ecfb1cdf613fe6 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/dbe.xml @@ -0,0 +1,1069 @@ + + %defs; +]> + + + + + + + + Double Buffer Extension Protocol + X Consortium Standard + + + IanElliott + Hewlett-Packard Company + + + DavidP.Wiggins + X Consortium + + + 1989199219931994 + X Consortium, Inc. + + 1989Digital Equipment Corporation + 1992Intergraph Corporation + 1993Silicon Graphics, Inc. + 1994Hewlett-Packard Company + X Version 11, Release &fullrelvers; + Version 1.0 + + + +Permission to use, copy, modify, and distribute this documentation for any +purpose and without fee is hereby granted, provided that the above copyright +notice and this permission notice appear in all copies. Digital Equipment +Corporation, Intergraph Corporation, Silicon Graphics, Hewlett-Packard, and +the X Consortium make no representations about the suitability for any purpose +of the information in this document. This documentation is provided “as is” +without express or implied warranty. + + + + + +Introduction +The Double Buffer Extension (DBE) provides a standard way to utilize +double-buffering within the framework of the X Window System. Double-buffering +uses two buffers, called front and back, which hold images. The front buffer +is visible to the user; the back buffer is not. Successive frames of an +animation are rendered into the back buffer while the previously rendered +frame is displayed in the front buffer. When a new frame is ready, the back +and front buffers swap roles, making the new frame visible. Ideally, this +exchange appears to happen instantaneously to the user and with no visual +artifacts. Thus, only completely rendered images are presented to the user, +and they remain visible during the entire time it takes to render a new frame. +The result is a flicker-free animation. + + + + +Goals +This extension should enable clients to: + + + + + Allocate and deallocate double-buffering for a window. + + + +Draw to and read from the front and back buffers associated with a window. + + + + Swap the front and back buffers associated with a window. + + + +Specify a wide range of actions to be taken when a window is swapped. +This includes explicit, simple swap actions (defined below), and more +complex actions (for example, clearing ancillary buffers) that can be put +together within explicit "begin" and "end" requests (defined below). + + + + +Request that the front and back buffers associated with multiple +double-buffered windows be swapped simultaneously. + + + + + +In addition, the extension should: + + + + + +Allow multiple clients to use double-buffering on the same window. + + + +Support a range of implementation methods that can capitalize on existing +hardware features. + + + + Add no new event types. + + + +Be reasonably easy to integrate with a variety of direct graphics hardware +access (DGHA) architectures. + + + + + + + +Concepts + + +Normal windows are created using the core CreateWindow +request, which allocates a set of window attributes and, for InputOutput +windows, a front buffer, into which an image can be drawn. The contents of +this buffer will be displayed when the window is visible. + + +This extension enables applications to use double-buffering with a window. +This involves creating a second buffer, called a back buffer, and associating +one or more back buffer names (XIDs) with the window for use when referring to +(that is, drawing to or reading from) the window's back buffer. The back +buffer name is a DRAWABLE of type BACKBUFFER. + + + +DBE provides a relative double-buffering model. One XID, the window, always +refers to the front buffer. One or more other XIDs, the back buffer names, +always refer to the back buffer. After a buffer swap, the window continues to +refer to the (new) front buffer, and the back buffer name continues to refer +to the (new) back buffer. Thus, applications and toolkits that want to just +render to the back buffer always use the back buffer name for all drawing +requests to the window. Portions of an application that want to render to +the front buffer always use the window XID for all drawing requests to the +window. + + + +Multiple clients and toolkits can all use double-buffering on the same +window. DBE does not provide a request for querying whether a window has +double-buffering support, and if so, what the back buffer name is. Given +the asynchronous nature of the X Window System, this would cause race +conditions. Instead, DBE allows multiple back buffer names to exist for +the same window; they all refer to the same physical back buffer. The first +time a back buffer name is allocated for a window, the window becomes +double-buffered and the back buffer name is associated with the window. +Subsequently, the window already is a double-buffered window, and nothing +about the window changes when a new back buffer name is allocated, except +that the new back buffer name is associated with the window. The window +remains double-buffered until either the window is destroyed or until all of +the back buffer names for the window are deallocated. + + + +In general, both the front and back buffers are treated the same. In +particular, here are some important characteristics: + + + + + +Only one buffer per window can be visible at a time (the front buffer). + + + + +Both buffers associated with a window have the same visual type, depth, +width, height, and shape as the window. + + + + +Both buffers associated with a window are "visible" (or "obscured") in +the same way. When an Expose event is generated for a window, both +buffers should be considered to be damaged in the exposed area. Damage +that occurs to either buffer will result in an Expose event on the window. +When a double-buffered window is exposed, both buffers are tiled with the +window background, exactly as stated by the core protocol. Even though +the back buffer is not visible, terms such as obscure apply to the back +buffer as well as to the front buffer. + + + + +It is acceptable at any time to pass a BACKBUFFER in any +request, notably any core or extension drawing request, that expects +a DRAWABLE. This enables an application to draw directly into +BACKBUFFERs in the same fashion as it would draw into any other +DRAWABLE. + + + + +It is an error (Window) to pass a BACKBUFFER in a core request that +expects a Window. + + + + +A BACKBUFFER will never be sent by core X in a reply, event, or error +where a Window is specified. + + + + +If core X11 backing-store and save-under applies to a double-buffered +window, it applies to both buffers equally. + + + + +If the core ClearArea request is executed on a +double-buffered window, the same area in both the front and back buffers +is cleared. + + + + +The effect of passing a window to a request that accepts a DRAWABLE is +unchanged by this extension. The window and front buffer are synonymous with +each other. This includes obeying the GetImage semantics +and the subwindow-mode semantics if a core graphics context is involved. +Regardless of whether the window was explicitly passed in a +GetImage request, or implicitly referenced (that is, +one of the windo's ancestors was passed in the request), the front (that is, +visible) buffer is always referenced. Thus, DBE-naive screen dump clients will +always get the front buffer. GetImage on a back buffer +returns undefined image contents for any obscured regions of the back buffer +that fall within the image. + + + +Drawing to a back buffer always uses the clip region that would be used to +draw to the front buffer with a GC subwindow-mode of +ClipByChildren. If an +ancestor of a double-buffered window is drawn to with a core GC having a +subwindow-mode of IncludeInferiors, the effect on the +double-buffered window's back buffer depends on the depth of the +double-buffered window and the ancestor. If the depths are the same, the +contents of the back buffer of the double-buffered window are not changed. +If the depths are different, the contents of the back buffer of the +double-buffered window are undefined for the pixels that the +IncludeInferiors drawing touched. + + + +DBE adds no new events. DBE does not extend the semantics of any existing +events with the exception of adding a new DRAWABLE type called BACKBUFFER. If +events, replies, or errors that contain a DRAWABLE (for example, +GraphicsExpose) are generated in response to a request, +the DRAWABLE returned will be the one specified in the request. + + + +DBE advertises which visuals support double-buffering. + + + +DBE does not include any timing or synchronization facilities. +Applications that need such facilities (for example, to maintain a constant +frame rate) should investigate the Synchronization Extension, an X +Consortium standard. + + + +Window Management Operations + + +The basic philosophy of DBE is that both buffers are treated the same by core +X window management operations. + + + +When the core DestroyWindow is executed on a +double-buffered window, both buffers associated with the window are +destroyed, and all back buffer names associated with the window are freed. + + + +If the core ConfigureWindow request changes the size of +a window, both buffers assume the new size. If the windo's size increases, +the effect on the buffers depends on whether the implementation honors bit +gravity for buffers. If bit gravity is implemented, then the contents of +both buffers are moved in accordance with the windo's bit gravity (see the +core ConfigureWindow request), and the remaining areas +are tiled with the window background. If bit gravity is not implemented, then +the entire unobscured region of both buffers is tiled with the window +background. In either case, Expose events are generated +for the region that is tiled with the window background. + + + +If the core GetGeometry request is executed on a +BACKBUFFER, the returned x, y, and border-width will be zero. + + + +If the Shape extension ShapeRectangles, +ShapeMask, +ShapeCombine, or +ShapeOffset +request is executed on a double-buffered window, both buffers are reshaped +to match the new window shape. The region difference is the following: + + + + D = newshape - oldshape + + + +It is tiled with the window background in both buffers, and +Expose events are generated for D. + + + + + +Complex Swap Actions + +DBE has no explicit knowledge of ancillary buffers (for example, depth +buffers or alpha buffers), and only has a limited set of defined swap +actions. Some applications may need a richer set of swap actions than DBE +provides. Some DBE implementations have knowledge of ancillary buffers, +and/or can provide a rich set of swap actions. Instead of continually +extending DBE to increase its set of swap actions, DBE provides a flexible +"idiom" mechanism. If an application's needs are served by the defined swap +actions, it should use them; otherwise, it should use the following method +of expressing a complex swap action as an idiom. Following this policy will +ensure the best possible performance across a wide variety of implementations. + + + +As suggested by the term "idiom," a complex swap action should be expressed +as a group/series of requests. Taken together, this group of requests may be +combined into an atomic operation by the implementation, in order to maximize +performance. The set of idioms actually recognized for optimization is +implementation dependent. To help with idiom expression and interpretation, +an idiom must be surrounded by two protocol requests: +DBEBeginIdiom and +DBEEndIdiom. Unless this begin-end pair +surrounds the idiom, it may not be recognized by a given implementation, and +performance will suffer. + + + +For example, if an application wants to swap buffers for two windows, and +use core X to clear only certain planes of the back buffers, the application +would issue the following protocol requests as a group, and in the following +order: + + + + + DBEBeginIdiom request. + + + +DBESwapBuffers request with XIDs for two windows, each of which uses +a swap action of Untouched. + + + + +Core X PolyFillRectangle request to the back buffer of one window. + + + + +Core X PolyFillRectangle request to the back buffer of the other window. + + + + DBEEndIdiom request. + + + + +The DBEBeginIdiom and DBEEndIdiom +requests do not perform any actions themselves. They are treated as markers +by implementations that can combine certain groups/series of requests as +idioms, and are ignored by other implementations or for nonrecognized +groups/series of requests. If these requests are sent out of order, or are +mismatched, no errors are sent, and the requests are executed as usual, +though performance may suffer. + + + +An idiom need not include a DBESwapBuffers request. For +example, if a swap action of Copied is desired, but only some of the planes +should be copied, a core X +CopyArea request may be used instead of +DBESwapBuffers. +If DBESwapBuffers is included in an idiom, it should +immediately follow the DBEBeginIdiom request. Also, when +the DBESwapBuffers is included in an idiom, that +request's swap action will still be valid, and if the swap action might +overlap with another request, then the final result of the idiom must be as if +the separate requests were executed serially. For example, if the specified +swap action is Untouched, and if a PolyFillRectangle +using a client clip rectangle is done to the windo's back buffer after the +DBESwapBuffers request, then the contents of the new +back buffer (after the idiom) will be the same as if the idiom was not +recognized by the implementation. + + + +It is highly recommended that Application Programming Interface (API) +providers define, and application developers use, "convenience" functions +that allow client applications to call one procedure that encapsulates +common idioms. These functions will generate the +DBEBeginIdiom request, the idiom requests, and +DBEEndIdiom request. Usage of these functions will +ensure best possible performance across a wide variety of implementations. + + + + + + +Requests +The DBE defines the following requests. + + +DBEGetVersion + +This request returns the major and minor version numbers of this extension. + + +DBEGetVersion + + + + + + + + client-major-version + CARD8 + + + client-minor-version + CARD8 + + + => + + + + server-major-version + CARD8 + + + server-minor-version + CARD8 + + + + + + +The client-major-version and client-minor-version numbers indicate what +version of the protocol the client wants the server to implement. The +server-major-version and the server-minor-version numbers returned indicate +the protocol this extension actually supports. This might not equal the +version sent by the client. An implementation can (but need not) support +more than one version simultaneously. The server-major-version and +server-minor-version allow the creation of future revisions of the DBE +protocol that may be necessary. In general, the major version +would increment for incompatible changes, and the minor version would increment +for small, upward-compatible changes. Servers that support the protocol +defined in this document will return a server-major-version of one (1), and a +server-minor-version of zero (0). + + + +The DBE client must issue a DBEGetVersion request before any other double +buffering request in order to negotiate a compatible protocol version; +otherwise, the client will get undefined behavior (DBE may or may not work). + + + + + +DBEGetVisualInfo + +This request returns information about which visuals support double buffering. + + +DBEGetVisualInfo + + + + + + + + + screen-specifiers + LISTofDRAWABLE + + + => + + + + visinfo + LISTofSCREENVISINFO + + + + +where: + + + + + + + + + SCREENVISINFO + LISTofVISINFO + + + VISINFO + [ visual: VISUALID + + + + depth: CARD8 + + + + perflevel: CARD8 ] + + + + + +Errors: Drawable + + +All of the values passed in screen-specifiers must be valid DRAWABLEs (or a +Drawable error results). For each drawable in +screen-specifiers, the reply will contain a list of VISINFO structures for +visuals that support double-buffering on the screen on which the drawable +resides. The visual member specifies the VISUALID. The depth member specifies +the depth in bits for the visual. The perflevel is a performance hint. The +only operation defined on a perflevel is comparison to a perflevel of another +visual on the same screen. The visual having the higher perflevel is likely +to have better double-buffer graphics performance than the visual having the +lower perflevel. Nothing can be deduced from any of the following: the +magnitude of the difference of two perflevels, a perflevel value in isolation, +or comparing perflevels from different servers. + + + +If the list of screen-specifiers is empty, information for all screens is +returned, starting with screen zero. + + + + + +DBEAllocateBackBufferName + + +This request allocates a drawable ID used to refer to the back buffer of a +window. + + +DBEAllocateBackBufferName + + + + + + + + + window + WINDOW + + + back-buffer-name + BACKBUFFER + + + swap-action-hint + SWAPACTION + + + + + + +Errors: Alloc, Value, IDChoice, Match, Window + + + +If the window is not already a double-buffered window, the window becomes +double-buffered, and the back-buffer-name is associated with the window. The +swap-action-hint tells the server which swap action is most likely to be +used with the window in subsequent DBESwapBuffers +requests. The swap-action-hint must have one of the values specified for type +SWAPACTION (or a Value error results). See the description of the +DBESwapBuffers request for a complete discussion of +swap actions and the SWAPACTION type. + + + +If the window already is a double-buffered window, nothing about the window +changes, except that an additional back-buffer-name is associated with the +window. The window remains double-buffered until either the window is +destroyed, or until all of the back buffer names for the window are +deallocated. + + + +The window passed into the request must be a valid WINDOW (or a Window error +results). The window passed into the request must be an InputOutput window (or +a Match error results). The visual of the window must be in the list returned +by DBEGetVisualInfo (or a Match error results). The +back-buffer-name must be in the range assigned to the client, and must not +already be in use (or an IDChoice error results). If the server cannot +allocate all resources associated with turning on double-buffering for the +window, an Alloc error results, the windo's double-buffer status (whether it +is already double-buffered or not) remains unchanged, and the +back-buffer-name is freed. + + + + +DBEDeallocateBackBufferName + +This request frees a drawable ID that was obtained by +DBEAllocateBackBufferName. + + +DBEDeallocateBackBufferName + + + + + + + + + back-buffer-name + BACKBUFFER + + + + + +Errors: Buffer + + +The back-buffer-name passed in the request is freed and no longer associated +with the window. If this is the last back-buffer-name associated with the +window, then the back buffer is no longer accessible to clients, and all +double-buffering resources associated with the window may be freed. The +window's current front buffer remains the front buffer. + + + +The back-buffer-name must be a valid BACKBUFFER associated with a window (or +a Buffer error results). + + + + +DBESwapBuffers + +This request swaps the buffers for all windows listed, applying the +appropriate swap action for each window. + + +DBESwapBuffers + + + + + + + + + windows + LISTofSWAPINFO + + + + +where: + + + + + + + + SWAPINFO + [ window: WINDOW + + + + swap-action: SWAPACTION ] + + + SWAPACTION + { Undefined, Background, Untouched, Copied } + + + + + +Errors: Match, Window, Value + + +Each window passed into the request must be a valid WINDOW (or a +Window error results). Each window passed into the +request must be a double-buffered window (or a Match +error results). Each window passed into the request must only be listed +once (or a Match error results). Each swap-action in +the list must have one of the values specified for type SWAPACTION (or a +Value error results). If an error results, none of +the valid double-buffered windows will have their buffers swapped. + + + +The swap-action determines what will happen to the new back buffer of the +window it is paired with in the list in addition to making the old back +buffer become visible. The defined actions are as follows: + + + + + Undefined + +The contents of the new back buffer become undefined. This may be the +most efficient action since it allows the implementation to discard the +contents of the buffer if it needs to. + + + + Background + +The unobscured region of the new back buffer will be tiled with the window +background. The background action allows devices to use a fast clear +capability during a swap. + + + + Untouched + +The unobscured region of the new back buffer will be unmodified by the swap. + + + + Copied + +The unobscured region of the new back buffer will be the contents of the +old back buffer. + + + + + +If DBESwapBuffers is included in a "swap and clear" +type of idiom, it must immediately follow the +DBEBeginIdiom request. + + + + +DBEBeginIdiom + +This request informs the server that a complex swap will immediately follow +this request. + + +DBEBeginIdiom + + +As previously discussed, a complex swap action is a group/series of +requests that, taken together, may be combined into an atomic operation by +the implementation. The sole function of this request is to serve as a +"marker" that the server can use to aid in idiom processing. The server is +free to implement this request as a no-op. + + + + +DBEEndIdiom + + + +This request informs the server that a complex swap has concluded. + + +DBEEndIdiom + + +The sole function of this request is to serve as a "marker" that the server +can use to aid in idiom processing. The server is free to implement this +request as a no-op. + + + + + +DBEGetBackBufferAttributes + +This request returns information about a back buffer. + +DBEGetBackBufferAttributes + + + + + + + + + back-buffer-name + BACKBUFFER + + + => + + + + attributes + BUFFER_ATTRIBUTES + + + + + +where: + +BUFFER_ATTRIBUTES: [ window: WINDOW ] + + +If back-buffer-name is a valid BACKBUFFER, the window field of the +attributes in the reply will be the window which has the back buffer that +back-buffer-name refers to. If back-buffer-name is not a valid BACKBUFFER, +the window field of the attributes in the reply will be None. + + + + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this section uses +syntactic conventions and data types established there. + + +The name of this extension is "DOUBLE-BUFFER". + + +Type +The following new types are used by the extension. + + +BACKBUFFER: XID +SWAPACTION + +#x00 Undefined +#x01 Background +#x02 Untouched +#x03 Copied + + +SWAPINFO + +4 WINDOW window +1 SWAPACTION swap action +3 unused + + +VISINFO + +4 VISUALID visual +1 CARD8 depth +1 CARD8 perflevel +2 unused + + +SCREENVISINFO + +4 CARD32 n, number in list +8n LISTofVISINFO n VISINFOs + + +BUFFER_ATTRIBUTES + +4 WINDOW window + + + + +Error +Buffer + +1 0 error +1 error base + 0 code +2 CARD16 sequence number +4 CARD32 bad buffer +2 CARD16 minor-opcode +1 CARD8 major-opcode +21 unused + + + + +Request + +DBEGetVersion + +1 CARD8 major-opcode +1 0 minor-opcode +2 2 request length +1 CARD8 client-major-version +1 CARD8 client-minor-version +2 unused +=> +1 unused +2 CARD16 sequence number +4 0 reply length +1 CARD8 server-major-version +1 CARD8 server-minor-version +22 unused + + +DBEAllocateBackBufferName + +1 CARD8 major-opcode +1 1 minor-opcode +2 4 request length +4 WINDOW window +4 BACKBUFFER back buffer name +1 SWAPACTION swap action hint +3 unused + + +DBEDeallocateBackBufferName + +1 CARD8 major-opcode +1 2 minor-opcode +2 2 request length +4 BACKBUFFER back buffer name + + + +DBESwapBuffers + +1 CARD8 major-opcode +1 3 minor-opcode +2 2+2n request length +4 CARD32 n, number of window/swap action pairs in list +8n LISTofSWAPINFO window/swap action pairs + + + +DBEBeginIdiom + +1 CARD8 major-opcode +1 4 minor-opcode +2 1 request length + + +DBEEndIdiom + +1 CARD8 major-opcode +1 5 minor-opcode +2 1 request length + + +DBEGetVisualInfo + +1 CARD8 major-opcode +1 6 minor-opcode +2 2+n request length +4 CARD32 n, number of screen specifiers in list +4n LISTofDRAWABLE n screen specifiers +=> +1 1 Reply +1 unused +2 CARD16 sequence number +4 CARD32 j, reply length +4 CARD32 m, number of SCREENVISINFOs in list +20 unused +4j LISTofSCREENVISINFO m SCREENVISINFOs + + +DBEGetBackBufferAttributes + +1 CARD8 major-opcode +1 7 minor-opcode +2 2 request length +4 BACKBUFFER back-buffer-name +=> +1 unused +2 CARD16 sequence number +4 0 reply length +4 BUFFER_ATTRIBUTES attributes +20 unused + + + + + + +Acknowledgements + +We wish to thank the following individuals who have contributed their time +and talent toward shaping the DBE specification: + +T. Alex Chen, IBM; Peter Daifuku, Silicon Graphics, Inc.; +Ian Elliott, Hewlett-Packard Company; Stephen Gildea, X Consortium, Inc.; +Jim Graham, Sun; Larry Hare, AGE Logic; Jay Hersh, X Consortium, Inc.; +Daryl Huff, Sun; Deron Dann Johnson, Sun; Louis Khouw, Sun; +Mark Kilgard, Silicon Graphics, Inc.; Rob +Lembree, Digital Equipment Corporation; Alan Ricker, Metheus; Michael +Rosenblum, Digital Equipment Corporation; Bob Scheifler, X Consortium, Inc.; +Larry Seiler, Digital Equipment Corporation; Jeanne Sparlin Smith, IBM; +Jeff Stevenson, Hewlett-Packard Company; Walter Strand, Metheus; Ken +Tidwell, Hewlett-Packard Company; and David P. Wiggins, X Consortium, Inc. + + + +Mark provided the impetus to start the DBE project. Ian wrote the first +draft of the specification. David served as architect. + + + + +References + +Jeffrey Friedberg, Larry Seiler, and Jeff Vroom, "Multi-buffering Extension +Specification Version 3.3." + +Tim Glauert, Dave Carver, Jim Gettys, and David P. Wiggins, +"X Synchronization Extension Version 3.0." + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/dpms.xml b/miniconda3/envs/ladir/share/doc/xextproto/dpms.xml new file mode 100644 index 0000000000000000000000000000000000000000..7edfe5c2595c247f61029ae3bc2493bcef474cfd --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/dpms.xml @@ -0,0 +1,663 @@ + + %defs; +]> + + + + + X Display Power Management Signaling (DPMS) Extension Protocol Specification + X Project Team Standard + + + Rob Lembree + Digital Equipment Corporation + lembree@zk3.dec.com + + + X Version 11, Release &fullrelvers; + Version 1.0 + 1996Digital Equipment Corporation + + + +Permission to use, copy, modify, distribute, and sell this +documentation for any purpose is hereby granted without fee, +provided that the above copyright notice and this permission +notice appear in all copies. Digital Equipment Corporation +makes no representations about the suitability for any purpose +of the information in this document. This documentation is +provided “as is” without express or implied warranty. + + + + + + +Overview + +This extension provides X Protocol control over the VESA Display +Power Management Signaling (DPMS) characteristics of video boards +under control of the X Window System. + +X Window System is a trademark of The Open Group. + + + + + + + +Traditionally, the X Window System has provided for both blanking and +non-blanking screen savers. Timeouts associated with these built-in +screen saver mechanisms are limited to idle (dwell) time, and a change +timeout that specifies the change interval for non-blanking screen savers. + + + +The United States' Environmental Protection Agency (EPA) Energy Star program +requires that monitors power down after some idle time by default. +While it is possible to simply overload the existing screen saver timeouts, +this solution leaves the non-privileged user little to no control over +the DPMS characteristics of his or her system. For example, disabling +DPMS would require some unintended side effect in the core screen saver, +such as disabling the changing of a non-blanking screen saver. Providing +clients with this control requires an extension to the core X Window System +Protocol, and this extension seeks to fill this gap. + + + +The design goal of the DPMS extension is to be a logical extension to +the traditional screen saver. The protocol and sample implementation is +designed to use the same date types and time units as the screen saver. +The sample implementation works independently from the screen saver so that +policy as it pertains to the interaction between screen saver and DPMS can +be deferred to the user or screen saver application. The extension has +been tested with and shown to work correctly with both the internal blanking +and non-blanking screen savers, as well as with screen saver extension +clients. + + +The DPMS extension is designed to be simple, yet export sufficient +VESA DPMS information to enable full function clients to be written. +Included is the ability to sense DPMS capability, set and get DPMS timeouts, +enable and disable individual DPMS modes, enable and disable DPMS (without +destroying timeout values), and sense current DPMS on/off state and +power level. + + +There are four power levels specified by the Video Electronics Standards +Association (VESA) Display Power Management Signaling (DPMS) standard. +These are: + + + +DPMS Extension Power Levels + 0 DPMSModeOn In use + 1 DPMSModeStandby Blanked, low power + 2 DPMSModeSuspend Blanked, lower power + 3 DPMSModeOff Shut off, awaiting activity + + + +It is logical to assume that successive DPMS modes be chronologically +at the same time or later than one another, and the protocol is designed +to enforce this rule. + + + +Note however that a conscious decision is made to decouple the timeouts +associated with screen saver from the DPMS timeouts. While it might be +considered logical to require that the first non-zero DPMS timeout be +greater than or equal to the screen saver timeout, this is intentionally +omitted, leaving this policy decision to the user or the screen saver +application. In the case of a laptop where power may be scarce, the +importance of power savings should supersede the screen saver. If the +laptop user plugs the unit in and power is no longer a scarce commodity, +it may be decided to make DPMS less aggressive, or disable it completely. + + + + +Requests + +DPMSGetVersion + + + + + + + + + +client_major_version: CARD16 + + + + +client_minor_version: CARD16 + + + + => + + + +server_major_version: CARD16 + + + + +server_minor_version: CARD16 + + + + + + + +If supplied, the client_major_version and +client_minor_version indicate what version +of the protocol the +client wants the server to implement. The server version numbers +returned indicate the protocol this extension actually supports. This +might not equal the version sent by the client. An implementation can +(but need not) support more than one version simultaneously. The +server_major_version and the +server_minor_version are a +mechanism to support future revisions of the Display Power Management +Signaling protocol which may be necessary. In general, the major version +would increment for incompatible changes, and the minor version would +increment for small, upward-compatible changes. Servers that support the +protocol defined in this document will return a +server_major_version +of one (1), and a server_minor_version +of two (2). + + + +DPMSCapable + + + + + + + + + => + + + +capable: BOOL + + + + + + + +This request is used to determine whether or not the currently running +server's devices are capable of DPMS operations. The truth value of this +request is implementation defined, but is generally based on the capabilities +of the graphic card and monitor combination. Also, the return value in the +case of heterogeneous multi-head servers is implementation defined. + + + +DPMSGetTimeouts + + + + + + + + + => + + + +standby_timeout: CARD16 + + + + +suspend_timeout: CARD16 + + + + +off_timeout: CARD16 + + + + + + + +This request returns the current values of the DPMS timeout values. All +values are in units of seconds. + + + +standby_timeout is the amount of time +of inactivity before standby +mode is invoked. The actual effects of this mode are implementation defined, +but in the case of DPMS compliant hardware, it is implemented by shutting off +the horizontal sync signal, and pulsing the vertical sync signal. Standby +mode provides the quickest monitor recovery time. Note also that many +monitors implement this mode identically to suspend mode. A value of +zero indicates that this mode is disabled. + + + +suspend_timeout is the amount of time +of inactivity before the second +level of power savings is invoked. Suspend mode's physical and electrical +characteristics are implementation defined, but in DPMS compliant hardware, +results in the pulsing of the horizontal sync signal, and shutting off of +the vertical sync signal. Suspend mode recovery is considered to be slower +than standby mode, but faster than off mode, however this is monitor +dependent. As noted above, many monitors implement this mode identically to +standby mode. A value of zero indicates that this mode is disabled. + + + +off_timeout is the amount of time of +inactivity before the third and +final level of power savings is invoked. Off mode's physical and electrical +characteristics are implementation defined, but in DPMS compliant hardware, +is implemented by shutting off both horizontal and vertical sync signals, +resulting in the power-down of the monitor. Recovery time is implementation +dependent, but frequently is similar to the power-up time of the monitor. A +value of zero indicates that this mode is disabled. + + + +DPMSSetTimeouts + + + + + + + + + +standby_timeout: CARD16 + + + + +suspend_timeout: CARD16 + + + + +off_timeout: CARD16 + + + + => + + + + + + + +All values are in units of seconds. +standby_timeout is the amount of +time of inactivity before standby mode will be invoked. This is the +lightest level of power savings, and the monitor is generally immediately +ready upon detection of user activity. This is most often implemented by +shutting off the horizontal sync signal to the monitor. +A value of zero disables this mode. + + + +The suspend_timeout specifies the amount +of time of inactivity +before the screen is placed into suspend mode. Suspend mode is the +middle level of power savings, resulting in a slightly longer recovery +upon detection of activity. Suspend mode is most often implemented by +pulsing the horizontal sync signal, and removing the vertical sync +signal. A value of zero disables this mode. + + + +The off_timeout specifies the amount of +time of inactivity before +the monitor is shut off. Off mode is the deepest level of power management, +resulting in the greatest power savings and the longest recovery time. +Off mode is most often implemented by removing both the horizontal and +vertical signals. A value of zero disables this mode. + + +The values of successive power levels must be greater than or equal +to the value of the previous (non-zero) level. A BadValue error is generated +if an illegal combination is detected. + + +DPMSEnable + + +=> + + + +This request enables the DPMS characteristics of the server, using the +server's currently stored timeouts. If DPMS is already enabled, no change is +effected. + + + +DPMSDisable + + +=> + + + +This request disables the DPMS characteristics of the server. It does +not affect the core or extension screen savers. If DPMS is already +disabled, no change is effected. This request is provided so that DPMS +may be disabled without damaging the server's stored timeout values. + + + +DPMSForceLevel + + + + + + + + + +power_level: CARD16 + + + + => + + + + + + +This request forces a specific DPMS level on the server. If DPMS is +disabled, a BadMatch error is generated. If an erroneous power level +is specified, a BadValue error is returned, and the error value contains +the bad value. If the power level specified is already in effect, no +changes occur. Power Level must be one of DPMSModeOn, DPMSModeStandby, +DPMSModeSuspend or DPMSModeOff. + + + +DPMSInfo + + + + + + + + + => + + + +power_level: CARD16 + + + + +state: BOOL + + + + + + + +This request returns information about the current DPMS state of the +display. state is one of DPMSEnabled +or DPMSDisabled. +If state is DPMSEnabled, +power_level is returned as one +of DPMSModeOn, DPMSModeStandby, DPMSModeSuspend or DPMSModeOff, otherwise +it is undefined. + + + +DPMSSelectInput + + + + + + + + + +event_mask: CARD32 + + + + => + + + + + + +This request specifies whether DPMS extension events should be generated for this client. +If DPMSInfoNotifyMask is set in event-mask, then DPMSInfoNotifyEvent +events will be generated whenever the current DPMS on/off state or power level changes. +If no bits are set, then no events will be generated. + + + + + + +Events + +The DPMS extension adds one event: + + +DPMSInfoNotifyEvent + + + + + + + + + +timestamp: TIMESTAMP + + + + +power_level: CARD16 + + + + +state: BOOL + + + + + + + +This event is delivered to clients that have requested +DPMSInfoNotifyMask events using the DPMSSelectInput request +whenever the current DPMS on/off state or power level changes. +state is one of DPMSEnabled or DPMSDisabled. +If state is DPMSEnabled, +power_level is one +of DPMSModeOn, DPMSModeStandby, DPMSModeSuspend or DPMSModeOff, otherwise +it is undefined. + + + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this document uses +conventions established there. + + + +The name of this extension is "DPMS". + + + +DPMSGetVersion + 1 CARD8 opcode + 1 0 DPMS opcode + 2 2 request length + 2 CARD16 client_major_version + 2 CARD16 client_minor_version +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 2 CARD16 server_major_version + 2 CARD16 server_minor_version + 20 unused + + + +DPMSCapable + 1 CARD8 opcode + 1 1 DPMS opcode + 2 1 request length +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 1 BOOL capable + 23 unused + + + +DPMSGetTimeouts + 1 CARD8 opcode + 1 2 DPMS opcode + 2 1 request length +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 2 CARD16 standby_timeout + 2 CARD16 suspend_timeout + 2 CARD16 off_timeout + 18 unused + + + +DPMSSetTimeouts + 1 CARD8 opcode + 1 3 DPMS opcode + 2 3 request length + 2 CARD16 standby_timeout + 2 CARD16 suspend_timeout + 2 CARD16 off_timeout + 2 unused +=> + + + +DPMSEnable + 1 CARD8 opcode + 1 4 DPMS opcode + 2 1 request length + => + + + +DPMSDisable + 1 CARD8 opcode + 1 5 DPMS opcode + 2 1 request length + => + + + +DPMSForceLevel + 1 CARD8 opcode + 1 6 DPMS opcode + 2 2 request length + 2 power_level + 0 DPMSModeOn + 1 DPMSModeStandby + 2 DPMSModeSuspend + 3 DPMSModeOff + 2 unused +=> + + + +DPMSInfo + 1 CARD8 opcode + 1 7 DPMS opcode + 2 1 request length +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 2 power_level + 0 DPMSModeOn + 1 DPMSModeStandby + 2 DPMSModeSuspend + 3 DPMSModeOff + 1 BOOL state + 21 unused + + + + +DPMSSelectInput + 1 CARD8 opcode + 1 8 DPMS opcode + 2 2 request length + 4 event mask + 0 no events + 1 DPMSInfoNotifyMask + + + +DPMSInfoNotifyEvent + 1 GenericEvent type + 1 CARD8 DPMS extension offset + 2 CARD16 sequence number + 4 0 length + 2 DPMSInfoNotify evtype + 2 unused + 4 TIMESTAMP timestamp + 2 power_level + 0 DPMSModeOn + 1 DPMSModeStandby + 2 DPMSModeSuspend + 3 DPMSModeOff + 1 BOOL state + 13 unused + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/evi.xml b/miniconda3/envs/ladir/share/doc/xextproto/evi.xml new file mode 100644 index 0000000000000000000000000000000000000000..e47feb1d08de986a3a01f099a1e277f9566062e3 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/evi.xml @@ -0,0 +1,519 @@ + + %defs; +]> + + + + + + Extended Visual Information Extension + X Project Team Standard + + + PeterDaifuku + Silicon Graphics, Inc. + + + X Version 11, Release &fullrelvers; + Version 1.0 + 1986-1997The Open Group + + + + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this +software and associated documentation files (the Software), to use the +Software without restriction, including, without limitation, the rights to +copy, modify, merge, publish, distribute and sublicense the Software, +to make, have made, license and distribute derivative works thereof, and +to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + + +The above copyright notice and the following permission notice shall be +included in all copies of the Software: + + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON- +INFRINGEMENT. IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER USEABILITIY, WHETHER IN AN ACTION OF +CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OF OTHER DEALINGS IN +THE SOFTWARE. + + + +Except as contained in this notice, the name of The Open Group shall not +be used in advertising or otherwise to promote the use or other dealings +in this Software without prior written authorization from The Open Group. + + + +X Window System is a trademark of The Open Group. + + + + + + +Introduction + +EVI (Extended Visual Information extension) allows a client to determine +information about core X visuals beyond what the core protocol provides. + + + + +Goals + +As the X Window System has evolved, it has become clear that the information +returned by the core X protocol regarding Visuals is often insufficient for a +client to determine which is the most appropriate visual for its needs. This +extension allows clients to query the X server for additional visual +information, specifically as regards colormaps and framebuffer levels. + + + +This extension is meant to address the needs of pure X clients only. It is +specifically and purposefully not designed to address the needs of X +extensions. Extensions that have an impact on visual information should provide +their own mechanisms for delivering that information. For example, the Double +Buffering Extension (DBE) provides its own mechanism for determining which +visuals support double-buffering. + + + + +Requests + +GetVersion + + + + + + + + + +client_major_version: CARD8 + + + + +client_minor_version: CARD8 + + + + +=> + + + + +server_major_version: CARD8 + + + + +server_minor_version: CARD8 + + + + + + + + + +If supplied, the client_major_version and client_minor_version indicate +what version of the protocol the client wants the server to implement. +The server version numbers returned indicate the protocol this extension +actually supports. This might not equal the version sent by the client. +An implementation can (but need not) support more than one version +simultaneously. The server_major_version and the server_minor_version +are a mechanism to support future revisions of the EVI protocol that +may be necessary. In general, the major version would increment for +incompatible changes, and the minor version would increment for small +upward-compatible changes. Servers that support the protocol defined in +this document will return a server_major_version of one (1), and a +server_minor_version of zero (0). + + + + GetVisualInfo + + + + + + + + + +visual_list: LISTofVISUALID + + + + +=> + + + + +per_visual_info: LISTofVISUALINFO + + + + + + + +where: + + + + + + + + + +VISUALINFO: [core_visual_id: VISUALID + + + + +screen: CARD8 + + + + +level: INT8 + + + + +transparency_type: CARD8 + + + + +unused: CARD8 + + + + +transparency_value: CARD32 + + + + +min_hw_colormaps: CARD8 + + + + +max_hw_colormaps: CARD8 + + + + +num_colormap_conflicts: CARD16 + + + + +colormap_conflicts: LISTofVISUALID] + + + + + + + + + +level is 0 for normal planes, > 0 for overlays, < 0 for underlays. + + + + +transparency_type is 0 for none, 1 for transparent pixel, 2 for +transparent mask. + + + + +transparency_value: value to get transparent pixel if transparency +supported. + + + + +min_hw_colormaps: minimum number of hardware colormaps backing up the +visual. + + + + +max_hw_colormaps: maximum number of hardware colormaps backing up the +visual. + + + (architectures with static colormap allocation/reallocation would have min += max) + + + + +num_colormap_conflicts: number of elements in colormap_conflicts. + + + + +colormap_conflicts: list of visuals that may conflict with this one. For +example, if a 12-bit colormap is overloaded to support 8-bit visuals, the +8-bit visuals would conflict with the 12-bit visuals. + + + + + + +Events and Errors + +No new events or errors are defined by this extension. + + + + +Changes to existing protocol. + +None. + + + + +Encoding + +The name of this extension is "Extended-Visual-Information". + + + +The conventions used here are the same as those for the core X11 +Protocol Encoding. + + + +GetVersion + 1 CARD8 opcode + 1 0 EVI opcode + 2 2 request length + 2 CARD16 client_major_version + 2 CARD16 client_minor_version +=> + 1 1 reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 2 CARD16 server_major_version + 2 CARD16 server_minor_version + 20 unused + + + +GetVisualInfo + 1 CARD8 opcode + 1 1 EVI opcode + 2 2+n request length + 4 CARD32 n_visual + 4n CARD32 visual_ids +=> + 1 1 reply + 1 unused + 2 CARD16 sequence number + 4 n length + 4 CARD32 n_info + 4 CARD32 n_conflicts + 16 unused + 16n LISTofVISUALINFO items + + + +VISUALINFO + 4 VisualID core_visual_id + 1 INT8 screen + 1 INT8 level + 1 CARD8 transparency_type + 1 CARD8 unused + 4 CARD32 transparency_value + 1 CARD8 min_hw_colormaps + 1 CARD8 max_hw_colormaps + 2 CARD16 num_colormap_conflicts + + + + +C Language Binding + + +The C functions provide direct access to the protocol and add no additional +semantics. For complete details on the effects of these functions, refer +to the appropriate protocol request, which can be derived by deleting Xevi +at the start of the function. All functions that have return type Status +will return nonzero for success and zero for failure. + + + +The include file for this extension is: +< X11/extensions/XEVI.h>. + + + + + Bool XeviQueryVersion + Display *display + int *major_version_return + int *minor_version_return + + + + + + + display + + + +Specifies the connection to the X server. + + + + + + major_version_return + + + +Returns the major version supported by the server. + + + + + + minor_version_return + + + +Returns the minor version supported by the server. + + + + + + +XeviQueryVersion sets major_version_return and minor_version_return to +the major and minor EVI protocol version supported by the server. If +the EVI library is compatible with the version returned by the server, +it returns nonzero. If dpy does not support the EVI extension, or if +there was an error during communication with the server, or if the server +and library protocol versions are incompatible, it returns zero. No other +Xevi functions may be called before this function. If a client violates +this rule, the effects of all subsequent Xevi calls that it makes are +undefined. + + + +To get the extended information for any subset of visuals use +XeviGetVisualInfo. + + + + + int XeviGetVisualInfo + Display *display + VisualID *visual + int n_visual + ExtendedVisualInfo **evi_return + int *n_info_return + + + + + + + display + + + +Specifies the connection to the X server. + + + + + + visual + + + +If NULL, then information for all visuals of all +screens is returned. Otherwise, a pointer to a list of visuals for which +extended visual information is desired. + + + + + + n_visual + + + +If 0, then information for all visuals of all screens is returned. Otherwise, +the number of elements in the array visual. + + + + + + evi_return + + + +Returns a pointer to a list of ExtendedVisualInfo. When done, the client +should free the list using XFree. + + + + + + n_info_return + + + +Returns the number of elements in the list of +ExtendedVisualInfo. + + + + + + +XeviGetVisualInfo returns a list of ExtendedVisualInfo structures that describe +visual information beyond that supported by the core protocol. This includes +layer information relevant for systems supporting overlays and/or underlay +planes, and information that allows applications better to determine the level +of hardware support for multiple colormaps. XeviGetVisualInfo returns Success +if successful, or an X error otherwise. + + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/geproto.xml b/miniconda3/envs/ladir/share/doc/xextproto/geproto.xml new file mode 100644 index 0000000000000000000000000000000000000000..4cca9acf8f388c968911a72b06a7cb1e89f2cda5 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/geproto.xml @@ -0,0 +1,126 @@ + + %defs; +]> + + + X Generic Event Extension + + Peter + Hutterer + peter.hutterer@who-t.net + + X Version 11, Release &fullrelvers; + Version 1.0 + 2007Peter Hutterer + + + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + + + THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + + + + + + + Introduction + + X was designed to provide 64 event opcodes for all extensions. These + events are limited to 32 bytes. + + The Generic Event Extension provides a template event for extensions + to re-use a single event opcode. GE only provide headers and the most + basic functionality, leaving the extensions to interpret the events in + their specific context. + + GenericEvents may be longer than 32 bytes. If so, the number of 4 + byte units following the initial 32 bytes must be specified in the length + field of the event. + + + + Extension Initialization + + The name of this extension is "Generic Event Extension" + + GEQueryVersion + client-major-version: CARD16 + client-minor-version: CARD16 +==> + major-version: CARD16 + minor-version: CARD16 + + The client sends the highest supported version to the server and the + server sends the highest version it supports, but no higher than the + requested version. Major versions changes can introduce incompatibilities + in existing functionality, minor version changes introduce only backward + compatible changes. It is the clients responsibility to ensure that the + server supports a version which is compatible with its + expectations. + + As of version 1.0, no other requests are provided by this extension. + + + + + Events + + GE defines a single event, to be used by all extensions. The event's + structure is similar to a reply. This is a core protocol event, ID 35, and + is not itself an extension event. + + GenericEvent + type: BYTE always GenericEvent (35) + extension: CARD8 extension offset + sequenceNumber: CARD16 low 16 bits of request seq. number + length: CARD32 length + evtype: CARD16 event type + + The field 'extension' is to be set to the major opcode of the + extension. The 'evtype' field is the actual opcode of the event. The + length field specifies the number of 4-byte blocks after the initial 32 + bytes. If length is 0, the event is 32 bytes long. + + + + Notes + + Although the wire event is of arbitrary length, the actual size of + an XEvent is restricted to sizeof(XEvent) [96 bytes, see Xlib.h]. If an + extension converts a wire event to an XEvent > 96 bytes, it will + overwrite the space allocated for the event. See struct _XSQEvent in + Xlibint.h for details. + + Extensions need to malloc additional data and fill the XEvent + structure with pointers to the malloc'd data. The client then needs to + free the data, only the XEvent structure will be released by Xlib. + + The server must not send GenericEvents longer than 32 bytes until it + has verified that the client is able to interpret these events. If a long + event is sent to a client unable to process GenericEvents, future + interpretation of replies and events by this client will fail. + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/lbx.xml b/miniconda3/envs/ladir/share/doc/xextproto/lbx.xml new file mode 100644 index 0000000000000000000000000000000000000000..87060b74755dad5a189368934cca9cad8ea9f3b5 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/lbx.xml @@ -0,0 +1,6346 @@ + + %defs; +]> + +
+ + + Low Bandwidth X Extension + X Consortium Standard + + + Donna + Converse + + + Jim + Fulton + + + David + Lemke + + + Ralph + Mor + + + Keith + Packard + + + Ray + Tice + + + Dale + Tonogai + + + X Version 11, Release &fullrelvers; + Version 1.0 + 1996X Consortium + + + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated +documentation files (the "Software"), to deal in the Software without +restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, and +sell copies of the Software, +and to permit persons to whom the Software is furnished to do so, subject to +the following conditions: + + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions +of the Software. + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X +CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the name of the X Consortium shall not be +used in advertising or otherwise +to promote the sale, use or other dealings in this Software without prior +written authorization from the +X Consortium. + +X Window System is a trademark of The OpenGroup. + + + + +Introduction + + +Low Bandwidth X (LBX) is a network-transparent protocol for running X Window +System applications over transport channels whose bandwidth and latency are +significantly worse than that used in local area networks. It combines a +variety of caching and reencoding techniques to reduce the volume of data that +must be sent over the wire. It can be used with existing clients by placing a +proxy between the clients and server, so that the low bandwidth/high latency +communication occurs between the proxy and server. + + + + +This extension was designed and implemented by Jim Fulton, David Lemke, Keith +Packard, and Dale Tonogai, all of Network Computing Devices (NCD). Chris Kent +Kantarjiev (Xerox PARC) participated in early design discussions. Ralph Mor (X +Consortium) designed and implemented additional sections. Donna Converse (X +Consortium) authored the protocol description and encoding from design notes +and the implementation. Ray Tice (X Consortium) resolved the open issues in the +design and specification. Bob Scheifler (X Consortium) helped out in many areas. + + + + +The extension name is "LBX". + + + + + +Description + + +The design center for LBX is to use a proxy as an intermediary between the +client and server. The proxy reencodes and compresses requests, events, replies +and errors, as well as the resulting data stream. Additionally, the proxy can +cache information from the server to provide low-latency replies to clients. +This reply generation by the proxy is known as short-circuiting. A proxy can +handle multiple clients for a given server, but does not prevent clients from +connecting directly to the server. The design allows the proxy to multiplex +multiple clients into a single data stream to the server. + + + + +Much of LBX is implemented as an extension. The compression and reencoding +changes can be isolated to the transport and dispatch portions of the server, +while short-circuiting requires minor changes to the server’s colormap and +property code. + + + + +LBX employs several different compression and short-circuiting methods. Use of +these methods is negotiable, and in some cases, the algorithm used by a given +method is negotiable as well. LBX also provides for negotiation of extensions +to LBX. + + + + +Data Flow + + +The LBX data stream goes through a number of layers: + + + + + +Client requests + + +Read by LBX and potential byte-swapping + + +Request-specific compression + + +Potential byte swapping + + +Multiplexing of client request streams + + +Delta replacement + + +Stream compression + + + + +Transport + + + + + +Stream decompression + + +Delta substitution + + +Demultiplexing of client request streams + + +Potential byte swapping + + +Reencoding + + +Request processing + + + + +The reverse process occurs with X server replies, events, and errors. + + + + + +Tags + + +Tags are used to support caching of large data items that are expected to be +queried multiple times. Such things as the keyboard map and font metrics are +often requested by multiple clients. Rather than send the data each time, the +first time the data is sent it includes a tag. The proxy saves this data, so +that subsequent requests can send only the tag to refer to that same data. The +different types of tags are used for connection information, keyboard maps, +modifier maps, fonts information and properties. + + + + +Tag usage is negotiated as a boolean in the +LbxStartProxy + message. The proxy controls how many tags are stored in the proxy. The server +may wish to observe the proxy’s InvalidateTag behavior to limit how many tags +are cached at any one time. Tagged data is not shared across types of tags, but +the number space used for the tag ids is. The tag ids are generated by the +server. + + + + +The X server keeps track of what tags are known to the proxy. The proxy can +invalidate a tag if no tag bearing replies of that type are pending. The proxy +sends an +LbxInvalidateTag + message to release the tagged data. The proxy must not invalidate connection +tags unless instructed to do so by the server. + + + + +If the server wishes to discard tagged data, it must either have received an + +LbxInvalidateTag + request from the proxy or send an +LbxInvalidateTag + event to the proxy for that tag. + + + + +Tag Substitution in Requests + + +Many substitution requests have a tag field, followed by fields marked +optional. For these requests, if the optional fields are present, the +data in them is stored in the indicated tag, unless the tag is 0. If +the optional fields are absent, the tag field indicates the tag that +contains the data for the "optional" fields. + + + + + +Property Tags + + +Property data makes special use of tags. A common use of properties is for +inter-client communication. If both clients use the proxy, it is wasteful to +send the data to the server and then back, when the server may never need it. + +LbxChangeProperty + request does the same work as the core +ChangeProperty + request, but it does not send the data. The reply to this request contains a +tag id corresponding to the data. If the property information is used locally, +the server responds to +LbxGetProperty + with the tag, and the property data need never be sent to the server. If the +server does require the data, it can issue an +LbxQueryTag + message. The proxy can also send the data on at any time if it judges it +appropriate (i.e., when the wire goes idle). Since the proxy owns the property +data, it must not invalidate the tag before sending the data back to the server +via an +LbxTagData + request. + + + + + + +Short-circuiting + + +Short-circuiting is used to handle constant data. This includes atoms, color +name/RGB mappings, and +AllocColor + calls. Atoms and color name/RGB mappings stay constant for the life of the +server. +AllocColor + + +replies are constant for each colormap. Short-circuiting replaces round-trip +requests with one-way requests, and can sometimes use one in place of many. + + + + +Atoms are used heavily for ICCCM communication. Once the proxy knows the string +to atom mapping, it has no need to send subsequent requests for this atom to +the server. + + + + +Colorname/RGB mappings are constant, so once the proxy sees the response from + +LookupColor +, it need not forward any subsequent requests. + + + + +Clients often use the same color cells, so once a read-only color allocation +has occurred, the proxy knows what RGB values should be returned to the client. +The proxy doesn't need to forward any +AllocColor + requests it can resolve, but it must tell the server to modify the color +cell's reference count. +LbxIncrementPixel + is used to support this. + + + + +For all three classes of short-circuiting, the proxy must still tell the server +a request has occurred, so that the request sequence numbers stay in sync. This +is done with +LbxModifySequence +. + + + + +Sequence numbers cause the major complication with short-circuiting. X +guarantees that any replies, events or errors generated by a previous request +will be sent before those of a later request. This means that any requests that +can be handled by the proxy must have their reply sent after any previous +events or errors. + + + + +If a proxy’s applications do not require strict adherence to the X protocol +ordering of errors or events, a proxy might provide further optimization by +avoiding the overhead of maintaining this ordering, however, the resulting +protocol is not strictly X11 compliant. + + + + + +Graphics Re-encoding + + +The LBX proxy attempts to reencode PolyPoint, +PolyLine, PolySegment, +PolyRectangle, PolyArc, +FillPoly, PolyFillRectangle, +PolyFillArc, CopyArea, +CopyPlane, PolyText8, +PolyText16, ImageText8, +and ImageText16 requests. If the request can be +reencoded, it may be replaced by an equivalent LBX form of the request. +The requests are reencoded by attempting to reduce 2-byte coordinate, +length, width and angle fields to 1 byte. Where applicable, the +coordinate mode is also converted to Previous + to improve the compressibility of the resulting data. In image requests, +the image data may also be compressed. + + + + +Motion events + + +To prevent clogging the wire with MotionNotify + events, the server and proxy work together to control the number +of events on the wire. This is done with the +LbxAllowMotion + request. The request adds an amount to an allowed motion count in +the server, which is kept on a per-proxy basis. Every motion notify +event sent to the proxy decrements the allowed motion counter. If +the allowed motion count is less than or equal to zero, motion +events not required by the X protocol definition are not sent to the +proxy. The allowed motion counter has a minimum value of -2^31. + + + + +Event Squishing + + +In the core protocol, all events are padded as needed to be 32 bytes long. The +LBX extension reduces traffic by removing padding at the end of events, and +implying the event length from its type. This is known as squishing. + + + + +Master Client + + +When the initial X connection between the proxy and the server is converted to +LBX mode, the proxy itself becomes the master client. New client requests and +some tag messages are sent in the context of the master client. + + + + + +Multiplexing of Clients + + +The LBX proxy multiplexes the data streams of all its clients into one stream, +and then splits them apart again when they are received. The +LbxSwitch + message is used to tell each end which client is using the wire at the time. + + + + +The server should process delta requests in the order that they appear on the +LBX connection. If the server does not maintain the interclient request order +for requests sent by the proxy, it must still obey the semantics implied by the +interclient request order so that the delta cache functions correctly. + + + + +The server can affect the multiplexing of clients by the proxy using the + +LbxListenToOne + and +LbxListenToAll + messages. This is useful during grabs, since the master connection can not be +blocked during grabs like other clients. The proxy is responsible for tracking +server grabs issued by its clients so that the proxy can multiplex the client +streams in an order executable by the server. + + + + +Replies must be ordered in the multiplexed data stream from the server to the +proxy such that the reply carrying tagged data precedes replies that refer to +that tagged data. + + + + + +Swapping + + +Swapping is handled as with any X extension, with one caveat. Since a proxy can +be supporting clients with different byte orders, and they all share the same +wire, the length fields of all messages between the server and proxy are +expressed in the proxy byte order. This prevents any problems with length +computation that may occur when clients are switched. + + + + + +Delta cache + + +LBX takes advantage of the fact that an X message may be very similar to one +that has been previously sent. For example, a +KeyPress + event may differ from a previous +KeyPress + event in just a few bytes. By sending just the bytes that differ (or +"deltas"), the number of bytes sent over the wire can be substantially reduced. +Delta compaction is used on requests being sent by the proxy as well as on +replies and events being sent by the server. + + + + +The server and the proxy each keep per-proxy request and response caches. The +response cache contains events, errors and replies. All messages are saved in +the appropriate delta cache if they are of an appropriate type and more than 8 +bytes long but fit within the delta cache. The number of entries in the delta +cache and the maximum saved message size are negotiated in the +LbxStartProxy + request. + + + + +The LBX requests that are never stored in the request delta cache are the + +LbxQueryVersion +, +LbxStartProxy +, +LbxSwitch +, +LbxNewClient +, +LbxAllowMotion +, +LbxDelta +, +LbxQueryExtension +, +LbxPutImage +, +LbxGetImage +, +LbxBeginLargeRequest +, +LbxLargeRequestData +, +LbxEndLargeRequest + and +LbxInternAtoms + requests. The responses that are never stored in the response cache are + +LbxSwitchEvent + and +LbxDeltaResponse +. The message carried by a +delta +message is also cached, if it meets the other requirements. Messages after the + +LbxStartProxy + request are cached starting at index 0, and incrementing the index, modulo the +number of entries, thereafter. The request and response caches are +independently indexed. + + + + +If the current message is cachable and the same length as a message in the +corresponding delta cache, a delta message may be substituted in place of the +original message in the protocol stream. + + + + + +Stream Compression + + +Before being passed down to the transport layer messages can be passed through +a general purpose data compressor. The choice of compression algorithm is +negotiated with See LbxStartProxy. The proxy +and server are not required to support any specific stream compressor. As an +example, however, the X Consortium implementation of a ZLIB based compressor is +described below. + + + +The XC-ZLIB compressor is presented with a simple byte stream - the X and LBX +message boundaries are not apparent. The data is broken up into fixed sized +blocks. Each block is compressed using zlib 1.0 (by Gailly & Adler), then a +two byte header is prepended, and then the entire packet is transmitted. The +header has the following information: + + + out[0] = (length & 0xfff) >> 8 | ((compflag) ? 0x80 : 0); + out[1] = length & 0xff; + + + + +Authentication Protocols + + +The current version of LBX does not support multipass authentication protocols +for clients of the proxy. These authentication protocols return an +Authenticate + message in response to a connection setup request, and require additional +authentication data from the client after the +LbxNewClient + request, and before the reply to +LbxNewClient +. One example of such a protocol is XC-QUERY-SECURITY-1. + + + + + + +C Library Interfaces + + +The C Library routines for LBX are in the Xext library. The prototypes are +located in a file named "XLbx.h". + + + + +Application Library Interfaces + + +In a proxy environment, applications do not need to call these routines to take +advantage of LBX. Clients can, however, obtain information about the LBX +extension to the server using this interface. Use of this routine may be +altered when connected through a proxy, as described in See C Library Interfaces. + + + + +XLbxQueryVersion + + +To determine the version of LBX supported by the X server, call +XLbxQueryVersion +. + + + + +Bool XLbxQueryVersion + Display * display + int * major_version_return + int * minor_version_return + + + + + + display + Specifies the connection to the X server. + + + major_version_return + Returns the extension major version number. + + + minor_version_return + Returns the extension minor version number. + + + + +The +XLbxQueryVersion + function determines if the LBX extension is present. If the extension is not +present, +XLbxQueryVersion + returns +False +; otherwise, it returns +True +. If the extension is present, +XLbxQueryVersion + returns the major and minor version numbers of the extension as supported by +the X server. + + + + + + +Proxy Library Interfaces + + +The following interfaces are intended for use by the proxy. + + + +XLbxQueryExtension + + +To determine the dynamically assigned codes for the extension, use the Xlib +function +XQueryExtension + or the LBX function +XLbxQueryExtension +. + + + + +Bool XLbxQueryExtension + Display * display + int * major_opcode_return + int * first_event_return + int * first_error_return + + + + + + display + Specifies the connection to the X server. + + + major_opcode_return + Returns the major opcode. + + + first_event_return + Returns the first event code. + + + first_error_return + Returns the first error code. + + + + +The +XLbxQueryExtension + function determines if the LBX extension is present. If the extension is not +present, +XLbxQueryExtension + returns +False +; otherwise, it returns +True +. If the extension is present, +XLbxQueryExtension + returns the major opcode for the extension to major_opcode_return, the base +event type code to first_event_return, and the base error code to +first_error_return; otherwise, the return values are undefined. + + + + + +XLbxGetEventBase + +To determine the base event type code, use the Xlib function +XQueryExtension + or the LBX function +XLbxGetEventBase. + + + + + +int XLbxGetEventBase + Display * display + + + + + + display + Specifies the connection to the X server. + + + + +The XLbxGetEventBase +function returns the base event type code if the extension is +present; otherwise, it returns -1. + + + + + + + + +Protocol + + +Syntactic Conventions and Common Types + + +Please refer to the X Window System Protocol specification, +as this document uses the syntactic conventions established +there and references types defined there. + + + + +The following additional types are defined by this extension: + + + +DIFFITEM +1 CARD8 offset +1 CARD8 diff + + + +LBXANGLE: CARD8 or 2 BYTE + where (in order of precedence): + (0 <= in <= A(95)) && !(in % A(5)) out = 0x5a + (in / +A(5)) + A(105) <= in <= A(360) && !(in % A(15)) out = 0x67 + +(in / A(15)) + -A(100) <= in <= -A(5) && !(in % A(5)) out = 0xa6 + +(in / A(5)) + -A(360) < in <= -A(105) && !(in % A(15)) out = 0x98 + +(in / A(15)) + -A(360) < in <= A(360) out[0] = in >> 8; out[1] = in + + + +LBXARC: + [x, y: LBXINT16, + width, height: LBXCARD16, + angle1, angle2: LBXANGLE] + + + +Within a list of arcs, after the first arc, x and y are +relative to the corresponding fields of the prior arc. + + + +LBXCARD16: CARD8 or 2 BYTE + where: + 0x0000 <= in < 0x00F0 CARD8 + 0x00F0 <= in < 0x10F0 out[0] = 0xF0 | ((in - 0xF0) >> +8) + out[1] = in - 0xF0 + + + +LBXGCANDDRAWENT +[ gc-cache-index, drawable-cache-index: CARD4 ] + + + +LBXGCANDDRAWUPDATE + drawable: DRAWABLE /* present only if +drawable-cache-index + == 0 */ +gc: GC] /* present only if gc-cache-index == 0 */ + + + +LBXGCANDDRAWABLE + cache-entries: LBXGCANDDRAWENT + updates: LBXGCANDDRAWUPDATE + + + +LBXINT16: INT8 or 2 BYTE + where: + 0xF790 <= in < 0xFF90 out[0] = 0x80 | (((in + 0x70) >> +8) & 0x0F) + out[1] = in + 0x70 + 0xFF90 <= in < 0x0080 CARD8 + 0x0080 <= in < 0x0880 out[0] = 0x80 | (((in - 0x80) >> +8) & 0x0F) + out[1] = in - 0x80 + + + +LBXPINT16: CARD8 or 2 BYTE /* for +usually positive numbers */ + where: + 0xFE00 <= in < 0x0000 out[0] = 0xF0 | (((in + 0x1000) +>> 8) & 0x0F) + out[1] = in + 0x1000 + 0x0000 <= in < 0x00F0 CARD8 + 0x00F0 <= in < 0x0EF0 out[0] = 0xF0 | ((in - 0xF0) >>8) + out[1] = in - 0xF0 + + + +LBXPOINT: [x, y: LBXINT16] + Within a list of points, after the first rectangle, x and y are +relative to the corresponding fields of the prior point. + + + +LBXRECTANGLE: + [x, y: LBXINT16, + width, height: LBXCARD16] + + + +Within a list of rectangles, after the first rectangle, x and +y are relative to the corresponding fields of the prior rectangle. + + + +MASK: CARD8 + + + + + +Errors + + +As with the X11 protocol, when a request terminates with an error, +the request has no side effects (that is, there is no partial execution). + + + + +There is one error, +LbxClient +. This error indicates that the client field of an LBX request was invalid, or +that the proxy’s connection was in an invalid state for a start or stop proxy +request. + + + + + +Requests + + +There is one request that is expected to be used only by the client: +LbxQueryVersion + + + + +There is one request that is expected to be used by the client or the proxy: + +LbxQueryExtension +. + + + + +The following requests are expected to be used only by the proxy, and are +instigated by the proxy: +LbxStartProxy +, +LbxStopProxy +, +LbxNewClient +, +LbxSwitch +, +LbxCloseClient +, +LbxModifySequence +, +LbxAllowMotion +, +LbxInvalidateTag +, +LbxTagData + and +LbxQueryTag +. + + + + +All other requests are sent by the proxy to the LBX server and are instigated +by reception of an X request from the client. They replace the X request. + + + + +Requests Initiated by the Proxy or by the Client + + + + + + + + LbxQueryVersion + + + + + =>; + + + majorVersion: CARD16 + + + minorVersion: CARD16 + + + + + + +This request returns the major and minor version numbers of the LBX protocol. + + + + +The encoding of this request is on See +LbxQueryVersion. + + + + + + +Requests Initiated or Substituted by the Proxy + + + + + + + + LbxQueryExtension + + + + + +nbytes +: CARD32 + + + +name +: STRING8 + + + => + + + num-requests: CARD8 + + + present: BOOL + + + major-opcode: CARD8 + + + first-event: CARD8 + + + first-error: CARD8 + + + reply-mask: LISTofMASK /* optional */ + + + event-mask:LISTofMASK /* optional */ + + + Errors: +Alloc + + + + + + + +This request is identical to the +QueryExtension + request, with an additional field, and two optional additional fields. When +the client issues an +QueryExtension + request, the proxy will substitute an +LbxQueryExtension + request. + + + + +This request determines if the named extension is present. If so, the major +opcode for the extension is returned, if it has one. Otherwise, zero is +returned. Any minor opcode and the request formats are specific to the +extension. If the extension involves additional event types, the base event +type code is returned. Otherwise, zero is returned. The format of events is +specific to the extension. If the extension involves additional error codes, +the base error code is returned. Otherwise, zero is returned. The format of +additional data in the errors is specific to the extension. + + + + +In addition, the number of requests defined by the named extension is returned. +If the number of requests is nonzero, and if the information is available, +reply-mask and event-mask will be included in the reply. The reply-mask +represents a bit-wise one-to-one correspondence with the extension requests. +The least significant bit corresponds to the first request, and the next bit +corresponds to the next request, and so on. Each element in the list contains +eight meaningful bits, except for the last element, which contains eight or +fewer meaningful bits. Unused bits are not guaranteed to be zero. The bit +corresponding to a request is set if the request could generate a reply, +otherwise it is zero. In the same way, the event-mask represents a bit-wise +one-to-one correspondence with the extension requests. A bit is set if the +corresponding request could result in the generation of one or more extension +or X11 events. If reply-mask is present in the reply, event-mask will also be +present. + + + + +The encoding of this request is on See +LbxQueryExtension. + + + + + + +Control Requests Initiated by the Proxy + + + + + + + + LbxStartProxy + + + + + +options +: LISTofOPTION + + + => + + + choices: LISTofCHOICE + + + Errors: +LbxClient +, +Alloc + + + + where: + + + OPTION [optcode: CARD8, + + + len: OPTLEN, + + + option: (See See StartProxy Options) ] + + + CHOICE [optcode: CARD8, + + + len: OPTLEN, + + + choice: (See See StartProxy Options) ] + + + + + + + + + StartProxy Options + + + + + + + + + optcode + option + choice + default + + + + + delta-proxy + DELTAOPT + DELTACHOICE + entries=16, maxlen=64 + + + delta-server + DELTAOPT + DELTACHOICE + entries=16, maxlen=64 + + + stream-comp + LISTofNAMEDOPT + INDEXEDCHOICE + No Compression + + + bitmap-comp + LISTofSTRING8 + LISTofINDEXEDOPT + No Compression + + + pixmap-comp + LISTofPIXMAPMETHOD + LISTofPIXMAPCHOICE + No Compression + + + use-squish + BOOL + BOOL + True + + + use-tags + BOOL + BOOL + True + + + colormap + LISTofSTRING8 + INDEXEDCHOICE + No Colormap Grabbing + + + extension + NAMEDOPT + INDEXEDCHOICE + Extension Disabled + + + +
+ + + + + + + +   + + + DELTAOPT [minN, maxN, prefN: CARD8 + + + minMaxMsgLen, maxMaxMsgLen, prefMaxMsgLen: +CARD8] + + + DELTACHOICE [entries, maxlen: +CARD8] + + + INDEXEDCHOICE [index: CARD8, + + + data: LISTofBYTE] + + + INDEXEDOPT [index, opcode: CARD8] + + + NAMEDOPT [name: STRING8, + + + detail: LISTofBYTE] + + + OPTLEN 1 or 3 CARD8 + + + where: + + + (0 < in <= 0xFF): out = +in + + + (0 <= in<= 0xFFFF): out[0] = +0; out[1] = in >> 8; out[2] = in& 0xFF; + + + PIXMAPMETHOD [name: STRING8, + + + format-mask: BITMASK, + + + depths: LISTofCARD8] + + + PIXMAPCHOICE [index, opcode: CARD8, + + + format-mask: BITMASK, + + + depths: LISTofCARD8] + + + + + + + + + +This request negotiates LBX protocol options, and switches the proxy-server +connection from X11 protocol to LBX protocol. + + + + +The proxy gives the preferred protocol options in the request. The server +chooses from the given options and informs the proxy which to use. The options +may be listed in any order, and the proxy may choose which options to +negotiate. If an option is not successfully negotiated, the default is used. + + + + +The server delta cache and proxy delta caches can be configured for number of +entries, and the length of entries. (See See Delta +cache for details.) The delta caches are configured using the +delta-server + and +delta-proxy + options. To configure a cache, the proxy sends the minimum, maximum and +preferred values for the number of cache entries, ( +minN, maxN, prefN +), and the length of the cache entries, ( +minMaxMsgLen, maxMaxMsgLen, prefMaxMsgLen +). The server’s reply fields, +entries + and +maxlen +, contains the values to use. These values must be within the ranges specified +by the proxy. The server may also specify an +entries + value of 0 to disable delta caching. The cache entry lengths are specified in +units of 4 bytes. + + + + +The stream compression algorithm is selected using the +stream-comp +option. (Stream compression is described in See +Stream Compression.) Each algorithm has a name that follows the naming +conventions in See Algorithm Naming. To +negotiate using the stream-comp option, the proxy lists its available +compressors. For each candidate algorithm, the proxy sends the name in the + +name + field, and uses the +detail + field to send any additional data specific to each compression algorithm. The +reply contains a 0-based index into the list of algorithms to indicate which +algorithm to use, followed by data specific to that algorithm. + + + + +Bitmap compression is negotiated using the +bitmap-comp + option. The proxy sends a list of names of available algorithms, and the +server reply lists the algorithms to use. For each bitmap algorithm in the +reply, a 0-based index into the list of algorithms indicates the algorithm, and +the +opcode + field gives the value for use in requests. The algorithm names follow the +conventions in See Algorithm Naming. + + + + +Pixmap compression is negotiated using the +pixmap-comp + option. The proxy sends a list of available algorithms. For each algorithm, +the list includes, the name, a bitmask of supported formats, and a list of +depths that the format supports. The server reply lists the algorithms to use. +For each pixmap algorithm in the reply, the reply contains a 0-based index into +the list of proxy algorithms, the opcode to use in requests when referring to +this algorithm, a mask of valid formats, and a list of valid depths. Algorithm +names follow the conventions in See Algorithm +Naming. + + + + +Squishing is negotiated using the use-squish option. If the proxy desires +squishing, it sends a true value. The reply from the server indicates whether +to do squishing, and will indicate squishing only if +use-squish + is set to true in the request. + + + + +Tag caching, described in See Tags, is +negotiated using the use-tag option. If the proxy desires tag caching, it sends +a true value. The reply from the server indicates whether to do tag caching, +and will demand caching only if +use-tag + is set to true in the request. + + + + +The colormap option is used to negotiate what color matching algorithm will be +used by the proxy when the proxy uses the +LbxAllocColor + request to allocate pixels in a grabbed colormap. To negotiate using the +colormap option, the proxy lists the names of available colormap algorithms. +The choice in the reply contains a 0-based index into the list of algorithms to +indicate which algorithm to use, followed by data specific to that algorithm. +If no colormap algorithm is successfully negotiated, then the +LbxAllocColor +, +LbxGrabCmap +, and +LbxReleaseCmap + requests will not be used. + + + + +The extension option is used to control extensions to LBX. These extensions +may, for example, enable other types of compression. To negotiate an extension, +the name of the extension is sent, followed by any data specific to that +extension. The extension name follows the conventions in See Algorithm Naming. The extension option may +occur multiple times in the start proxy message, since multiple extensions can +be negotiated. The reply to an extension option contains the zero-based index +of the extension option, as counted in the +LbxStartProxy + message. This index is followed by extension-specific information. The server +does not respond to extensions it does not recognize. + + + + +An +LbxClient + error is returned when a client which is already communicating through an LBX +proxy to the X server sends a +LbxStartProxy + request. + + + + +The encoding for this request is on See +LbxStartProxy. + + + + + + + + + + LbxStopProxy + + + + + Errors: +LbxClient + + + + + + + +This request terminates the connection between the proxy and X server, and +terminates any clients connected through the proxy. + + + + +The encoding for this request is on See +LbxStopProxy. + + + + +An +LbxClient + error is returned if the requesting client is not an LBX proxy. + + + + + + + + + + LbxNewClient + + + + + +byte-order +: CARD8 + + + +client-id +: CARD32 + + + +protocol-major-version +: CARD16 + + + +protocol-minor-version: + CARD16 + + + +authorization-protocol-name +: STRING8 + + + +authorization-protocol-data +: STRING8 + + + => + + + Core X reply (if connection is rejected) + + +   + + + OR + + +   + + + success: BOOL + + + change-type: {NoDeltas, NormalClientDeltas, +AppGroupDeltas} + + + protocol-major-version: CARD16 + + + protocol-minor-version: CARD16 + + + tag-id: CARD32 + + + length: CARD16 + + + connection-data: CONINFO or CONDIF or +CONDIFROOT + + +   + + + where: + + + CONINFO: (the "additional data" +portion of the core connection reply for successes) + + + CONDIF: [resource-id-base: CARD32, + + + root-input-masks: LISTofSETofEVENT] + + + CONDIFROOT: [resource-id-base: +CARD32, + + + root: WINDOW + + + root-visual: VISUALID + + + default-colormap: COLORMAP + + + white-pixel, black-pixel: CARD32 + + + root-input-masks: LISTofSETofEVENT] + + + + + + +Errors: LbxClient, Alloc + + + + +This request, which is sent by the proxy over the control connection, creates a +new virtual connection to the server. + + + + +Much of the information in the +LbxNewClient + request and reply is identical to the connection setup and reply information +in the core X protocol. + + + + +For the +LbxNewClient + request, the field unique to LBX is client-id. For the +LbxNewClient + reply, +tag-id + and +change-type + are fields unique to LBX, and the contents of connection-data may be different +in LBX from the core X protocol (see below). + + + + +The proxy assigns each virtual connection a unique identifier using the + +client-id + field in the +LbxNewClient + request. This client-id is used in the LBX protocol to specify the current +client (see the +LbxSwitch + request and the +LbxSwitchEvent +). client-id 0 is reserved for the proxy control connection. An +LbxClient + error will result if the +LbxNewClient + request contains a client-id of 0 or an already in use client-id. + + + + +If the server rejects this new virtual connection, the server sends a core X +connection failure reply to the proxy. The current version of LBX does not +support the return of an +Authenticate + reply. + + + + +If the +change-type + field is set to +NoDeltas +, then +connection-data + is sent using the CONINFO structure, which is identical to the additional data +of the core connection reply. If the +tag-id + is non-zero, then the connection-data is stored by the proxy using this tag +value. Tagged connection data must be stored by the proxy, and can not be +invalidated by the proxy until an +LbxInvalidateTag + event is received for that tag. + + + + +When the +change-type + field is not set to +NoDeltas +, then connection data is sent as changes against connection information +previously sent to the proxy. The +tag-id + field, if non-zero, has the tag of the previously sent data to apply the +changes to. A zero tag-id indicates that the changes are with respect to the +connection information sent when the proxy connected to the server. + + + + +If the +change-type + field is set to +NormalClientDeltas +, then +connection-data + is sent using the CONDIF structure. The values in the CONDIF structure are +substituted for the identically named fields of the connection information for +the new connection. + + + + +If the +change-type + field is set to +AppGroupDeltas +, then +connection-data + is sent using the CONDIFROOT structure. The +root +, +root-visual +, and +default-colormap + fields, when nonzero, are substituted for the corresponding fields in the +reference connection information. The +white-pixel + and +black-pixel + fields are substituted only when the +default-colormap + field of the reply is non-zero. When +default-colormap + field of the reply is zero, so are +white-pixel + and +black-pixel +. The first entry in the +root-input-masks + field is the current-input-mask for the default root window. The remaining +entries in +root-input-masks + are input masks for non-video screens, as defined by the X Print Extension. +The number of non-video screens is one less than the number of entries in + +root-input-masks +. These screens are at the end of screen list in the reference connection +information. + + + + +The encoding for this request is on See The +description of this request is on page 13.. + + + + + + + + + + LbxCloseClient + + + + + +client +: CARD32 + + + + Errors: +LbxClient + + + + + + + +This requests the server to close down the connection represented by the +specified proxy’s client identifier. If the specified client wasn’t +previously registered with the server by a +LbxNewClient + request, the server will send the +LbxClient + error. + + + + +The encoding for this request is on See The +description of this request is on page 12.. + + + + + + + + + + LbxSwitch + + + + + +client +: CARD32 + + + + Errors: +LbxClient + + + + + + + +This request causes the X server to treat subsequent requests as being from a +connection to the X server represented by the specified client identifier. + + + + +If the client making the request is not the proxy, or if the client identifier +sent in the request was not previously sent in a +LbxNewClient + request, an +LbxClient + error is returned. + + + + +The encoding for this request is on See +LbxSwitch. + + + + + + + + + + LbxSync + + + + + => + + + + + + +The sync request causes the server to send a reply when all requests before the +sync request have been processed. + + + + +The encoding for this client is on See +LbxSync. + + + + + + + + + + LbxModifySequence + + + + + +adjust +: CARD32 + + + + Errors: None + + + + + + +This request advances the sequence number of the virtual client connection by +the specified amount. The proxy sends the +LbxModifySequence + request to the server when it replies to a client request without forwarding +the client request on to the X server. + + + + +The encoding for this client is on See The +description of this request is on page 13.. + + + + + + + + + + LbxAllowMotion + + + + + +num +: CARD32 + + + + Errors: None + + + + + + +This request controls the delivery of optional motion notify events, as +described in See Motion events. The num +field specifies an increase in the allowed number of motion notify events sent. + + + + +The encoding for this request is on See The +description of this request is on page 14.. + + + + + + + + + + LbxInvalidateTag + + + + + +tag +: CARD32 + + + + + + +The LBX proxy sends this notification to the X server when it refuses to store +tagged data, or when it releases tagged data which was previously stored and +which was not invalidated by a notification from the X server. + + + + +The encoding for this request is on See +LbxInvalidateTag. + + + + + + + + + + LbxTagData + + + + + +tag +: CARD32 + + + +real-length +: CARD32 + + + +data +: LISTofBYTE + + + + + + +This request specifies the data associated with a previously assigned tag. It +is sent in two circumstances: in response to receiving a +SendTagDataEvent +, and spontaneously, when the proxy must rely on the server to store data which +was not previously received from the server. The data is carried in the byte +order and structure as would have originally been sent in the core protocol +request. + + + + +The encoding for this request is on See +LbxTagData. + + + + + + + + + + LbxGrabCmap + + + + + +cmap +: Colormap + + + => + + + + +smart-grab +: BOOL + + + +large-pixel: +BOOL /* optional */ + + + +auto-release: +BOOL /* optional */ + + + +three-channels +: BOOL /* optional */ + + + +bits-per-rgb: +CARD4 /* optional */ + + + +cells +: LISTofCHAN /* optional */ + + +   + + + where: + + + CHAN: LISTofLBXPIXEL + + + LBXPIXEL: PIXELPRIVATE or PIXELPRIVATERANGE +or + + + PIXELALLOC or PIXELALLOCRANGE + + + PIXEL: CARD8 or CARD16 + + + PIXELPRIVATE: [ pixel: PIXEL ] + + + PIXELPRIVATERANGE: [ first-pixel, +last-pixel: PIXEL] + + + PIXELALLOC: [ pixel: PIXEL, + + + color: COLORSINGLE or COLORTRIPLE] + + + PIXELALLOCRANGE: [ first-pixel, +last-pixel: PIXEL, + + + colors: LISTofCOLORSINGLE or +LISTofCOLORTRIPLE] + + + COLORSINGLE: [ value: CARD8 or CARD16 +] + + + COLORTRIPLE: [ r, g, b: +COLORSINGLE] + + + + Errors: +Colormap + + + + + + + +This request asks the server for control of allocating new colormap cells in +the specified colormap. The server grants control by replying to this request. +If no changes have occurred since the last time this proxy grabbed this +colormap, then the +smart-grab + field of the reply is set to true, and the optional fields are not sent. +Otherwise, the current contents of the colormap are placed in the reply, as +described later in this section. + + + + +Once the proxy has received the reply, it can use the +LbxAllocColor + request to allocate new colormap cells without the performance penalty of +round trips. The proxy is still permitted to use the normal colormap and + +LbxIncrementPixel + requests while the colormap is grabbed. The grab is valid across all virtual +connections of the proxy. + + + + +The +LbxGrabCmap + request is limited to colormaps for the visual types negotiated as part of the +colormap algorithm negotiation in the start proxy request at connection setup. + + + + +The server and other proxies may not allocate new colormap cells in the +colormap while the colormap is grabbed by this proxy. If the server or another +proxy needs to allocate new colormap cells, the server sends a Lbx +ReleaseCmap + event to the proxy holding the grab, which then issues an +LbxReleaseCmap + request. + + + + +The server and other proxies may free colormap cells in a colormap grabbed by a +proxy. The server will send an +LbxFreeCells + event to the proxy that currently has the colormap grabbed when the cell +reference count reaches 0. + + + + +If the colormap is a of a static visual type, such as +StaticGray +, +StaticColor +, +GrayScale +, or +TrueColor +, then the proxy’s grab is immediately released by the server, and the proxy +must use +LbxIncrementPixel + requests in place of +LbxAllocColor + requests for this colormap. + + + + +If the cmap field does not refer to a valid colormap or the colormap is already +grabbed by this proxy then a +Colormap + error is generated. + + + + +The reply describes the contents of the colormap via several arguments and a +descriptive list containing one or three channels, with each channel describing +allocations in the colormap. + + + + +The +large-pixel + argument, if True, specifies that PIXEL indices will be listed as CARD16 +quantities instead of CARD8. The + auto-release + field, if True, indicates that this colormap is of a static visual type and +the proxy’s grab is immediately released by the server. + + + + +If +three-channels + is False, a single channel is enclosed and color values are described using +COLORTRIPLE, which has fields for red, green and blue. A single channel is used +when the visual type is not +DirectColor + or +TrueColor +. + + + + +If +three-channels + is True, separate red, green and blue channel lists are enclosed, for +describing a +DirectColor + or +TrueColor + colormap. Color values for entries in each channel are sent using COLORSINGLE +and the corresponding PIXEL value refers to the RGB subfield of the current +channel, as defined by the corresponding red-mask, green-mask and blue-mask of +the visual. + + + + +The +bits-per-rgb + value is one less than the bits-per-rgb-value field of the visual that the +colormap belongs to. If the value is 7 or less, then COLORSINGLE values in the +descriptive list are sent using CARD8 fields. Otherwise these values are sent +using CARD16 fields. + + + + +The list describing current colormap allocations contains entries of the +following types: + + + + +An LBXPIXELPRIVATE entry indicates that the pixel in the +pixel +field is unavailable for allocation. + + + + +An LBXPIXELPRIVATERANGE entry indicates that a contiguous range of pixels are +unavailable for allocation. The range is +first-pixel + to +last-pixel +, and includes +last-pixel +. + + + + +An LBXPIXELALLOC entry indicates that the pixel in the +pixel +field is allocated as a read-only pixel. The +color + field carries the color information of the pixel. + + + + +An LBXPIXELALLOCRANGE entry indicates that a contiguous range of pixels are +allocated as read-only. The range starts +first-pixel + to +last-pixel +, and includes +last-pixel +. These fields are followed by a list of COLORSINGLE or COLORTRIPLE, depending +on the value of +three-channels +. + + + + +A NEXTCHANNEL entry indicates that the next channel of the colormap will be +described. + + + + +A LISTEND entry indicates the end of the colormap description. + + + + +All pixels not described in the reply are unallocated. + + + + +The encoding for this request is on See +LbxGrabCmap. + + + + + + + + + + + LbxReleaseCmap + + + + + +cmap +: Colormap + + + + + + +This request releases the specified grabbed colormap. If the +cmap + field does not refer to a colormap, a +BadColormap + error is produced. + + + + +The proxy must remember the state of the colormap when the +LbxReleaseCmap + request is issued if this proxy may at some future time issue another + +LbxGrabCmap + request on this colormap before the state of the colormap changes. + + + + +The encoding for this request is on See +LbxReleaseCmap. + + + + + + + + + + LbxInternAtoms + + + + + +count +: CARD16 + + + +names: LISTofSTRING8 + + + + => + + + + +atoms +: LISTofATOM + + + + Errors: +Alloc + + + + + + + +This request allows the proxy to intern a group of atoms in a single round +trip. The server will create any atoms that do not exist. + + + + +The encoding for this request is on See +LbxInternAtoms. + + + + + + +Substitution Requests + + + + + + + + LbxAllocColor + + + + + +cmap +: Colormap + + + +pixel +: CARD32 + + + +red +, +green +, +blue +: CARD16 + + + + + + +This request is sent by a proxy that has given colormap grabbed to allocate a +new read-only cell in the colormap. The proxy may substitute this request for +the core +AllocColor + and +AllocNamedColor + requests. + + + + +The +pixel + field identifies the colormap cell to allocate. The +red +, +green +, and +blue + fields are the hardware specific color values of the corresponding fields of +the core +AllocColor + request. The mapping to hardware specific colormap values by the proxy is +performed using the color algorithm negotiated by +LbxStartProxy +. + + + + +For colormaps of static visual types, the +LbxIncrementPixel + request is used instead of LBX +AllocColor +. + + + + +If the +cmap + field does not identify a grabbed colormap then a +BadAccess + error is produced. If the +pixel + field refers to a read-write entry, or the pixel field refers to a pixel +outside of the range of this colormap, a +BadAlloc + error is produced. + + + + +The encoding for this request is on See +LbxAllocColor. + + + + + + + + + + LbxIncrementPixel + + + + + +cmap +: COLORMAP + + + +pixel +: CARD32 + + + + Errors: None + + + + + + +This request replaces the +AllocColor + request for read-only pixels currently allocated for the current client. If +the visual type of the colormap is of a static type, this request may be used +on currently unallocated pixels. The colormap is not required to be grabbed to +use this request. + + + + +The encoding for this request is on See The +description of this request is on page 14.. + + + + + + + + + + LbxDelta + + + + + +count +: CARD8 + + + +cache-index +: CARD8 + + + +diffs +: LISTofDIFFITEM + + + + + + +This request contains a minimal amount of information relative to a similar +prior request. The information is in the form of a difference comparison to a +prior request. The prior request is specified by an index to a cache, +independently maintained by both the proxy and the server. + + + + +The encoding for this request is on See The +description of this request is on page 18.. + + + + + + + + + + LbxGetModifierMapping + + + + + => + + + + +keyspermod +: CARD8 + + + +tag +: CARD32 + + + +keycodes +: LISTofKEYCODE /* optional */ + + + + + + +This request is identical to the core +GetModifierMapping + request, with the addition of a tag being returned in the reply. See See Tag Substitution in Requests for a description +of the +tag + field and optional fields. + + + + +The encoding for this request is on See +LbxGetModifierMapping. + + + + + + + + + + LbxGetKeyboardMapping + + + + + +firstKeyCode +: KEYCODE + + + +count +: CARD8 + + + => + + + + +keysperkeycode +: CARD8 + + + +tag +: CARD32 + + + +keysyms +: LISTofKEYSYM /* optional */ + + + + Errors: +Value + + + + + + + +This request is identical to the X +GetKeyboardMapping + protocol request, with the addition that a tag is returned in the reply. See +See Tag Substitution in Requests for a +description of the +tag + field and optional fields. + + + + +The encoding for this request is on See +LbxGetKeyboardMapping. + + + + + + + + + + + LbxGetWinAttrAndGeom + + + + + +window +: WINDOW + + + => + + + + visual: VISUALID + + + class: {InputOutput, InputOnly} + + + bit-gravity: BITGRAVITY + + + win-gravity: WINGRAVITY + + + backing-store: {NotUseful, WhenMapped, +Always} + + + backing-planes: CARD32 + + + backing-pixel: CARD32 + + + save-under: BOOL + + + colormap: COLORMAP or None + + + map-is-installed: BOOL + + + map-state: {Unmapped, Unviewable, +Viewable} + + + all-event-masks, your-event-mask: +SETofEVENT + + + do-not-propagate-mask: SETofDEVICEEVENT + + + override-redirect: BOOL + + + root: WINDOW + + + depth: CARD8 + + + x, y: INT16 + + + width, height, border-width: CARD16 + + + + Errors: +Window + + + + + + + + +GetWindowAttributes + and +GetGeometry + are frequently used together in the X protocol. +LbxGetWinAttrAndGeom + allows the proxy to request the same information in one round trip. + + + + +The encoding for this request is on See +LbxGetWinAttrAndGeom. + + + + + + + + + + + LbxQueryFont + + + + + +font +: FONTABLE + + + => + + + compression: BOOL + + + tag: CARD32 + + + font-info: FONTINFO /* optional +*/ + + + char-infos: LISTofCHARINFO or LISTofLBXCHARINFO + /* optional */ + + + where: + + + LBXCHARINFO: [left-side-bearing: +INT6 + + + right-side-bearing: INT7 + + + character-width: INT6 + + + ascent: INT6 + + + descent: INT7] + + + + Errors: +Font,Alloc + + + + + + + +This request is used to replace the core +QueryFont + request and has identical semantics. + + + + +See See Tag Substitution in Requests for a +description of the +tag + field and optional fields. + + + + +The +compression + field is True if the +char-infos + field is represented using LBXCHARINFO. + + + + +The per-character information will be encoded in an LBXCHARINFO when, for every +character, the character-width, left-side-bearing, and ascent can each be +represented in not more than 6 bits, and the right-side-bearing and descent can +each be represented in not more than 7 bits, and the attributes field is +identical the attributes field of the max_bounds of the +font_info + field of the font. + + + + +The encoding for this request is on See +LbxQueryFont. + + + + + + + + + + + LbxChangeProperty + + + + + +window +: WINDOW + + + +property +: ATOM + + + +type +: ATOM + + + +format +: {0,8,16,32} + + + +mode +: {Replace, Prepend, Append} + + + +nUnits +: CARD32 + + + => + + + tag: CARD32 + + + + + + +This request is sent to the server when the client sends an X +ChangeProperty +request through the proxy. The size of the data is sent with this request, but +not the property data itself. The server reply contains a tag identifier for +the data, which is stored in the proxy. The proxy must not discard this data +before it is sent to the server, or invalidated by the server. This means that +before issuing an +LbxStopProxy + request, or exiting, the proxy must send Lbx +TagData + requests for these items. If the server loses the connection before the +information is sent back, the server should revert the property value to its +last known value, if possible. + + + + +If the +mode + field is +Prepend + or +Append +, the tag refers only to the prepended or appended data. + + + + +If the tag in the reply is zero, then the change was ignored by the server, as +defined in the security extension. The proxy should dump the associated data, +since the server will never ask for it. + + + + +The encoding for this request is on See +LbxChangeProperty. + + + + + + + + + + LbxGetProperty + + + + + +window +: WINDOW + + + +property +: ATOM + + + +type +: ATOM or AnyPropertyType + + + +long-offset +: CARD32 + + + +long-length +: CARD32 + + + +delete +: CARD8 + + + => + + + + type: ATOM or None + + + format: {0, 8, 16, 32} + + + bytes-after: CARD32 + + + nItems: CARD32 + + + tag: CARD32 + + + value: LISTofINT8 or LISTofINT16 or +LISTofINT32 + + + + + + +This request may be used by the proxy as a substitution for a core +GetProperty + request. It allows tags to be used for property data that is unlikely to +change often in value, but is likely to be fetched by multiple clients. + + + + +The +LbxGetProperty + request has the same arguments as the core +GetProperty + request. The reply for +LbxGetProperty + has all of the fields from the core +GetProperty + reply, but has the additional fields of +nItems + and +tag +. + + + + +In order to utilize tags in +LbxGetProperty + for a specific property, the server must first send the complete property data +to the proxy and associate this data with a tag. More precisely, the server +sends an +LbxGetProperty + reply with a new +tag +, +nItems + set to the number of items in the property, the size of the property data in +the reply length field, and the complete property data in value. The proxy +stores the property data in its tag cache and associates it with the specified +tag. + + + + +In response to future +LbxGetProperty + requests for the same property, if the server thinks that the proxy has the +actual property data in its tag cache, it may choose to send an +LbxGetProperty + reply without the actual property data. In this case, the reply would include +a non-zero +tag +, a zero reply length, and no data for value. + + + + +If the server chooses not to generate a tagged reply to +LbxGetProperty +, or for some reason is unable to do so, it would send a reply with a +tag + of zero, the size of the property data in the reply length field, and the +complete property data in value. + + + + +The encoding for this request is on See +LbxGetProperty. + + + + + + + + + + LbxPolyPoint + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +points +: LISTofLBXPOINT + + + + Errors: +Alloc + and those given for the corresponding X request. + + + + + + +This request replaces the +PolyPoint + request. Not all +PolyPoint + requests can be represented as +LbxPolyPoint + requests. + + + + +The proxy will convert the representation of the points to be relative to the +previous point, as described by previous coordinate mode in the X protocol. + + + + +The encoding for this request is on See +LbxPolyPoint. + + + + + + + + + + LbxPolyLine + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +points +: LISTofLBXPOINT + + + + Errors: +Alloc + and those given for the corresponding X request. + + + + + + +This request replaces the +PolyLine + request. Not all +PolyLine + requests can be represented as +LbxPolyline + requests. + + + + +The proxy will convert the representation of the points to be relative to the +previous point, as described by previous coordinate mode in the X protocol. + + + + +The encoding for this request is on See The +description of this request is on page 21.. + + + + + + + + + + LbxPolySegment + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +segments +: LISTofLBXSEGMENT + + +   + + + where: + + + LBXSEGEMENT; [x1, y1, x2, y2: LBXINT16] + + + + Errors: +Alloc + and those given for the corresponding X request. + + + + + + +This request replaces the +PolySegment + request. Not all +PolySegment + requests can be represented as +LbxPolySegment + requests. + + + + +For segments other than the first segment of the request, [x1, y1] is +relative to [x1, y1] of the previous segment. For all segments, [x2, y2] is +relative to that segment’s [x1, y1]. + + + + +The encoding for this request is on See +LbxPolySegment. + + + + + + + + + + LbxPolyRectangle + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +rectangles +: LISTofLBXRECTANGLE + + + + Errors: +Alloc + and those given for the corresponding X request. + + + + + + +This request replaces the +PolyRectangle + request. Not all +PolyRectangle + requests can be represented as +LbxPolyRectangle + requests. + + + + +The encoding for this request is on See The +description of this request is on page 22.. + + + + + + + + + + LbxPolyArc + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +arcs +: LISTofLBXARC + + + + Errors: +Alloc + and those given for the corresponding X request. + + + + + + +This request replaces the +PolyArc + request. Not all +PolyArc + requests can be represented as +LbxPolyArc + requests. + + + + +The encoding for this request is on See +LbxPolyArc. + + + + + + + + + + LbxPolyFillRectangle + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +rectangles +: LISTofLBXRECTANGLE + + + + Errors: +Alloc + and those given for the corresponding X request. + + + + + + +This request replaces the +PolyFillRectangle + request. Not all +PolyFillRectangle + requests can be represented as +LbxPolyFillRectangle + requests. + + + + +The encoding for this request is on See +LbxPolyFillRectangle. + + + + + + + + + + LbxPolyFillArc + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +arcs +: LISTofLBXARC + + + + Errors: +Alloc + and those given for the corresponding X request. + + + + + + +This request replaces the +PolyFillArc + request. Not all +PolyFillArc + requests can be represented as +LbxPolyFillArc + requests. + + + + +The encoding for this request is on See The +description of this request is on page 22.. + + + + + + + + + + LbxFillPoly + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +shape +: BYTE + + + +points +: LISTofLBXPOINT + + + + Errors: +Alloc + and those given for the corresponding X request. + + + + + + +This request replaces the +FillPoly + request. Not all +FillPoly + requests can be represented as +LbxFillPoly + requests. + + + + +The proxy will convert the representation of the points to be relative to the +previous point, as described by previous coordinate mode in the X protocol. + + + + +The encoding for this request is on See +LbxFillPoly. + + + + + + + + + + LbxCopyArea + + + + + +srcCache +: CARD8 /* source drawable */ + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +src-Drawable +: CARD32 + + + +src-x +: LBXPINT16 + + + +src-y +: LBXPINT16 + + + +width +: LBXCARD16 + + + +height +: LBXCARD16 + + + +dst-x +: LBXPINT16 + + + +dst-y +: LBXPINT16 + + + + Errors: Those given for the corresponding X +request. + + + + + + +This request replaces the +CopyArea + request for requests within its encoding range. + + + + +The encoding for this request is on See +LbxCopyArea. + + + + + + + + + + LbxCopyPlane + + + + + +bit-plane +: CARD32 + + + +src-cache +: CARD8 /* cache reference for source drawable */ + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +src-drawable +: CARD32 + + + +src-x +: LBXPINT16 + + + +src-y +: LBXPINT16 + + + +width +: LBXCARD16 + + + +height +: LBXCARD16 + + + +dst-x +: LBXPINT16 + + + +dst-y +: LBXPINT16 + + + + Errors: Those given for the corresponding X +request. + + + + + + +This request replaces the +CopyPlane + request for requests within its coding range. + + + + +The encoding for this request is on See +LbxCopyPlane. + + + + + + + + + + LbxPolyText8 + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +x +: LBXPINT16 + + + +y +: LBXPINT16 + + + +items +: LISTofTEXTITEM8 + + + + Errors: +Alloc +, and those given for the corresponding X request. + + + + + + +This request replaces the +PolyText8 + request for requests within its encoding range. + + + + +The encoding for this request is on See The +description of this request is on page 23.. + + + + + + + + + + LbxPolyText16 + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +x: + LBXPINT16 + + + +y +: LBXPINT16 + + + +items +: LISTofTEXTITEM16 + + + + Errors: +Alloc +, and those given for the corresponding X request. + + + + + + +This request replaces the +PolyText16 + request for requests within its encoding range. + + + + +The encoding for this request is on See The +description of this request is on page 24.. + + + + + + + + + + LbxImageText8 + + + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +nChars +: CARD8 + + + +x +: LBXPINT16 + + + +y +: LBXPINT16 + + + +string +: STRING8 + + + + Errors: +Alloc +, and those given for the corresponding X request. + + + + + + +This request replaces the +ImageText8 + request for requests within its encoding range. + + + + +The encoding for this request is on See The +description of this request is on page 24.. + + + + + + + + + + LbxImageText16 + + + + + +nChars +: CARD8 + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + x: LBXPINT16 + + + +y +: LBXPINT16 + + + +string +: STRING16 + + + + Errors: +Alloc +, and those given for the corresponding X request. + + + + + + +This request replaces the +ImageText16 + request for requests within its encoding range. + + + + +The encoding for this request is on See The +description of this request is on page 24.. + + + + + + + + + + LbxPutImage + + + + + +compression-method +: CARD8 + + + +format +: { +Bitmap +, +XYPixmap +, +ZPixmap +} /* packed */ + + + +gc-and-drawable: +LBXGCANDDRAWABLE + + + +width +, +height +: LBXCARD16 + + + +dst-x +, +dst-y +: LBXPINT16 + + + +depth +: CARD8 /* packed */ + + + +left-pad +: CARD8 /* packed */ + + + +pad-bytes +: CARD8 /* packed */ + + + +data +:LISTofBYTE + + + + Errors: +Alloc +, +Value + + + + + + + +When the request can be usefully compressed, this request replaces the + +PutImage + request. The +compression-method + parameter contains the opcode of a compression method returned in the + +LbxStartProxy + reply. The +pad-bytes + parameter gives the number of unused pad bytes that follow the compressed +image data. All other parameters are as in the X request. If the specified +compression method is not recognized, the server returns a +Value + error. + + + + +The encoding for this request is on See +LbxPutImage. + + + + + + + + + + LbxGetImage + + + + + +drawable +: DRAWABLE + + + +x +, +y +: INT16 + + + +width +, +height +: CARD16 + + + +plane-mask +: CARD32 + + + +format +: {XYPixmap, ZPixmap} + + + => + + + depth: CARD8 + + + x-length: CARD32 + + + visual: VISUALID or None + + + compression-method: CARD8 + + + data: LISTofBYTE + + + + Errors: +Alloc,Match,Value + + + + + + + +This request can replace the +GetImage + request. The same semantics apply, with the following exceptions. + + + + +The +compression-method + field contains the opcode of the compression method used in the reply. The +compression opcodes are supplied in the +LbxStartProxy + reply. The +x-length +field + +contains the length of the uncompressed version of the reply in 4 byte units. + + + + +A +Value + error is returned if the format is not recognized by the X server. A +Match + error is returned under the same circumstances as described by the +GetImage + request. + + + + +The encoding for this request is on See +LbxGetImage. + + + + + + + + + + + LbxBeginLargeRequest + + + + + +large-request-length +: CARD32 + + + + Errors: +Alloc + + + + + + + +This request, along with the Lbx +LargeRequestData + and Lbx +EndLargeRequest + requests, is used to transport a large request in pieces. The smaller size of +the resulting requests allows smoother multiplexing of clients on a single low +bandwidth connection to the server. The resulting finer-grained multiplexing +improves responsiveness for the other clients. + + + + +After a +LbxBeginLargeRequest + request is sent, multiple +LbxLargeRequestData + requests are sent to transport all of the data in the large request, and +finally an +LbxEndLargeRequest + request is sent. The large-request-length field expresses the total length of +the transported large request, expressed as the number of bytes in the +transported request divided by four. + + + + +The encoding for this request is on See The +description of this request is on page 25.. + + + + + + + + + + LbxLargeRequestData + + + + + +data +: LISTofBYTE + + + + Errors: +Alloc + + + + + + + +This request is used to carry the segments of a larger request, as described in +the definition of +LbxBeginLargeRequest +. The data must be carried in order, starting with the request header, and each +segment must be multiples of 4 bytes long. If the +LbxLargeRequestData + is not preceded by a corresponding +LbxBeginLargeRequest +, a +BadAlloc + error is generated. + + + + +The encoding for this request is on See The +description of this request is on page 26.. + + + + + + + + + + LbxEndLargeRequest + + + + + Errors: +Length, Alloc + + + + + + + +As described in the definition of +LbxBeginLargeRequest +, +LbxEndLargeRequest + is used to signal the end of a series of +LargeRequestData + requests. If the total length of the data transported by the +LbxLargeRequestData + requests does not match the large-request-length field of the preceding + +LbxBeginLargeRequest + request, then a +Length + error occurs. If the +LbxEndLargeRequest + is not preceded by a corresponding +LbxBeginLargeRequest +, a +BadAlloc + error is generated. The request is executed in order for that client as if it +were the request after the request preceding +LbxEndLargeRequest +. + + + + +The encoding for this request is on See +LbxEndLargeRequest. + + + + + + + +Events + + + + + + + + LbxSwitchEvent + + + + + +client +: CARD32 + + + + + + +Notify the proxy that the subsequent replies, events, and errors are relative +to the specified client. + + + + +The encoding for this event is on See +LbxSwitchEvent. + + + + + + + + + + LbxCloseEvent + + + + + +client +: CARD32 + + + + + + +Notify the proxy that the specified client's connection to the server is closed. + + + + +The encoding for this event is on See The +description of this event is on page 27.. + + + + + + + + + + LbxInvalidateTagEvent + + + + + +tag +: CARD32 + + + +tag-type +: {Modmap, Keymap, Property, Font, ConnInfo} + + + + + + +This message informs the proxy that the tag and the server data referenced by +the tag are obsolete, and should be discarded. The tag type may be one of the +following values: +LbxTagTypeModmap +, +LbxTagTypeKeymap +, +LbxTagTypeProperty +, +LbxTagTypeFont +, +LbxTagTypeConnInfo +. + + + + +The encoding for this event is on See +LbxInvalidateTagEvent. + + + + + + + + + + LbxSendTagDataEvent + + + + + +tag +: CARD32 + + + +tag-type +: {Property} + + + + + + +The server sends this event to the proxy to request a copy of tagged data which +is being stored by the proxy. The request contains a tag which was previously +assigned to the data by the server. The proxy should respond to +SendTagData + by sending a +TagData + request to the server. The tag type may be one of the following values: + +LbxTagTypeProperty +. + + + + +The encoding for this event is on See +LbxSendTagDataEvent. + + + + + + + + + + LbxListenToOne + + + + + +client +: CARD32 or +0xffffffff + + + + + + + +When the server is grabbed, +ListenToOne + is sent to the proxy. As an X client, the proxy itself is unaffected by grabs, +in order that it may respond to requests for data from the X server. + + + + +When the client grabbing the server is managed through the proxy, the proxy +will permit messages from itself and the grabbing client to be sent immediately +to the server, and may buffer requests from other clients of the proxy. The +client is identified in the event. + + + + +When the client grabbing the server is not managed through the proxy, the +client field in the event will be +0xffffffff +. The proxy will communicate with the server, and it may buffer requests from +other clients. The proxy will continue to handle new connections while the +server is grabbed. + + + + +The server will send +ListenToAll + to the proxy when the server is ungrabbed. There is no time-out for this +interval in the protocol. + + + + +The encoding for this event is on See The +description of this event is on page 27.. + + + + + + + + + + LbxListenToAll + + + + + + +Notify the proxy that the server has been ungrabbed, and that the proxy may now +send all buffered client requests on to the server. + + + + +The encoding for this event is on See The +description of this event is on page 27.. + + + + + + + + + + LbxQuickMotionDeltaEvent + + + + + +deltaTime +: CARD8 + + + +deltaX +: INT8 + + + +deltaY +: INT8 + + + + + + +This event is used as a replacement for the +MotionNotify + event when possible. The fields are used as deltas to the most recent + +MotionNotify + event encoded as a +MotionNotify + event, +LbxQuickMotionDeltaEvent +, or +LbxMotionDeltaEvent +. Not every +MotionNotify + event can be encoded as a +LbxQuickMotionDeltaEvent +. + + + + +The encoding for this event is on See +LbxQuickMotionDeltaEvent. + + + + + + + + + + LbxMotionDeltaEvent + + + + + +deltaX +: INT8 + + + +deltaY +: INT8 + + + +deltaTime +: CARD16 + + + +deltaSequence +: CARD16 + + + + + + +This event is used as a replacement for the +MotionNotify + event when possible. The fields are used as deltas to the most recent + +MotionNotify + event encoded as a +MotionNotify + event, +LbxQuickMotionDeltaEvent +, or +LbxMotionDeltaEvent +. Not every +MotionNotify + event can be encoded as +a LbxMotionDeltaEvent +. + + + + +The encoding for this event is on See +LbxMotionDeltaEvent. + + + + + + + + + + LbxReleaseCmapEvent + + + + + +colormap +: Colormap + + + + + + +This event notifies the proxy that it must release the grab on this colormap +via the ReleaseCmap request. See +LbxReleaseCmap + + + + +The encoding for this event is on See +LbxReleaseCmapEvent. + + + + + + + + + + LbxFreeCellsEvent + + + + + +colormap +: Colormap + + + +pixelStart, pixelEnd +: CARD32 + + + + + + +The +LbxFreeCells + event is sent to a proxy that has a colormap grabbed to notify the proxy that +the reference count of the described cells were decremented to zero by the +server or another proxy. The reference count includes those by this proxy. The +proxy must update its copy of the colormap state accordingly if the colormap is +still grabbed, or if the proxy may in the future grab the colormap using +smart-grab mode. See LbxGrabCmap + + + + +The pixelStart and pixelEnd fields of the event denote a continuous range of +cells that were freed. + + + + +The encoding for this event is on See +LbxFreeCellsEvent. + + + + +Responses + + +Responses are messages from the server to the proxy that not, strictly +speaking, events, replies or errors. + + + + + + + + + LbxDeltaResponse + + + + + +count +: CARD8 + + + +cache-index +: CARD8 + + + +diffs +: LISTofDIFFITEM + + + + + + +This response carries an event, reply, or error that has been encoded relative +to a message in the response delta cache. The +cache-index + field is the index into the cache. Each entry in +diffs + provides a byte offset and replacement value to use in reconstructing the +response. + + + + +The encoding for this event is on See +LbxDeltaResponse. + + + + + + +Algorithm Naming + + +To avoid potential clashes between different but similar algorithms for stream, +bitmap, and pixmap compression, the following naming scheme will be adhered to: + + + + +Each algorithm has a unique name, which is a STRING8, of the following form: + + + + + <organization>-<some-descriptive-name> + + + + +The organization field above is the organization name as registered in section +1 of the X Registry (the registry is provided as a free service by the X +Consortium.) This prevents conflicts among different vendor’s extensions. + + + + +As an example, the X Consortium defines a zlib-based stream compression +algorithm called XC-ZLIB. + + + + + +Encoding + + +The syntax and types used in the encoding are taken from the X protocol +encoding. Where LBX defines new types, they are defined earlier in this +document. + + + + +As in the X protocol, in various cases, the number of bytes occupied by a +component will be specified by a lowercase single-letter variable name instead +of a specific numeric value, and often some other component will have its value +specified as a simple numeric expression involving these variables. Components +specified with such expressions are always interpreted as unsigned integers. +The scope of such variables is always just the enclosing request, reply, error, +event, or compound type structure. + + + + +For unused bytes, the encode-form is: + + + +N unused + + + +If the number of unused bytes is variable, the encode-form typically is: + + + +p unused, p=pad(E) + + + +where E is some expression, and pad(E) is the number of bytes needed to round E +up to a multiple of four. + + + + +pad(E) = (4 - (E mod 4)) mod 4 + + + + +In many of the encodings, the length depends on many variable length fields. +The variable L is used to indicate the number of padded 4 byte units needed to +carry the request. Similarly, the variable Lpad indicates the number of bytes +needed to pad the request to a 4 byte boundary. + + + +For counted lists there is a common encoding of NLISTofFOO: + + + +NLISTofFOO +1 m num items +m LISTofFOO items + + + +For cached GC and Drawables: + + + +LBXGCANDDRAWUPDATE +4 or 0 DRAWBLE optional drawable +4 or 0 GC optional GC + + + + + +LBXGCANDDRAWABLE +8 LBXGCANDDRAWENT cache-entries +8 unused +m LBXGCANDDRAWUPDATE optional GC and Drawable + + + + +Errors + + +LbxClient +1 0 Error +1 CARD8 error-base + 0 +2 CARD16 sequence number +4 unused +2 CARD16 lbx opcode +1 CARD8 major opcode +21 unused + + + + +Requests + + +LbxQueryVersion +1 CARD8 opcode +1 0 lbx opcode +2 1 request length +=> +1 1 Reply +1 unused +2 CARD16 sequence number +4 0 reply length +2 CARD16 major version +2 CARD16 minor version +20 unused + + + +The description of this request is on See +LbxQueryVersion. + + + + +LbxStartProxy +1 CARD8 opcode +1 1 lbx opcode +2 L request length +n NLISTofOPTION-REQUEST options +p unused, p=pad(n) + +OPTION-REQUEST +1 OPTCODE option-code +m OPTLEN option-request-byte-length, (b=m+a+1) +a DELTAOPT or option + NLISTofNAMEDOPT or + NLISTofSTR or + NLISTofPIXMAPMETHOD or + BOOL + + + +The encoding of the option field depends on the option-code. +See See StartProxy Options. + + + +1 OPTCODE option-code +0 LbxOptionDeltaProxy +1 LbxOptionDeltaServer +2 LbxOptionStreamCompression +3 LbxOptionBitmapCompression +4 LbxOptionPixmapCompression +5 LbxOptionMessageCompression /* also known as squishing */ +6 LbxOptionUseTags +7 LbxOptionColormapAllocation +255 LbxOptionExtension + + + +OPTLEN has two possible encodings, depending on the size of the value carried: + + + +OPTLEN +1 CARD8 b (0 < b <= 255) + +OPTLEN +1 0 long length header +1 c length0, c = b >> 8 +1 d length1, d= b & #xff + +DELTAOPT +1 CARD8 min-cache-size +1 CARD8 max-cache-size +1 CARD8 preferred-cache-size +1 CARD8 min-message-length +1 CARD8 max-message-length (in 4-byte units) +1 CARD8 preferred-message-length + +NAMEDOPT +f STR type-name +1 g+1 option-data-length +g LISTofBYTE option-data (option specific) + +PIXMAPMETHOD +h STR name +1 BITMASK format mask +1 j depth count +j LISTofCARD8 depths + +=> +=> + +1 1 Reply +1 CARD8 count + +0xff options in request cannot be decoded +2 CARD16 sequence number +4 (a+p-32)/4 reply length +a LISTofCHOICE options-reply +p unused, if (n<24) p=24-n else p=pad(n) + +CHOICE +1 CARD8 request-option-index +b OPTLEN reply-option-byte-length +c DELTACHOICE or choice + INDEXEDCHOICE or + NLISTofINDEXEDOPT or + NLISTofPIXMAPCHOICE or + BOOL or + INDEXEDCHOICE + + + +The encoding of the choice field depends on the option-code. See See StartProxy Options. + + + +DELTACHOICE +1 CARD8 preferred cache size +1 CARD8 preferred message length in 4-byte units + +INDEXEDCHOICE +1 CARD8 index +d LISTofBYTE data + +PIXMAPCHOICE +1 CARD8 index +1 CARD8 opcode +1 BITMASK format mask +e NLISTofCARD8 depths + + + +The description of this request is on See +LbxStartProxy. + + + + +LbxStopProxy +1 CARD8 opcode +1 2 lbx opcode +2 1 request length + + + +The description of this request is on See +LbxStopProxy. + + + + +LbxSwitch +1 CARD8 opcode +1 3 lbx opcode +2 2 request length +4 CARD32 client + + + +The description of this request is on +See LbxSwitch. + + + + +LbxNewClient +1 CARD8 opcode +1 4 lbx opcode +2 L request length +4 CARD32 client +The remaining bytes of the request are the core connection setup. +=> +If the connection is rejected, a core connection reply is sent. Otherwise the +reply has the form: +1 BOOL success +1 change type + 0 no-deltas + 1 normal-client-deltas + 2 app-group-deltas +2 CARD16 major version +2 CARD16 minor version +2 1 + a length +4 CARD32 tag id + + + +The remaining bytes depend on the value of change-type and length. + + + +For no-deltas, the remaining bytes are the "additional data" +bytes of the core reply. (a = length of core reply, in 4 byte quantities). + + + +For normal-client-deltas, the additional bytes have the form, with a length (a += 1 +b): + + + +4 CARD32 resource id base +4b LISTofSETofEVENT root input masks + + + +For app-group-deltas, the additional bytes have the following form, with a +length of (a = 1 + 4c): + + + +4 CARD32 resource id base +4 WINDOW root id base +4 VISUALID visual +4 COLORMAP colormap +4 CARD32 white pixel +4 CARD32 black pixel +4c LISTofSETofEVENT root input masks + + + +The description of this request is on +See LbxNewClient. + + + + +LbxCloseClient +1 CARD8 opcode +1 5 lbx opcode +2 2 request length +4 CARD32 client + + + +The description of this request is on +See LbxCloseClient. + + + + +LbxModifySequence +1 CARD8 opcode +1 6 lbx opcode +2 2 request length +4 CARD32 offset to sequence number + + + +The description of this request is on See +LbxModifySequence. + + + + +LbxAllowMotion +1 CARD8 opcode +1 7 lbx opcode +2 2 request length +4 CARD32 number of MotionNotify events + + + +The description of this request is on See +LbxAllowMotion. + + + + +LbxIncrementPixel +1 CARD8 opcode +1 8 lbx opcode +2 3 request length +4 COLORMAP colormap +4 CARD32 pixel + + + +The description of this request is on See +LbxIncrementPixel. + + + + +LbxDelta +1 CARD8 opcode +1 9 lbx opcode +2 1+(2n +p+2)/4 request length +1 n count of diffs +1 CARD8 cache index +2n LISTofDIFFITEM offsets and differences +p unused, p=pad(2n + 2) + + + +The description of this request is on See +LbxDelta. + + + + +LbxGetModifierMapping +1 CARD8 opcode +1 10 lbx opcode +2 1 request length +=> +1 1 Reply +1 n keycodes-per-modifier +2 CARD16 sequence number +4 2n reply length +4 CARD32 tag +20 unused +8n LISTofKEYCODE keycodes + + + +The description of this request is on See +LbxGetModifierMapping. + + + + +LbxInvalidateTag +1 CARD8 opcode +1 12 lbx opcode +2 2 request length +4 CARD32 tag + + + +The description of this request is on See +LbxInvalidateTag. + + + + +LbxPolyPoint +1 CARD8 opcode +1 13 lbx opcode +2 1+(m+n+p)/4 request length +m LBXGCANDDRAWABLE cache entries +n LISTofLBXPOINT points (n is data-dependent) +p 0 unused, p=Lpad + + + +The description of this request is on See +LbxPolyPoint. + + + + +LbxPolyLine +1 CARD8 opcode +1 14 lbx opcode +2 1+(m+n+p)/4 request length +m LBXGCANDDRAWABLE cache entries +n LISTofLBXPOINT points (n is data-dependent) +p 0 unused, p=Lpad + + + +The description of this request is on See +LbxPolyLine. + + + + +LbxPolySegment +1 CARD8 opcode +1 15 lbx opcode +2 1+(m+n+p)/4 request length +m LBXGCANDDRAWABLE cache entries +n LISTofLBXSEGMENT segments (n is data-dependent) +p 0 unused, p=Lpad + + + +The description of this request is on See +LbxPolySegment. + + + + +LbxPolyRectangle +1 CARD8 opcode +1 16 lbx opcode +2 1+(m+n+p)/4 request length +m LBXGCANDDRAWABLE cache entries +n LISTofLBXRECTANGLE rectangles (n is data-dependent) +p 0 unused, p=pad(m+n) + + + +The description of this request is on See +LbxPolyRectangle. + + + + +LbxPolyArc +1 CARD8 opcode +1 17 lbx opcode +2 1+(m+n+p)/4 request length +m LBXGCANDDRAWABLE cache entries +n LISTofLBXARCS arcs (n is data-dependent) +p 0 unused, p=Lpad + + + +The description of this request is on See +LbxPolyArc. + + + + +LbxFillPoly +1 CARD8 opcode +1 18 lbx opcode +2 1+(3+m+n+p)/4 request length +1 LBXGCANDDRAWENT cache entries +1 shape +0 Complex +1 Nonconvex +2 Convex +1 p pad byte count +m LBXGCANDDRAWUPDATE optional gc and drawable +n LISTofLBXPOINT points (n is data-dependent) +p 0 unused, p=Lpad + + + +The description of this request is on See +LbxFillPoly. + + + + +LbxPolyFillRectangle +1 CARD8 opcode +1 19 lbx opcode +2 1+(m+n+p)/4 request length +m LBXGCANDDRAWABLE cache entries +n LISTofLBXRECTANGLE rectangles (n is data-dependent) +p 0 unused, p=Lpad + + + +The description of this request is on See +LbxPolyFillRectangle. + + + + +LbxPolyFillArc +1 CARD8 opcode +1 20 lbx opcode +2 1+(m+n+p)/4 request length +m LBXGCANDDRAWABLE cache entries +n LISTofLBXARC arcs (n is data-dependent) +p 0 unused, p=Lpad + + + +The description of this request is on See +LbxPolyFillArc. + + + + +LbxGetKeyboardMapping +1 CARD8 opcode +1 21 lbx opcode +2 2 request length +1 KEYCODE first keycode +1 m count +2 unused +=> +1 1 Reply +1 n keysyms-per-keycode +2 CARD16 sequence number +4 nm reply length (m = count field from the request) +4 CARD32 tag +20 unused +4nm LISTofKEYSYM keysyms + + + +The description of this request is on See +LbxGetKeyboardMapping. + + + + +LbxQueryFont +1 CARD8 opcode +1 22 lbx opcode +2 2 request length +4 FONTABLE font +=> +1 1 Reply +1 BOOL compression +2 CARD16 sequence number +4 L reply length +4 CARD32 tag +20 unused +All of the following is conditional: +12 CHARINFO min-bounds +4 unused +12 CHARINFO max-bounds +4 unused +2 CARD16 min-char-or-byte2 +2 CARD16 max-char-or-byte2 +2 CARD16 default-char +2 n number of FONTPROPs in properties +1 draw-direction +0 LeftToRight +1 RightToLeft +1 CARD8 min-byte1 +1 CARD8 max-byte1 +1 BOOL all-chars-exist +2 INT16 font-ascent +2 INT16 font-descent +4 m number of elements in char-infos +8n LISTofFONTPROP properties +and either +12m LISTofCHARINFO char-infos +or +m LISTofLBXCHARINFO char-infos + + + +The description of this request is on See +LbxQueryFont. + + + + +LbxChangeProperty +1 CARD8 opcode +1 23 lbx opcode +2 6 request length +4 WINDOW window +4 ATOM property +4 ATOM type +1 CARD8 format +1 mode +0 Replace +1 Preprend +2 Append +2 unused +4 CARD32 length of data in format units + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) +=> +1 1 Reply +1 unused +2 CARD16 sequence number +4 0 reply length +4 CARD32 tag +20 unused + + + +The description of this request is on See +LbxChangeProperty. + + + + +LbxGetProperty +1 CARD8 opcode +1 24 lbx opcode +2 7 request length +4 WINDOW window +4 ATOM property +4 ATOM type +0 AnyPropertyType +1 CARD8 delete +3 unused +4 CARD32 long-offset +4 CARD32 long-length +=> +1 1 Reply +1 CARD8 format +2 CARD16 sequence number +4 CARD32 reply length +4 ATOM type +0 None +4 CARD32 bytes-after +4 CARD32 length of value in format units + (= 0 for format = 0) + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) +4 CARD32 tag +8 unused + + + +The description of this request is on See +LbxGetProperty. + + + + +LbxTagData +1 CARD8 opcode +1 25 lbx opcode +2 3+(n+p)/4 request length +4 CARD32 tag +4 CARD32 length of data in bytes +n LISTofBYTE data +p unused, p=pad(n) + + + +The description of this request is on See +LbxTagData. + + + + +LbxCopyArea +1 CARD8 opcode +1 26 lbx opcode +2 L request length +1 CARD8 source drawable cache entry +1 LBXGCANDDRAWENT cache entries +4 or 0 DRAWABLE optional source drawable +b LBXGCANDDRAWUPDATE optional gc and dest drawable +c LBXPINT16 src-x +d LBXPINT16 src-y +e LBXPINT16 dst-x +f LBXPINT16 dst-y +g LBXCARD16 width +h LBXCARD16 height +p unused, p=Lpad + + + +The description of this request is on See +LbxCopyArea. + + + + +LbxCopyPlane +1 CARD8 opcode +1 27 lbx opcode +2 L request length +4 CARD32 bit plane +1 CARD8 source drawable cache entry +1 LBXGCANDDRAWENT cache entries +4 or 0 DRAWABLE optional source drawable +b LBXGCANDDRAWUPDATE optional gc and dest drawable +c LBXPINT16 src-x +d LBXPINT16 src-y +e LBXPINT16 dst-x +f LBXPINT16 dst-y +g LBXCARD16 width +h LBXCARD16 height +p unused, p=Lpad + + + +The description of this request is on See +LbxCopyPlane. + + + + +LbxPolyText8 +1 CARD8 opcode +1 28 lbx opcode +2 L request length +1 LBXGCANDDRAWENT cache entries +a LBXGCANDDRAWUPDATE optional gc and drawable +b LBXPINT16 x +c LBXPINT16 y +n LISTofTEXTITEM8 items +p unused, p=Lpad + + + +The description of this request is on See +LbxPolyText8. + + + + +LbxPolyText16 +1 CARD8 opcode +1 29 lbx opcode +2 L request length +1 LBXGCANDDRAWENT cache entries +a LBXGCANDDRAWUPDATE optional gc and drawable +b LBXPINT16 x +c LBXPINT16 y +2n LISTofTEXTITEM16 items +p unused, p=Lpad + + + +The description of this request is on See +LbxPolyText16. + + + + +LbxImageText8 +1 CARD8 opcode +1 30 lbx opcode +2 L request length +1 LBXGCANDDRAWENT cache entries +a LBXGCANDDRAWUPDATE optional gc and drawable +b LBXPINT16 x +c LBXPINT16 y +n STRING8 string +p unused, p=Lpad + + + +The description of this request is on See +LbxImageText8. + + + + +LbxImageText16 +1 CARD8 opcode +1 31 lbx opcode +2 L request length +1 LBXGCANDDRAWENT cache entries +a LBXGCANDDRAWUPDATE optional gc and drawable +b LBXPINT16 x +c LBXPINT16 y +2n STRING16 string +p unused, p=Lpad + + + +The description of this request is on See +LbxImageText16. + + + + +LbxQueryExtension +1 CARD8 opcode +1 32 lbx opcode +2 2+(n+p)/4 request length +4 n length of extension name +n STRING8 extension name +p unused, p=pad(n) +=> +1 1 Reply +1 n number of requests in the extension +2 CARD16 sequence number +4 0 or 2*(m + p) reply length, m = (n+7)/8 +1 BOOL present +1 CARD8 major opcode +1 CARD8 first event +1 CARD8 first error +20 unused +m LISTofMASK optional reply-mask +p unused, p=pad(m) +m LISTofMASK optional event-mask +p unused, p=pad(m) + + + +The description of this request is on See +LbxQueryExtension. + + + + +LbxPutImage +1 CARD8 opcode +1 33 lbx opcode +2 L request length +1 CARD8 compression method +1 LBXGCANDDRAWENT cache entries +a PIPACKED bit-packed +b LBXGCANDDRAWUPDATE optional gc and drawable +c LBXCARD16 width +d LBXCARD16 height +e LBXPINT16 x +f LBXPINT16 y +n LISTofBYTE compressed image data +p unused, p=Lpad + + + +If there is no left padding and the depth is less than or equal to nine, +PIPPACKED is encoded as follows: + + + +PIPACKED +1 #x80 | (format << 5) | ((depth -1) << 2) + + + +Otherwise PIPACKED is defined as: + + + +PIPACKED +1 (depth -1) << 2) +1 (format << 5) | left-pad + + + +The description of this request is on See +LbxPutImage. + + + + +LbxGetImage +1 CARD8 opcode +1 34 lbx opcode +2 6 request length +4 DRAWABLE drawable +2 INT16 x +2 INT16 y +2 CARD16 width +2 CARD16 height +4 CARD32 plane mask +1 CARD8 format +3 unused +=> +1 1 Reply +1 CARD8 depth +2 CARD16 sequence number +4 (n+p)/4 reply length +4 (m+p)/4 X reply length; if uncompressed, m=n +4 VISUALID visual +0 None +1 compression method +15 unused +n LISTofBYTE data +p unused, p=pad(n) + + + +The description of this request is on See +LbxGetImage. + + + + +LbxBeginLargeRequest +1 CARD8 opcode +1 35 lbx opcode +2 2 request length +4 CARD32 large request length + + + +The description of this request is on See +LbxBeginLargeRequest. + + + + +LbxLargeRequestData +1 CARD8 opcode +1 36 lbx opcode +2 1+n request length +4n LISTofBYTE data + + + +The description of this request is on See +LbxLargeRequestData. + + + + +LbxEndLargeRequest +1 CARD8 opcode +1 37 lbx opcode +2 1 request length + + + +The description of this request is on See +LbxEndLargeRequest. + + + + +LbxInternAtoms +1 CARD8 opcode +1 38 lbx opcode +2 1+(2+m+n+p)/4 request length +2 m num-atoms +n LISTofLONGSTR names +p pad p=Lpad +=> +1 1 Reply +1 unused +2 CARD16 sequence number +4 a reply length, a = MAX(m - 6, 0) +4*m LISTofATOM atoms +p pad p = MAX(0, 4*(6 - m)) +  +LONGSTR +2 c string length +c STRING8 string + + + +The description of this request is on See +LbxInternAtoms. + + + + +LbxGetWinAttrAndGeom +1 CARD8 opcode +1 39 lbx opcode +2 2 request length +4 CARD32 window id +=> +1 1 Reply +1 backing store +0 NotUseful +1 WhenMapped +2 Always +2 CARD16 sequence number +4 7 reply length +4 VISUALID visual id +2 class +1 InputOutput +2 InputOnly +1 BITGRAVITY bit gravity +1 WINGRAVITY window gravity +4 CARD32 backing bit planes +4 CARD32 backing pixel +1 BOOL save under +1 BOOL map installed +1 map state +0 Unmapped +1 Unviewable +2 Viewable +1 BOOL override +4 COLORMAP colormap +4 SETofEVENT all events mask +4 SETofEVENT your event mask +2 SETofDEVICEEVENT do not propagate mask +2 unused +4 WINDOW root +2 INT16 x +2 INT16 y +2 CARD16 width +2 CARD16 height +2 CARD16 border width +1 CARD8 depth +1 unused + + + +The description of this request is on See +LbxGetWinAttrAndGeom. + + + + +LbxGrabCmap +1 CARD8 opcode +1 40 lbx opcode +2 2 request length +4 COLORMAP colormap +=> + + + +If smart-grab is true, the reply is as follows: + + + +1 1 Reply +1 #x80 flags +2 CARD16 sequence number +4 0 reply length +24 unused + +If smart-grab is false, the reply is as follows: + +1 1 Reply +1 flags (set of) + #x40 auto-release + #x20 three-channels + #x10 two-byte-pixels +lower four bits specifies bits-per-pixel +2 CARD16 sequence number +4 L reply length +m CHAN or CHANNELS cells (CHAN if !three-channels) +p 0 pad(m) + +CHANNELS +a CHAN red +1 5 next channel +b CHAN green +1 5 next channel +c CHAN blue +1 0 list end + +CHAN +d LISTofLBXPIXEL + +LBXPIXEL +e PIXELPRIVATE or + PIXELPRIVATERANGE or + PIXELALLOC or + PIXELALLOCRANGE + +PIXELPRIVATE +1 1 pixel-private +f PIXEL pixel + +PIXEL +f CARD8 or CARD16 (CARD8 if !two-byte-pixels) + +PIXELPRIVATERANGE +1 2 pixel-private-range +f PIXEL fist-pixel +f PIXEL last-pixel + +PIXELALLOC +1 3 pixel-private +f PIXEL pixel +g COLORSINGLE or COLORTRIPLE color (COLORSINGLE if +three-channels) + +COLORSINGLE +h CARD8 or CARD16 value (CARD8 if bits-per-rgb =< 7) + +COLORTRIPLE +h COLORSINGLE red +h COLORSINGLE green +h COLORSINGLE blue + +PIXELALLOCRANGE +1 4 pixel-private +f PIXEL first-pixel +f PIXEL last-pixel +j LISTofCOLORSINGLE or color (COLORSINGLE if three-channels) + LISTofCOLORTRIPLE + + + +The description of this request is on See +LbxGrabCmap. + + + + +LbxReleaseCmap +1 CARD8 opcode +1 41 lbx opcode +2 2 request length +4 COLORMAP cmap + + + +The description of this request is on See +LbxReleaseCmap. + + + + +LbxAllocColor +1 CARD8 opcode +1 42 lbx opcode +2 5 request length +4 COLORMAP colormap +4 CARD32 pixel +2 CARD16 red +2 CARD16 green +2 CARD16 blue +2 unused + + + +The description of this request is on See +LbxAllocColor. + + + + +LbxSync +1 CARD8 opcode +1 43 lbx opcode +2 1 request length +=> +1 1 Reply +1 n unused +2 CARD16 sequence number +4 0 reply length +24 unused + + + +The description of this request is on See +LbxSync. + + + + + + +Events + + +LbxSwitchEvent +1 base + 0 code +1 0 lbx type +2 CARD16 sequence number +4 CARD32 client +24 unused + + + +The description of this event is on See +LbxSwitchEvent. + + + + +LbxCloseEvent +1 base + 0 code +1 1 lbx type +2 CARD16 sequence number +4 CARD32 client +24 unused + + + +The description of this event is on See +LbxCloseEvent. + + + + +LbxInvalidateTagEvent +1 base + 0 code +1 3 lbx type +2 CARD16 sequence number +4 CARD32 tag +4 tag-type +1 LbxTagTypeModmap +2 LbxTagTypeKeymap +3 LbxTagTypeProperty +4 LbxTagTypeFont +5 LbxTagTypeConnInfo +20 unused + + + +The description of this event is on See +LbxInvalidateTagEvent. + + + + +LbxSendTagDataEvent +1 base + 0 code +1 4 lbx type +2 CARD16 sequence number +4 CARD32 tag +4 tag-type +3 LbxTagTypeProperty +20 unused + + + +The description of this event is on See +LbxSendTagDataEvent. + + + + +LbxListenToOne +1 base + 0 code +1 5 lbx type +2 CARD16 sequence number +4 CARD32 client +#xFFFFFFFF +a client not managed by the proxy +24 unused + + + +The description of this event is on See +LbxListenToOne. + + + + +LbxListenToAll +1 base + 0 code +1 6 lbx type +2 CARD16 sequence number +28 unused + + + +The description of this event is on See +LbxListenToAll. + + + + +LbxQuickMotionDeltaEvent +1 base + 1 code +1 CARD8 delta-time +1 INT8 delta-x +1 INT8 delta-y + + + +This event is not padded to 32 bytes. + + + + +The description of this event is on See +LbxQuickMotionDeltaEvent. + + + + +LbxMotionDeltaEvent +1 base + 0 code +1 7 lbx type +1 INT8 delta-x +1 INT8 delta-y +2 CARD16 delta-time +2 CARD16 delta-sequence + + + +This event is not padded to 32 bytes. + + + + +The description of this event is on See +LbxMotionDeltaEvent. + + + + +LbxReleaseCmapEvent +1 base + 0 code +1 8 lbx type +2 CARD16 sequence number +4 COLORMAP colormap +24 unused + + + +The description of this event is on See +LbxReleaseCmapEvent. + + + + +LbxFreeCellsEvent +1 base + 0 code +1 9 lbx type +2 CARD16 sequence number +4 COLORMAP colormap +4 PIXEL pixel start +4 PIXEL pixel end +16 unused + + + +The description of this event is on See +LbxFreeCellsEvent. + + + + + +Re-encoding of X Events + + +The X protocol requires all X events to be 32 bytes. The LBX server reduces the +number of bytes sent between the server and the proxy for some X events by not +appending unused pad bytes to the event data. The offsets of X event data are +unchanged. The proxy will pad the events to 32 bytes before passing them on to +the client. + + + + +LBX reencodes X event representations into the following sizes, if squishing is +enabled: + + + +KeyOrButton 32 +EnterOrLeave 32 +Keymap 32 +Expose 20 +GraphicsExposure 24 +NoExposure 12 +VisibilityNotify 12 +CreateNotify 24 +DestroyNotify 12 +UnmapNotify 16 +MapNotify 16 +MapRequest 12 +Reparent 24 +ConfigureNotify 28 +ConfigureRequest 28 +GravityNotify 16 +ResizeRequest 12 +Circulate 20 +Property Notify 20 +SelectionClear 20 +SelectionRequest 28 +SelectionNotify 24 +Colormap Notify 16 +MappingNotify 8 +ClientMessage 32 +Unknown 32 + + + + +Responses + + +LbxDeltaResponse +1 event_base + 0 event code +1 2 lbx type +2 1+(2+2n+p)/4 request length +1 n count of diffs +1 CARD8 cache index +2n LISTofDIFFITEM offsets and differences +p unused, p=pad(2n) + + + +The description of this response is on See +LbxDeltaResponse. + + + + +
diff --git a/miniconda3/envs/ladir/share/doc/xextproto/multibuf.xml b/miniconda3/envs/ladir/share/doc/xextproto/multibuf.xml new file mode 100644 index 0000000000000000000000000000000000000000..9e2b0659472bd2d399efd85522bb2600cad21f64 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/multibuf.xml @@ -0,0 +1,1628 @@ + + %defs; +]> + + + + + + + Extending X for Double-Buffering, Multi-Buffering, and Stereo + + + JeffreyFriedberg + + + LarrySeiler + + + JeffVroom + + + 1989Digital Equipment Corporation + X Version 11, Release &fullrelvers; + Version 3.3 + + + +Permission to use, copy, modify, and distribute this documentation for any +purpose and without fee is hereby granted, provided that the above copyright +notice and this permission notice appear in all copies. +Digital Equipment Corporation makes no representations +about the suitability for any purpose of the information in +this document. This documentation is provided "as is" +without express or implied warranty. This document +is subject to change. + + + + +Copyright © 1989, 1994 X Consortium + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the ``Software''), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the name of the X Consortium shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the X Consortium. + +X Window System is a trademark of The OpenGroup. + + + + +Warning + +The Multi-Buffering extension described here +was a draft standard of the X Consortium prior to Release 6.1. It has been +superseded by the Double Buffer +Extension (DBE). DBE is an X Consortium Standard as of Release 6.1. + + + + +Introduction + + +Several proposals have been written that address some of the +issues surrounding the support of double-buffered, multi-buffered, +and stereo windows in the X Window System: + + + + + +Extending X for Double-Buffering, +Jeffrey Friedberg, Larry Seiler, Randi Rost. + + + + +(Proposal for) Double-Buffering Extensions, +Jeff Vroom. + + + + +An Extension to X.11 for Displays with Multiple Buffers, +David S.H. Rosenthal. + + + + +A Multiple Buffering/Stereo Proposal, +Mark Patrick. + + + + + +The authors of this proposal have tried to unify the above documents +to yield a proposal that incorporates support for double-buffering, +multi-buffering, and stereo in a way that is acceptable to all concerned. + + + + +Goals + + +Clients should be able to: + + + + + +Associate multiple buffers with a window. + + + + +Paint in any buffer associated with a window. + + + + +Display any buffer associated with a window. + + + + +Display a series of buffers in a window in rapid succession +to achieve a smooth animation. + + + + +Request simultaneous display of different buffers in different windows. + + + + + +In addition, the extension should: + + + + + +Allow existing X applications to run unchanged. + + + + +Support a range of implementation methods that can capitalize on +existing hardware features. + + + + + + + +Image Buffers + + +Normal windows are created using the standard +CreateWindow request: + + + +CreateWindow + parent : WINDOW + w_id : WINDOW + depth : CARD8 + visual : VISUALID or CopyFromParent + x, y : INT16 + width, height : INT16 + border_width : INT16 + value_mask : BITMASK + value_list : LISTofVALUE + + + +This request allocates a set of window attributes and +a buffer into which an image can be drawn. +The contents of this image buffer will +be displayed when the window is mapped to the screen. + + + +To support double-buffering and multi-buffering, +we introduce the notion that additional image buffers can +be created and bound together to form groups. +The following rules will apply: + + + + + +All image buffers in a group will have the same +visual type, depth, and geometry (ie: width and height). + + + + +Only one image buffer per group can be displayed +at a time. + + + + +Draw operations can occur to any image buffer at +any time. + + + + +Window management requests (MapWindow, DestroyWindow, +ConfigureWindow, etc...) +affect all image buffers associated with a window. + + + + +Appropriate resize and exposure events will be generated +for every image buffer that is affected by a window +management operation. + + + + + +By allowing draw operations to occur on any image buffer at any time, +a client could, on a multi-threaded multi-processor server, +simultaneously build up images for display. +To support this, each buffer must have its own resource ID. +Since buffers are different than windows and pixmaps +(buffers are not hierarchical and pixmaps cannot be displayed) +a new resource, Buffer, is introduced. +Furthermore, a Buffer is also a Drawable, thus +draw operations may also be performed on buffers simply +by passing a buffer ID to the existing pixmap/window +interface. + + + +To allow existing X applications to work unchanged, we assume +a window ID passed in a draw request, for a multi-buffered +window, will be an alias for the ID of the currently +displayed image buffer. Any draw requests (eq: GetImage) on +the window will be relative to the displayed image buffer. + + + +In window management requests, only a window ID will be +accepted. Requests like QueryTree, will continue to +return only window ID's. Most events will return +just the window ID. Some new events, described in a subsequent +section, will return a buffer ID. + + + +When a window has backing store the contents of the window +are saved off-screen. Likewise, when the contents of an image +buffer of a multi-buffer window is saved off-screen, it is +said to have backing store. This applies to all image buffers, +whether or not they are selected for display. + + + +In some multi-buffer implementations, undisplayed buffers might be +implemented using pixmaps. Since the contents of pixmaps exist +off-screen and are not affected by occlusion, these image buffers +in effect have backing store. + + + +On the other hand, both the displayed and undisplayed image buffers +might be implemented using a subset of the on-screen pixels. +In this case, unless the contents of an image buffer are saved +off-screen, these image buffers in effect do not have backing store. + + + +Output to any image buffer of an unmapped multi-buffered window +that does not have backing store is discarded. Output to any +image buffer of a mapped multi-buffer window will be performed; +however, portions of an image buffer may be occluded or clipped. + + + +When an unmapped multi-buffered window becomes mapped, the contents +of any image buffer buffer that did not have backing store is +tiled with the background and zero or more exposure events are +generated. If no background is defined for the window, then +the screen contents are not altered and the contents of any +undisplayed image buffers are undefined. If backing store was +maintained for an image buffer, then no exposure events are generated. + + + + +New Requests + + +The new request, CreateImageBuffers, creates a group of +image buffers and associates them with a normal X window: + + + +CreateImageBuffers + w_id : WINDOW + buffers : LISTofBUFFER + update_action : {Undefined,Background,Untouched,Copied} + update_hint : {Frequent,Intermittent,Static} + => + number_buffers : CARD16 + + (Errors: Window, IDChoice, Value) + + + +One image buffer will be associated with each ID passed in +buffers. +The first buffer of the list is referred to as buffer[0], the next +buffer[1], and so on. Each buffer will have the same visual type +and geometry as the window. +Buffer[0] will refer to the image buffer already associated +with the window ID and its contents will not be modified. +The displayed image buffer attribute is set to buffer[0]. + + + +Image buffers for the remaining ID's (buffer[1],...) are allocated. +If the window is mapped, or if these image buffers have backing +store, their contents will be tiled with the window background +(if no background is defined, the buffer contents are undefined), +and zero or more expose events will be generated for each of these +buffers. The contents of an image buffer is undefined when +the window is unmapped and the buffer does not have backing store. + + + +If the window already has a group of image buffers +associated with it (ie: from a previous CreateImageBuffers request) +the actions described for DestroyImageBuffers are performed first +(this will delete the association of the previous buffer ID's and +their buffers as well as de-allocate all buffers except for the +one already associated with the window ID). + + + +To allow a server implementation to efficiently allocate the +buffers, the total number of buffers required and +the update action (how they will behave during an update) +is specified "up front" in the request. +If the server cannot allocate all the buffers requested, the +total number of buffers actually allocated will be returned. +No Alloc errors will be generated \- buffer[0] can +always be associated with the existing displayed image buffer. + + + +For example, an application that wants to animate a short movie +loop may request 64 image buffers. The server may only be able to +support 16 image buffers of this type, size, and depth. +The application can then decide 16 buffers is sufficient and may +truncate the movie loop, or it may decide it really needs +64 and will free the buffers and complain to the user. + + + +One might be tempted to provide a request that inquires whether +n +buffers of a particular type, size, and depth +could be allocated. +But if the query is decoupled from the actual allocation, +another client could sneak in and take the buffers before the +original client has allocated them. + + + +While any buffer of a group can be selected for display, +some applications may display buffers in a predictable order +(ie: the movie loop application). The +list order +(buffer[0], buffer[1], ...) will be used as a hint by the +server as to which buffer will be displayed next. +A client displaying buffers in this order may see a +performance improvement. + + + +update_action indicates what should happen to a previously +displayed buffer when a different buffer becomes displayed. +Possible actions are: + + + + + Undefined + + +The contents of the buffer that was +last displayed will become undefined after the update. This +is the most efficient action since it allows the implementation +to trash the contents of the buffer if it needs to. + + + + + Background + + +The contents of the buffer that was +last displayed will be set to the background of the window after the update. +The background action allows devices to use a fast clear +capability during an update. + + + + + Untouched + + +The contents of the buffer that was +last displayed will be untouched after the update. Used +primarily when cycling through images that have already +been drawn. + + + + + Copied + + +The contents of the buffer that was +last displayed will become the same as those that are being +displayed after the update. This is useful when incrementally +adding to an image. + + + + + + + + +update_hint indicates how often the client will +request a different buffer to be displayed. +This hint will allow smart server implementations to choose the +most efficient means to support a multi-buffered window based +on the current need of the application (dumb implementations +may choose to ignore this hint). Possible hints are: + + + + + Frequent + + +An animation or movie loop is +being attempted and the fastest, most efficient means for +multi-buffering should be employed. + + + + + Intermittent + + +The displayed image will be +changed every so often. This is common for images that are +displayed at a rate slower than a second. For example, a +clock that is updated only once a minute. + + + + + Static + + +The displayed image buffer will +not be changed any time soon. Typically set by an application +whenever there is a pause in the animation. + + + + + + +To display an image buffer the following request can be used: + + + +DisplayImageBuffers + buffers : LISTofBUFFER + min_delay : CARD16 + max_delay : CARD16 + + (Errors: Buffer, Match) + + + +The image buffers listed will become displayed as simultaneously +as possible and the update action, bound at +CreateImageBuffers +time, will be performed. + + + +A list of buffers is specified to +allow the server to efficiently change the display of more than one +window at a time (ie: when a global screen swap method is used). +Attempting to simultaneously display +multiple image buffers from the same window is an error +(Match) since it violates the rule that only one +image buffer per group can be displayed at a time. + + + +If a specified buffer is already displayed, +any delays and update action will still be +performed for that buffer. In this instance, +only the update action of Background +(and possibly +Undefined) will have any affect on the +contents of the displayed buffer. These semantics allow +an animation application to successfully execute +even when there is only a single buffer available +for a window. + + + +When a DisplayImageBuffers request is made to an unmapped +multi-buffered window, the effect of the update action depends +on whether the image buffers involved have backing store. +When the target of the update action is an image buffer that +does not have backing store, output is discarded. When the +target image buffer does have backing store, the update is performed; +however, when the source of the update is an image buffer does not +have backing store (as in the case of update action +Copied), the +contents of target image buffer will become undefined. + + + +min_delay and +max_delay put a bound on how long the +server should wait before processing the display request. +For each of the windows to be updated by this request, at least +min_delay milli-seconds should elapse since +the last +time any of the windows were updated; conversely, no window +should have to wait more than max_delay +milli-seconds before being updated. + + + +min_delay allows an application to +slow down an animation or movie loop so that +it appears +synchronized at a rate the server can support given the current load. +For example, a min_delay of 100 indicates the +server should +wait at least 1/10 of a second since the last time any of the +windows were updated. A min_delay of zero +indicates no waiting is necessary. + + + +max_delay can be thought of as an additional +delay beyond min_delay the server is allowed +to wait +to facilitate such things as efficient update of multiple windows. +If max_delay would require an update before +min_delay +is satisfied, then the server should process the display request as +soon as the min_delay requirement is met. A +typical value for max_delay is zero. + + + +To implement the above functionality, the time since the last +update by a DisplayImageBuffers request for each +multi-buffered +window needs to be saved as state by the server. +The server may delay execution of the DisplayImageBuffers +request until the appropriate time (e.g. by requeuing the +request after computing the timeout); +however, the entire request must be processed in one operation. +Request execution indivisibility must be maintained. When +a server is implemented with internal concurrency, the +extension must adhere to the same concurrency semantics +as those defined for the core protocol. + + + +To explicitly clear a rectangular area of an image buffer to +the window background, the following request can be used: + + + +ClearImageBufferArea + buffer : BUFFER + x, y : INT16 + w, h : CARD16 + exposures : BOOL + + (Errors: Buffer, Value) + + + +Like the X ClearArea request, +x and y +are relative to +the window's origin and specify the upper-left corner of the rectangle. +If width is zero, it is replaced with the +current window width +minus x. If +height is zero it is replaced with the current +window height minus y. If the window has a +defined background tile, the rectangle is tiled with a plane mask of all ones, +a function of Copy, and a subwindow-mode of +ClipByChildren. +If the window has background None, the +contents of the buffer +are not changed. In either case, if +exposures is true, then one or +more exposure events are generated for regions of the rectangle that are +either visible or are being retained in backing store. + + + + +The group of image buffers allocated by a +CreateImageBuffers +request can be destroyed with the following request: + + + +DestroyImageBuffers + w_id : WINDOW + + (Error: Window) + + + +The association between the buffer ID's and their corresponding +image buffers are deleted. Any image buffers not selected for +display are de-allocated. If the window is not multi-buffered, +the request is ignored. + + + + + +Attributes + + +The following attributes will be associated with each window that +is multi-buffered: + + + + displayed_buffer : CARD16 + update_action : {Undefined,Background,Untouched,Copied} + update_hint : {Frequent,Intermittent,Static} + window_mode : {Mono,Stereo} + buffers : LISTofBUFFER + + + +displayed_buffer is set to the +index of the currently +displayed image buffer (for stereo windows, this will be +the index of the left buffer \- the index of the right buffer +is simply index+1). +window_mode indicates whether this window is +Mono or Stereo. +The ID for each buffer associated with the window is recorded +in the buffers list. +The above attributes can be queried with the following request: + + + +GetMultiBufferAttributes + w_id : WINDOW + => + displayed_buffer : CARD16 + update_action : {Undefined,Background,Untouched,Copied} + update_hint : {Frequent,Intermittent,Static} + window_mode : {Mono,Stereo} + buffers : LISTofBUFFER + + (Errors: Window, Access, Value) + + + +If the window is not multi-buffered, a Access error +will be generated. +The only multi-buffer attribute that can be explicitly set +is update_hint. Rather than have a specific +request to set this attribute, a generic set request is provided to +allow for future expansion: + + + +SetMultiBufferAttributes + w_id : WINDOW + value_mask : BITMASK + value_list : LISTofVALUE + + (Errors: Window, Match, Value) + + + +If the window is not multi-buffered, a Match error +will be generated. +The following attributes are maintained for each buffer of a +multi-buffered window: + + + + window : WINDOW + event_mask : SETofEVENT + index : CARD16 + side : {Mono,Left,Right} + + + +window indicates the window this buffer is +associated with. +event_mask specifies which events, relevant to +buffers, will be sent back to the client via the associated buffer ID +(initially no events are selected). +index is the list position (0, 1, ...) of the +buffer. +side indicates whether this buffer is +associated with +the left side or right side of a stereo window. +For non-stereo windows, this attribute will be set to +Mono. +These attributes can be queried with the following request: + + + +GetBufferAttributes + buffer : BUFFER + => + window : WINDOW + event_mask : SETofEVENT + index : CARD16 + side : {Mono,Left,Right} + + (Errors: Buffer, Value) + + + +The only buffer attribute that can be explicitly set +is event_mask. +The only events that are valid are +Expose and the new +ClobberNotify and UpdateNotify +event (see Events section below). +A Value error will be generated if an event not +selectable for a buffer is specified in an event mask. +Rather than have a specific request +to set this attribute, a generic set request is provided to +allow for future expansion: + + + +SetBufferAttributes + buffer : BUFFER + value_mask : BITMASK + value_list : LISTofVALUE + + (Errors: Buffer, Value) + + + +Clients may want to query the server about basic multi-buffer +and stereo capability on a per screen basis. The following request +returns a large list of information +that would most likely be read once by Xlib for each screen, and used as a +data base for other Xlib queries: + + + +GetBufferInfo + root : WINDOW + => + info : LISTofSCREEN_INFO + + + +Where SCREEN_INFO and +BUFFER_INFO are defined as: + + + + SCREEN_INFO : [ normal_info : LISTofBUFFER_INFO, + stereo_info : LISTofBUFFER_INFO ] + + BUFFER_INFO : [ visual : VISUALID, + max_buffers : CARD16, + depth : CARD8 ] + + + +Information regarding multi-buffering of normal (mono) windows +is returned in the normal_info list. +The stereo_info +list contains information about stereo windows. +If the stereo_info list is empty, stereo +windows are +not supported on the screen. If +max_buffers is zero, +the maximum number of buffers for the depth and visual is +a function of the size of the created window and current +memory limitations. + + + +The following request returns the major and minor version numbers +of this extension: + + + +GetBufferVersion + => + major_number : CARD8 + minor_number : CARD8 + + + +The version numbers are an escape hatch in case future revisions of +the protocol are necessary. In general, the major version would +increment for incompatible changes, and the minor version would +increment for small upward compatible changes. Barring changes, the +major version will be 1, and the minor version will be 1. + + + + +Events + + +All events normally generated for single-buffered +windows are also generated for multi-buffered windows. +Most of these events (ie: ConfigureNotify) will +only be generated for the window and not for each buffer. +These events will return a window ID. + + + +Expose events will be generated for both the window +and any buffer affected. When this event is generated for +a buffer, the same event structure will be used +but a buffer ID is returned instead of a window ID. +Clients, when processing these events, will know whether an +ID returned in an event structure is for a window or a buffer +by comparing the returned ID to the ones returned when the +window and buffer were created. + + + +GraphicsExposure and +NoExposure are generated +using whatever ID is specified in the graphics operation. +If a window ID is specified, the event will contain the +window ID. If a buffer ID is specified, the event will +contain the buffer ID. + + +In some implementations, moving a window +over a multi-buffered window may cause one or more of its buffers +to get overwritten or become unwritable. To allow a +client drawing into one of these buffers the opportunity +to stop drawing until some portion of the buffer is +writable, the following event is added: + + + +ClobberNotify + buffer : BUFFER + state : {Unclobbered,PartiallyClobbered,FullyClobbered} + + + +The ClobberNotify event is reported to clients selecting +ClobberNotify on a buffer. When a buffer +that was fully +or partially clobbered becomes unclobbered, an event with +Unclobbered +is generated. When a buffer that was unclobbered becomes +partially clobbered, an event with +PartiallyClobbered +is generated. When a buffer that was unclobbered or +partially clobbered becomes fully clobbered, an event with +FullyClobbered is generated. + + + +ClobberNotify events on a given buffer are +generated before any Expose events on that buffer, +but it is not required that all ClobberNotify +events on all buffers be generated before all +Expose events on all buffers. + + + +The ordering of ClobberNotify events with respect +to VisibilityNotify events is not constrained. + + + +If multiple buffers were used as an image FIFO between an image +server and the X display server, then the FIFO manager would like +to know when a buffer that was previously displayed, has been +undisplayed and updated, as the side effect of a +DisplayImageBuffers +request. This allows the FIFO manager to load up a future frame as +soon as a buffer becomes available. To support this, +the following event is added: + + + +UpdateNotify + buffer : BUFFER + + + +The UpdateNotify event is reported to clients selecting +UpdateNotify on a buffer. Whenever a buffer +becomes updated +(e.g. its update action is performed as part of a +DisplayImageBuffers +request), an UpdateNotify event is generated. + + + + +Errors + + +The following error type has been added to support +this extension: + + + +Buffer + +A value for a BUFFER argument does not name a defined BUFFER. + + + + +Double-Buffering Normal Windows + + +The following pseudo-code fragment illustrates how to create and display +a double-buffered image: + + + +/* + * Create a normal window + */ +CreateWindow( W, ... ) + +/* + * Create two image buffers. Assume after display, buffer + * contents become "undefined". Assume we will "frequently" + * update the display. Abort if we don't get two buffers, + */ +n = CreateImageBuffers( W, [B0,B1], Undefined, Frequent ) +if (n != 2) <abort> + +/* + * Map window to the screen + */ +MapWindow( W ) + +/* + * Draw images using alternate buffers, display every + * 1/10 of a second. Note we draw B1 first so it will + * "pop" on the screen + */ +while animating +{ + <draw picture using B1> + DisplayImageBuffers( [B1], 100, 0 ) + + <draw picture using B0> + DisplayImageBuffers( [B0], 100, 0 ) +} + +/* + * Strip image buffers and leave window with + * contents of last displayed image buffer. + */ +DestroyImageBuffers( W ) + + + + + +Multi-Buffering Normal Windows + + +Multi-buffered images are also supported by these requests. +The following pseudo-code fragment illustrates how to create a +a multi-buffered image and cycle through the images to +simulate a movie loop: + + + +/* + * Create a normal window + */ +CreateWindow( W, ... ) + +/* + * Create 'N' image buffers. Assume after display, buffer + * contents are "untouched". Assume we will "frequently" + * update the display. Abort if we don't get all the buffers. + */ +n = CreateImageBuffers( W, [B0,B1,...,B(N-1)], Untouched, Frequent ) +if (n != N) <abort> + +/* + * Map window to screen + */ +MapWindow( W ) + +/* + * Draw each frame of movie one per buffer + */ +foreach frame + <draw frame using B(i)> + +/* + * Cycle through frames, one frame every 1/10 of a second. + */ +while animating +{ + foreach frame + DisplayImageBuffers( [B(i)], 100, 0 ) +} + + + + + +Stereo Windows + +How stereo windows are supported on a server +is implementation +dependent. A server may contain specialized hardware that allows +left and right images to be toggled at field or frame rates. The +stereo affect may only be perceived with the aid of special +viewing glasses. The display of a +stereo picture should +be independent of how often the contents of the picture are +updated by an application. Double and +multi-buffering +of images should be possible regardless of whether the image +is displayed normally or in stereo. + + + +To achieve this goal, a simple extension to normal windows +is suggested. Stereo windows are just like normal windows +except the displayed image is made up of a left image +buffer and a right image buffer. To create a stereo window, +a client makes the following request: + + + +CreateStereoWindow + parent : WINDOW + w_id : WINDOW + left, right : BUFFER + depth : CARD8 + visual : VISUALID or CopyFromParent + x, y : INT16 + width, height : INT16 + border_width : INT16 + value_mask : BITMASK + value_list : LISTofVALUE + + (Errors: Alloc, Color, Cursor, Match, + Pixmap, Value, Window) + + + +This request, modeled after the CreateWindow request, +adds just two new parameters: left and +right. +For stereo, it is essential that one can distinguish whether +a draw operation is to occur on the left image or right image. +While an internal mode could have been added to achieve this, +using two buffer ID's allows clients to simultaneously build up +the left and right components of a stereo image. These +ID's always refer to (are an alias for) the left and right +image buffers that are currently displayed. + + + +Like normal windows, the window ID is used whenever a window +management operation is to be performed. Window queries would +also return this window ID (eg: QueryTree) as would most +events. Like the window ID, the left and right buffer ID's +each have their own event mask. They can be set and queried +using the Set/GetBufferAttributes requests. + + + +Using the window ID of a stereo window in a draw request +(eg: GetImage) results in pixels that are +undefined. +Possible semantics are that both left and right images get +drawn, or just a single side is operated on (existing applications +will have to be re-written to explicitly use the left and right +buffer ID's in order to successfully create, fetch, and store +stereo images). + + + +Having an explicit CreateStereoWindow request is helpful +in that a server implementation will know from the onset whether +a stereo window is desired and can return appropriate status +to the client if it cannot support this functionality. + + + +Some hardware may support separate stereo and non-stereo modes, +perhaps with different vertical resolutions. For example, the +vertical resolution in stereo mode may be half that of non-stereo +mode. Selecting one mode or the other must be done through some +means outside of this extension (eg: by providing a separate +screen for each hardware display mode). The screen attributes +(ie: x/y resolution) for a screen that supports normal windows, +may differ from a screen that supports stereo windows; +however, all windows, regardless of type, displayed on the +same screen must have the same screen attributes +(ie: pixel aspect ratio). + + + +If a screen that supports stereo windows also supports +normal windows, then the images presented to the left and +right eyes for normal windows should be the same +(ie: have no stereo offset). + + + + + +Single-Buffered Stereo Windows + + +The following shows how to create and display a single-buffered +stereo image: + + +/* + * Create the stereo window, map it the screen, + * and draw the left and right images + */ +CreateStereoWindow( W, L, R, ... ) + +MapWindow( W ) + +<draw picture using L,R> + + + + +Double-Buffering Stereo Windows + + +Additional image buffers may be added to a stereo window +to allow double or multi-buffering of stereo images. +Simply use the the CreateImageBuffers request. +Even numbered buffers (0,2,...) will be left buffers. +Odd numbered buffers (1,3,...) will be right buffers. +Displayable stereo images are formed by consecutive +left/right pairs of image buffers. For example, +(buffer[0],buffer[1]) form the first displayable +stereo image; (buffer[2],buffer[3]) the next; +and so on. + + + +The CreateImageBuffers request will only create +pairs of left and right image buffers for stereo windows. +By always pairing left and right image +buffers together, implementations might be able to +perform some type of optimization. If an odd number +of buffers is specified, a Value error is generated. +All the rules mentioned at the start of this proposal +still apply to the image buffers supported by a stereo window. + + + +To display a image buffer pair of a multi-buffered stereo image, +either the left buffer ID or right buffer ID may be specified in a +DisplayImageBuffers request, but not both. + + + +To double-buffer a stereo window: + + + +/* + * Create stereo window and map it to the screen + */ +CreateStereoWindow( W, L, R, ... ) + +/* + * Create two pairs of image buffers. Assume after display, + * buffer contents become "undefined". Assume we will "frequently" + * update the display. Abort if we did get all the buffers. + */ +n = CreateImageBuffers( W, [L0,R0,L1,R1], Undefined, Frequently ) +if (n != 4) <abort> + +/* + * Map window to the screen + */ +MapWindow( W ) + +/* + * Draw images using alternate buffers, + * display every 1/10 of a second. + */ +while animating +{ + <draw picture using L1,R1> + DisplayImageBuffers( [L1], 100, 0 ) + + <draw picture using L0,R0> + DisplayImageBuffers( [L0], 100, 0 ) +} + + + + + +Multi-Buffering Stereo Windows + + +To cycle through N stereo images: + + + +/* + * Create stereo window + */ +CreateStereoWindow( W, L, R, ... ) + +/* + * Create N pairs of image buffers. Assume after display, + * buffer contents are "untouched". Assume we will "frequently" + * update the display. Abort if we don't get all the buffers. + */ +n = CreateImageBuffers( W, [L0,R0,...,L(N-1),R(N-1)], Untouched, Frequently ) +if (n != N*2) <abort> + +/* + * Map window to screen + */ +MapWindow( W ) + +/* + * Draw the left and right halves of each image + */ +foreach stereo image + <draw picture using L(i),R(i)> + +/* + * Cycle through images every 1/10 of a second + */ +while animating +{ + foreach stereo image + DisplayImageBuffers( [L(i)], 100, 0 ) +} + + + + +Protocol Encoding + + +The official name of this extension is "Multi-Buffering". +When this string passed to QueryExtension the +information returned should be interpreted as follows: + + + + + major-opcode + + +Specifies the major opcode of this extension. +The first byte of each extension request should +specify this value. + + + + + first-event + + +Specifies the code that will be returned when +ClobberNotify events are generated. + + + + + first-error + + +Specifies the code that will be returned when +Buffer errors are generated. + + + + + + +The following sections describe the protocol +encoding for this extension. + + + + + +TYPES + + +BUFFER_INFO + +4 VISUALID visual +2 CARD16 max-buffers +1 CARD8 depth +1 unused + + + +SETofBUFFER_EVENT + + #x00008000 Exposure + #x02000000 ClobberNotify + #x04000000 UpdateNotify + + + + + +EVENTS + + +ClobberNotify +1 see first-event code +1 unused +2 CARD16 sequence number +4 BUFFER buffer +1 state + 0 Unclobbered + 1 PartiallyClobbered + 2 FullyClobbered +23 unused + + + +UpdateNotify +1 first-event+1 code +1 unused +2 CARD16 sequence number +4 BUFFER buffer +24 unused + + + + +ERRORS + + +Buffer +1 0 Error +1 see first-error code +2 CARD16 sequence number +4 CARD32 bad resource id +2 CARD16 minor-opcode +1 CARD8 major-opcode +21 unused + + + + + +REQUESTS + + +GetBufferVersion +1 see major-opcode major-opcode +1 0 minor-opcode +2 1 request length +-> +1 1 Reply +1 unused +2 CARD16 sequencenumber +4 0 reply length +1 CARD8 majorversion number +1 CARD8 minorversion number +22 unused + + +CreateImageBuffers + +1 see major-opcode major-opcode +1 1 minor-opcode +2 3+n requestlength +4 WINDOW wid +1 update-action + 0 Undefined + 1 Background + 2 Untouched + 3 Copied +1 update-hint + 0 Frequent + 1 Intermittent + 2 Static +2 unused +4n LISTofBUFFER buffer-list +-> +1 1 Reply +1 unused +2 CARD16 sequencenumber +4 0 reply length +2 CARD16 number-buffers +22 unused + + +DestroyImageBuffers + +1 see major-opcode major-opcode +1 2 minor-opcode +2 2 request length +4 WINDOW wid + + +DisplayImageBuffers + + +1 see major-opcode major-opcode +2 2+n requestlength +2 CARD16 min-delay +2 CARD16 max-delay +4n LISTofBUFFER buffer-list + + +SetMultiBufferAttributes + +1 see major-opcode major-opcode +1 4 minor-opcode +2 3+n requestlength +4 WINDOW wid +4 BITMASK value-mask (has n bits set to 1) + #x00000001 update-hint +4n LISTofVALUE value-list +VALUEs +1 update-hint + 0 Frequent + 1 Intermittent + 2 Static + + +GetMultiBufferAttributes + +1 see major-opcode major-opcode +1 5 minor-opcode +2 2 request length +4 WINDOW wid +® +1 1 Reply +1 unused +2 CARD16 sequencenumber +4 n reply length +2 CARD16 displayed-buffer +1 update-action + 0 Undefined + 1 Background + 2 Untouched + 3 Copied +1 update-hint + 0 Frequent + 1 Intermittent + 2 Static +1 window-mode + 0 Mono + 1 Stereo +19 unused +4n LISTofBUFFER buffer list + + +SetBufferAttributes + +1 see major-opcode major-opcode +1 6 minor-opcode +2 3+n requestlength +4 BUFFER buffer +4 BITMASK value-mask (has n bits set to 1) + #x00000001 event-mask +4n LISTofVALUE value-list +VALUEs +4 SETofBUFFER_EVENT event-mask + +GetBufferAttributes + +1 see major-opcode major-opcode +1 7 minor-opcode +2 2 request length +4 BUFFER buffer +-> +1 1 Reply +1 unused +2 CARD16 sequencenumber +4 0 reply length +4 WINDOW wid +4 SETofBUFFER_EVENT event-mask +2 CARD16 index + 1 side + 0 Mono + 1 Left + 2 Right +13 unused + +GetBufferInfo + +1 see major-opcode major-opcode +1 8 minor-opcode +2 2 request length +4 WINDOW root +® +1 1 Reply +1 unused +2 CARD16 sequencenumber +4 2(n+m) replylength +2 n number BUFFER_INFO in normal-info +2 m number BUFFER_INFO in stereo-info +20 unused +8n LISTofBUFFER_INFO normal-info +8m LISTofBUFFER_INFO stereo-info + +CreateStereoWindow + +1 see major-opcode major-opcode +1 9 minor-opcode +2 11+n requestlength +3 unused +1 CARD8 depth +4 WINDOW wid +4 WINDOW parent +4 BUFFER left +4 BUFFER right +2 INT16 x +2 INT16 y +2 CARD16 width +2 CARD16 height +2 CARD16 border-width +2 class + 0 CopyFromParent + 1 InputOutput + 2 InputOnly +4 VISUALID visual + 0 CopyFromParent +4 BITMASK value-mask (has n bits set to 1) + encodings are the same + as for CreateWindow +4n LISTofVALUE value-list + encodings are the same + as for CreateWindow + + +ClearImageBufferArea + +1 see major-opcode major-opcode +1 10 minor-opcode +2 5 request length +4 WINDOW buffer +2 INT16 x +2 INT16 y +2 CARD16 width +2 CARD16 height +3 unused +1 BOOL exposures + + + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/security.xml b/miniconda3/envs/ladir/share/doc/xextproto/security.xml new file mode 100644 index 0000000000000000000000000000000000000000..35f3395e4e20fea4f9a3d4445e128b8bab522f04 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/security.xml @@ -0,0 +1,1467 @@ + + %defs; +]> + + + + + + Security Extension Specification + X Consortium Standard + + + DavidP.Wiggins + X Consortium + + + X Version 11, Release &fullrelvers; + Version 7.1 + 1996X Consortium + + + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the “Software”), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the name of the X Consortium shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the X Consortium. + +X Window System is a trademark of The OpenGroup. + + +November 15, 1996 + + + + +Introduction + + +The Security extension contains new protocol needed to provide enhanced X +server security. The Security extension should not be exposed to untrusted +clients (defined below). + + + + + +Requests + + +SecurityQueryVersion + +This request returns the major and minor version numbers of this extension. + + +SecurityQueryVersion + + + + + + + + + + client-major-version + + + CARD16 + + + + + client-minor-version + + + CARD16 + + + + + => + + + + + server-major-version + + + CARD16 + + + + + server-minor-version + + + CARD16 + + + + + + + +The client-major-version and client-minor-version numbers indicate what +version of the protocol the client wants the server to implement. The +server-major-version and the server-minor-version numbers returned +indicate the protocol this extension actually supports. This might not +equal the version sent by the client. An implementation can (but need not) +support more than one version simultaneously. The server-major-version +and server-minor-version allow the creation of future revisions of the +Security protocol that may be necessary. In general, the major version +would increment for incompatible changes, and the minor version would +increment for small, upward-compatible changes. Servers that support +the protocol defined in this document will return a server-major-version +of one (1), and a server-minor-version of zero (0). + + + +Clients using the Security extension must issue a SecurityQueryVersion +request before any other Security request in order to negotiate a compatible +protocol version; otherwise, the client will get undefined behavior +(Security may or may not work). + + + + +SecurityGenerateAuthorization + + +This request causes the server to create and return a new authorization with +specific characteristics. Clients can subsequently connect using the new +authorization and will inherit some of the characteristics of the +authorization. + + + +SecurityGenerateAuthorization + + + + + + + + + + authorization-protocol-name + + + STRING8 + + + + + authorization-protocol-data + + + STRING8 + + + + + value-mask + + + BITMASK + + + + + value-list + + + LISTofVALUE + + + + + => + + + + + + + authorization-id + + + AUTHID + + + + + authorization-data-return + + + STRING8 + + + + + + + +Errors: AuthorizationProtocol, Value, Alloc + + + +authorization-protocol-name is the name of the authorization method for +which the server should generate a new authorization that subsequent +clients can use to connect to the server. If the authorization-protocol-name +is not one that the server supports, or if authorization-protocol-data +does not make sense for the given authorization-protocol-name, an +AuthorizationProtocol error results. + + + +authorization-protocol-data is authorization-method specific data that can +be used in some way to generate the authorization. + + + +In this version of the extension, the only authorization method +required to be supported is "MIT-MAGIC-COOKIE-1" with any amount +of authorization-protocol-data (including none). The server may use the +authorization-protocol-data as an additional source of randomness used +to generate the authorization. Other authorization methods can supply +their own interpretation of authorization-protocol-data. + + + +The value-mask and value-list specify attributes of the authorization +that are to be explicitly initialized. The possible values are: + + + + + + + + + + + Attribute + Type + Default + + + + + + timeout + + + CARD32 + + + 60 + + + + + group + + + XID or None + + + None + + + + + trust-level + + + {SecurityClientTrusted, + + + + + + + + SecurityClientUntrusted} + + + SecurityClientUntrusted + + + + + event-mask + + + SecurityAuthorizationRevoked, + + + + + + + + or None + + + None + + + + + + + +timeout is the timeout period in seconds for this authorization. A +timeout value of zero means this authorization will never expire. For +non-zero timeout values, when timeout seconds have elapsed since the +last time that the authorization entered the state of having no +connections authorized by it, and if no new connections used the +authorization during that time, the authorization is automatically purged. +(Note that when an authorization is created, it enters the state of having no +connections authorized by it.) Subsequent connection attempts using that +authorization will fail. This is to facilitate "fire and forget" launching of +applications. + + + +group is an application group ID as defined by the Application Group +extension, or None. Any other values will cause a Value error. When a +group is destroyed, all authorizations specifying that group are revoked +as described under the SecurityRevokeAuthorization request. The Application +Group extension attaches additional semantics to the group. + + + +trust-level tells whether clients using the authorization are trusted or +untrusted. If trust-level is not one of the constants SecurityClientTrusted +or SecurityClientUntrusted, a Value error results. + + + +event-mask defines which events the client is interested in for this +authorization. When the authorization expires or is revoked if event-mask +contains SecurityAuthorizationRevoked a SecurityAuthorizationRevoked event +is reported to the client. + + + +The SecurityAuthorizationRevoked event contains the following field: + + + + + + + + + + Field + Type + + + + + + authorization-id + + + AUTHID + + + + + + + +where authorization-id is the identification of the authorization that was +revoked. + + +If an invalid value-mask is specified, a Value error occurs. + + + +The returned authorization-id is a non-zero value that uniquely identifies +this authorization for use in other requests. The value space for type +AUTHID is not required to be disjoint from values spaces of other core +X types, e.g. resource ids, atoms, visual ids, and keysyms. Thus, a given +numeric value might be both a valid AUTHID and a valid atom, for example. + + + +authorization-data-return is the data that a client should use in some +authorization-method-specific way to make a connection with this +authorization. For "MIT-MAGIC-COOKIE-1," authorization-data-return should +be sent as the authorization-protocol-data in the connection setup message. +It is not required that other authorization methods use +authorization-data-return this way. + + + + + +SecurityRevokeAuthorization + + +This request deletes an authorization created by SecurityGenerateAuthorization. + + + +SecurityRevokeAuthorization + + + + + + + + + + + authorization-id + + + AUTHID + + + + + + + +Errors: Authorization + + + +If authorization-id does not name a valid authorization, an Authorization +error occurs. Otherwise, this request kills all clients currently connected +using the authorization specified by authorization-id. The authorization is +deleted from the server's database, so future attempts by clients to connect +with this authorization will fail. + + + + + + +Changes to Core Requests + + +A server supporting this extension modifies the handling of some core +requests in the following ways. + + +Resource ID Usage + + +If an untrusted client makes a request that specifies a resource ID that is +not owned by another untrusted client, a protocol error is sent to the +requesting client indicating that the specified resource does not exist. +The following exceptions apply. An untrusted client can: + + + + + +use the QueryTree, GetGeometry, and TranslateCoordinates requests +without restriction. + + + + +use colormap IDs that are returned in the default-colormap field of its +connection setup information in any colormap requests. + + + + specify a root window as: + + + +the drawable field of CreatePixmap, CreateGC, and QueryBestSize. + + + + the parent field of CreateWindow. + + + +the window field of CreateColormap, ListProperties, and GetWindowAttributes. + + + + the grab-window or confine-to fields of GrabPointer. + + + + the grab-window field of UngrabButton. + + + +the destination of SendEvent, but only if all of the following are true. +(These conditions cover all the events that the ICCCM specifies with +a root window destination.) + + + + The propagate field of SendEvent is False. + + + +The event-mask field of SendEvent is ColormapChange, +StructureNotify, or the logical OR of SubstructureRedirect with +SubstructureNotify. + + + + +The event type being sent is UnmapNotify, ConfigureRequest, or +ClientMessage. + + + + + + +the window field of ChangeWindowAttributes, but only if the value-mask +contains only event-mask and the corresponding value is StructureNotify, +PropertyChange, or the logical OR of both. + + + + + + + + +ISSUE: are root window exceptions needed for these? WarpPointer, ReparentWindow +(parent), CirculateWindow, QueryPointer (emacs does this), GetMotionEvents. + + + + + +Extension Security + + +This extension introduces the notion of secure and insecure extensions. A +secure extension is believed to be safe to use by untrusted clients; that +is, there are no significant security concerns known that an untrusted +client could use to destroy, modify, or steal data of trusted clients. This +belief may be founded on a careful analysis of the extension protocol, +its implementation, and measures taken to "harden" the extension to close +security weaknesses. All extensions not considered secure are called +insecure. The implementation details of how an extension is identified as +secure or insecure are beyond the scope of this specification. + + + +ListExtensions will only return names of secure +extensions to untrusted clients. + + + +If an untrusted client uses QueryExtension on an +insecure extension that the server supports, the reply will have the +present field set to False and the major-opcode field set to zero to +indicate that the extension is not supported. + + + +If an untrusted client successfully guesses the major opcode of an +insecure extension, attempts by it to execute requests with that major +opcode will fail with a Request error. + + + + + +Keyboard Security + + + +The protocol interpretation changes in this section are intended to prevent +untrusted applications from stealing keyboard input that was meant for +trusted clients and to prevent them from interfering with the use of the +keyboard. + + + +The behavior of some keyboard-related requests and events is modified when +the client is untrusted depending on certain server state at the time of +request execution or event generation. Specifically, if a hypothetical +keyboard event were generated given the current input focus, pointer +position, keyboard grab state, and window event selections, and if that +keyboard event would not be delivered to any untrusted client, the +following changes apply: + + + + + +The bit vector representing the up/down state of the keys returned by +QueryKeymap and +KeymapNotify is all zeroes. + + + + GrabKeyboard returns a status of AlreadyGrabbed. + + + +SetInputFocus does nothing. Note that this means the +Globally Active +Input and WM_TAKE_FOCUS mechanisms specified in the ICCCM will +not work with untrusted clients. + + + + +Passive grabs established by GrabKey that would otherwise have activated +do not activate. + + + + + +If an untrusted client attempts to use any of the following requests, the +only effect is that the client receives an Access error: SetModifierMapping, +ChangeKeyboardMapping, ChangeKeyboardControl. + + + +If an InputOnly window owned by an untrusted client has a parent owned by a +trusted client, all attempts to map the window will be ignored. This includes +mapping attempts resulting from MapWindow, MapSubwindows, ReparentWindow, +and save-set processing. + + +However, if the parent of an InputOnly window owned by an untrusted client +is the root window, attempts to map that window will be performed as +expected. This is in line with the root window exceptions above. + + + + +Image Security + + +It should be impossible for an untrusted client to retrieve the image +contents of a trusted window unless a trusted client takes action to allow +this. We introduce the following defenses in support of this requirement. + + + +The restrictions on resource ID usage listed above prevent untrusted clients +from using GetImage directly on windows not belonging to trusted clients. + + + +If an untrusted client tries to set the background-pixmap attribute of an +untrusted window to None, the server will instead use a server-dependent +background which must be different than None. + + + +The X protocol description of GetImage states that the +returned contents of regions of a window obscured by noninferior windows are +undefined if the window has no backing store. Some implementations return the +contents of the obscuring windows in these regions. When an untrusted client +uses GetImage, this behavior is forbidden; the server must +fill the obscured regions in the returned image with a server-dependent pattern. + + + +If an untrusted window has trusted inferiors, their contents are vulnerable +to theft via GetImage on the untrusted parent, as well +as being vulnerable to destruction via drawing with subwindow-mode +IncludeInferiors on the untrusted parent. An untrusted window having trusted +inferiors can only occur at the request of a trusted client. It is expected +to be an unusual configuration. + + + + + +Property Security + + +Unlike the other security provisions described in this document, security for +property access is not amenable to a fixed policy because properties are +used for inter-client communication in diverse ways and may contain data of +varying degrees of sensitivity. Therefore, we only list the possible +restrictions the server may decide to impose on use of properties on trusted +windows by untrusted clients. How the server chooses which restrictions from +this list to apply to a particular property access is implementation dependent + +In the X Consortium server implementation, property access is controlled by +a configuration file; see the -sp option in the Xserver(1) manual page. + . + + +The X Protocol property requests are +ChangeProperty, +GetProperty, +DeleteProperty, +RotateProperties, and +ListProperties. For these requests, the server can +allow the request to execute normally (as if it had been issued by a +trusted client), ignore the request completely (as if it were a NoOperation), +or ignore the request except to send an Atom error to the client. Ignoring +a ListProperties request means replying that +the window has no properties. ListProperties may also +reply with a subset of the existing properties if the server is doing +property hiding; see below. An ignored GetProperty +request may reply that the property does not exist, or that it exists but +contains no data. + + + +The server may decide to hide certain properties on certain windows from +untrusted clients + +The X Consortium server implementation does not currently provide a way to +hide properties. + . +If a property is to be hidden, it must be done consistently to avoid +confusing clients. This means that for untrusted clients: + + + + + +That property should not be returned by +ListProperties. + + + + +PropertyNotify events should not be sent for that +property. + + + +GetProperty on that property should reply that the +property does not exist (the return type is None, the format and +bytes-after are zero, and the value is empty). + + + + + +For a property that the server is protecting but not hiding, consistency +must also be maintained: + + + + + +That property should be returned by ListProperties. + + + + +PropertyNotify events should be sent for that property. + + + + +GetProperty on that property should reply that the +property exists (if it really does) but the value is empty +(return type and format are their real values, and the "length of value" +field in the reply is zero). + + + + + + + +Miscellaneous Security + + +If an untrusted client attempts to use +ChangeHosts, +ListHosts, or +SetAccessControl, +the only effect is that the client receives an Access error. + + + +If an untrusted client attempts to use ConvertSelection +on a selection with a trusted selection owner window, the server generates +a SelectionNotify event to the requestor with property None. + + + + + +New Authorization Method + + +This extension includes a new authorization method named +"XC-QUERY-SECURITY-1". Its purpose is to allow an external agent such as +the X firewall proxy to probe an X server to determine whether that server +meets certain security criteria without requiring the agent to have its +own authorization for that server. The agent may use the returned information +to make a decision. For example, the X firewall proxy may choose not to +forward client connections to servers that do not meet the criteria. + + + +To use this authorization method, the client (or proxy) sends +"XC-QUERY-SECURITY-1" as the authorization-protocol-name in the initial +connection setup message. The authorization-protocol-data may be empty or +may contain additional security criteria described below. If the success +field of the server's reply is Authenticate, the server supports the +security extension, and the server meets all specified additional security +criteria. In this case, the client should resend the initial connection +setup message substituting the authorization protocol name and data +that should be used to authorize the connection. If the success field of the +server's reply is anything other than Authenticate, either the server does not +support the security extension, does not meet (or cannot determine if it +meets) all of the additional security criteria, or chooses for internal reasons +not to answer with Authenticate. In this case, the client should close the +connection. + + + +If the authorization-protocol-data sent with "XC-QUERY-SECURITY-1" is not +empty, it specifies additional security criteria for the server to check, as +follows. + + + +authorization-protocol-data + + + + + + + + + + + policy-mask + + + BITMASK + + + + + policies + + + LISTofSECURITYPOLICY + + + + + + + +The policy-mask field is any logical-OR combination of the constants +Extensions and SitePolicies. For each bit set in policy-mask, there is a +SECURITYPOLICY element in policies. The nth element in policies corresponds +to the nth 1-bit in policy-mask, counting upward from bit 0. + + +SECURITYPOLICY + + + + + + + + + + policy-type + + + {Disallow, Permit} + + + + + names + + + LISTofSTR + + + + + + + +For a SECURITYPOLICY corresponding to policy-mask Extensions, if +policy-type is Disallow the server is required to consider as insecure +all extensions given in names. No policy is specified for extensions +not listed in names. If policy-type is Permit the server may consider +only those extensions given in names to be secure; all other extensions +must be treated as insecure. If these constraints are not met, the server +should not return Authenticate in the success field of the reply. +Servers can but need not dynamically configure themselves in response +to an Extensions SECURITYPOLICY; a conforming server might simply compare +the policy with a compiled-in table of extensions and their security status. + + + +For a SECURITYPOLICY corresponding to policy-mask SitePolicies, policy-type +Disallow means the server must not have been configured with any of the site +policies given in names. Policy-type Permit means the server must have +been configured with at least one of the site policies given in names. If +these constraints are not met, the server should not return Authenticate in +the success field of the reply. + + + +SitePolicies provide a way to express new forms of security-relevant +information that could not be anticipated at the time of this writing. +For example, suppose the server is found to have a critical security defect. +When a fix is developed, a site policy string could be associated with the +fix. Servers with the fix would advertise that site policy, and the X +firewall proxy would specify that site policy in a SECURITYPOLICY with +policy-type Permit. + + + + + +Encoding + + +Please refer to the X11 Protocol Encoding document as this section +uses syntactic conventions and data types established there. + + + +The name of this extension is "SECURITY". + + + +Types + +AUTHID: CARD32 + + + + +Request Encoding + + +SecurityQueryVersion + + +1 CARD8 major-opcode +1 0 minor-opcode +2 2 request length +2 CARD16 client-major-version +2 CARD16 client-minor-version +=> +1 1 Reply +1 unused +2 CARD16 sequence number +4 0 reply length +2 CARD16 server-major-version +2 CARD16 server-minor-version +20 unused + + + +SecurityRevokeAuthorization + + + +1 CARD8 major-opcode +1 2 minor-opcode +2 2 request length +4 AUTHID authorization-id + + + +SecurityGenerateAuthorization + + + +1 CARD8 major-opcode +1 1 minor-opcode +2 3 + (m+n+3)/4 + s request length +2 CARD16 m, number of bytes in authorization protocol name +2 CARD16 n, number of bytes in authorization data +m STRING8 authorization protocol name +n STRING8 authorization protocol data +p unused, p=pad(m+n) +4 BITMASK value-mask (has s bits set to 1) + #x00000001 timeout + #x00000002 trust-level + #x00000004 group + #x00000008 event-mask +4s LISTofVALUE value-list + + + +VALUES + + +4 CARD32 timeout +4 trust-level + 0 SecurityClientTrusted + 1 SecurityClientUntrusted +4 XID group +0 None +4 CARD32 event-mask + #x00000001 SecurityAuthorizationRevoked +=> +1 1 Reply +1 unused +2 CARD16 sequence number +4 (q+3)/4 reply length +4 AUTHID authorization-id +2 CARD16 data-length +18 unused +q STRING8 authorization-data-return +r unused, r=pad(q) + + + + + +Event Encoding + +SecurityAuthorizationRevoked + + + +1 0+extension event base code +1 unused +2 CARD16 sequence number +4 AUTHID authorization id +24 unused + + + + + +Authorization Method Encoding + + +For authorization-protocol-name "XC-QUERY-SECURITY-1", the +authorization-protocol-data is interpreted as follows: + + + +authorization-protocol-data + + +1 BITMASK policy-mask + #x00000001 Extensions + #x00000002 SitePolicies +m LISTofSECURITYPOLICY policies + + + +SECURITYPOLICY + + + +1 policy-type + 0 Permit + 1 Disallow +1 CARD8 number of STRs in names +n LISTofSTR names + + + +LISTofSTR has the same encoding as in the X protocol: each STR is a single +byte length, followed by that many characters, and there is no padding or +termination between STRs. + + + + + +C Language Binding + + +The header for this extension is <X11/extensions/security.h>. All +identifier names provided by this header begin with XSecurity. + + + +All functions that have return type Status will return nonzero for +success and zero for failure. + + + + + Status XSecurityQueryExtension + Display *dpy + int *major_version_return + int *minor_version_return + + + + + sets major_version_return and +minor_version_return to the major and minor Security protocol version +supported by the server. If the Security library is compatible with the +version returned by the server, it returns nonzero. If dpy does not support +the Security extension, or if there was an error during communication with +the server, or if the server and library protocol versions are incompatible, +it returns zero. No other XSecurity functions may be called before this +function. If a client violates this rule, the effects of all subsequent +XSecurity calls that it makes are undefined. + + + + + Xauth *XSecurityAllocXauth + void + + + +In order to provide for future evolution, Xauth structures are used to +pass and return authorization data, and the library provides ways to +allocate and deallocate them. + + + + must be used to allocate the +Xauth structure that is passed to +. + + + +For the purposes of the Security extension, the Xauth structure has +the following fields: + + + + + + + + + + + Type + Field name + Description + + + + + + unsigned short + + + name_length + + + number of bytes in name + + + + + char * + + + name + + + authorization protocol name + + + + + unsigned short + + + data_length + + + number of bytes in data + + + + + char * + + + data + + + authorization protocol data + + + + + + +The Xauth structure returned by this function is initialized as follows: +name_length and data_length are zero, and name and data are NULL. + + + + + void XSecurityFreeXauth + Xauth *auth + + + + + must be used to free Xauth +structures allocated by + or returned by +. It is the +caller's responsibility to fill in the name and data fields of Xauth structures +allocated with , so this function +will not attempt to free them. In contrast, all storage associated with +Xauth structures returned from + will be freed by this +function, including the name and data fields. + + + + + + Bool XSecurityRevokeAuthorization + Display *dpy + XSecurityAuthorization auth_id + + + + + deletes the authorization +specified by auth_id, which must be a value returned in the auth_id_return +parameter of . All +clients that connected with that authorization are be killed. Subsequently, +clients that attempt to connect using that authorization will be refused. + + + + + + Xauth *XSecurityGenerateAuthorization + Display *dpy + Xauth *auth_in + unsigned long valuemask + XSecurityAutorizationAttributes *attributes + XSecurityAutorization *auth_id_return + + + + + creates a new +authorization with the specified attributes. The auth_in argument must be +allocated by . The +name and name_length fields of auth_in should be initialized to the +authorization protocol name and its length in characters respectively. +If there is authorization data, the data and data_length fields of +auth_in should be initialized to the data and its length in characters +respectively. The library does not assume that name and data are +null-terminated strings. The auth_in argument must be freed with +. + + + +The XSecurityAuthorizationAttributes structure has the following fields: + + + + + + + + + + + Type + Field name + Mask + + + + + + unsigned int + + + trust_level + + + XSecurityTrustLevel + + + + + unsigned int + + + timeout + + + XSecurityTimeout + + + + + XID + + + group + + + XSecurityGroup + + + + + long + + + event_mask + + + XSecurityEventMask + + + + + + + +These correspond to the trust-level, timeout, group, and event-mask +described in the SecurityGenerateAuthorization protocol request. The +caller can fill in values for any subset of these attributes. The valuemask +argument must be the bitwise OR of the symbols listed in the Mask column +for all supplied attributes. The event_mask attribute can be None, +XSecurityAuthorizationRevokedMask, or XSecurityAllEventMasks. In this +revision of the protocol specification XSecurityAllEventMasks is equivalent +to XSecurityAuthorizationRevokedMask. If the caller does not need to +specify any attributes, the attributes argument can be NULL, and the +valuemask argument must be zero. + + +If the function fails, NULL is returned and auth_id_return is filled in +with zero. Otherwise, a pointer to an Xauth structure is returned. The name +and name_length fields of the returned Xauth structure will be copies of the +name that was passed in, and the data and data_length fields will be set to +the authorization data returned by the server. The caller should not assume +that name and data are null-terminated strings. If no authorization data was +returned by the server, the data and data_length fields will be set to NULL +and zero respectively. The returned Xauth structure must be freed with +; the caller should not use any other +means free the structure or any of its components. The auth_id_return +argument will be filled in with the non-zero authorization id of the created +authorization. + + + +The XSecurityAuthorizationRevokedEvent structure has the following fields: + + + + + + + + + + + Type + Field name + Description + + + + + + int + + + type + + + event base + XSecurityAuthorizationRevoked + + + + + unsigned long + + + serial + + + # of last request processed by server + + + + + Bool + + + send_event + + + true if this came from SendEvent + + + + + Display* + + + display + + + Display the event was read from + + + + + XSecurityAuthorization + + + auth_id + + + revoked authorization id + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/shape.xml b/miniconda3/envs/ladir/share/doc/xextproto/shape.xml new file mode 100644 index 0000000000000000000000000000000000000000..16751ffdbc8898e6d11f47c1741b5371f38b2107 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/shape.xml @@ -0,0 +1,1244 @@ + + %defs; +]> + + + + + + + X Nonrectangular Window Shape Extension Protocol + X.Org Standard + + + KeithPackard + MIT X Consortium + Intel Corporation + + + HidekiHiura + SunSoft, Inc. + + + X Version 11, Release &fullrelvers; + Version 1.1 + 19892004The Open Group + 2006Keith Packard + + + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the name of the copyright holders +shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the +copyright holders. + + + + + +Overview + + +This extension provides arbitrary window and border shapes within the X11 +protocol. + + + +The restriction of rectangular windows within the X protocol is a significant +limitation in the implementation of many styles of user interface. For +example, many transient windows would like to display a "drop shadow'' to +give the illusion of 3 dimensions. As another example, some user interface +style guides call for buttons with rounded corners; the full simulation of a +nonrectangular shape, particularly with respect to event distribution and +cursor shape, is not possible within the core X protocol. As a final +example, round clocks and nonrectangular icons are desirable visual addition +to the desktop. + + + +This extension provides mechanisms for changing both the visible and interactive shape of a +window to arbitrary, possibly disjoint, nonrectangular forms. The intent +of the extension is to supplement the existing semantics, not replace them. +In particular, it is desirable for clients that are unaware of the +extension to still be able to cope reasonably with shaped windows. For +example, window managers should still be able to negotiate screen +real estate in rectangular pieces. Toward this end, any shape specified for +a window is clipped by the bounding rectangle for the window as specified by +the window's geometry in the core protocol. An expected convention would be +that client programs expand their shape to fill the area offered by the +window manager. + + + + +Description + +Each window (even with no shapes specified) is defined by three regions: the +bounding region, the clip +region and the input region. The +bounding region is the area of the +parent window that the window will occupy (including border). The clip region +is the subset of the bounding region that is available for subwindows and +graphics. The area between the bounding region and the clip region is defined +to be the border of the window. The input region is the subset of the +bounding region that can "contain" the pointer. + + + +A nonshaped window will have a bounding region that is a rectangle +spanning the window, including its border; the clip region will be a rectangle +filling the inside dimensions (not including the border); the input +region will match the bounding region. In this document, +these areas are referred to as the +default bounding region, the +default clip region and the +default input region. For a window with inside +size of width by +height and border width +bwidth, the default bounding, clip +and input regions are the rectangles (relative to the window origin): + + + +bounding.x = -bwidth +bounding.y = -bwidth +bounding.width = width + 2 * bwidth +bounding.height = height + 2 * bwidth + +clip.x = 0 +clip.y = 0 +clip.width = width +clip.height = height + +input.x = -bwidth +input.y = -bwidth +input.width = width + 2 * bwidth +input.height = height + 2 * bwidth + + + +This extension allows a client to modify any combination of the bounding, +clip or input regions by specifying new regions that combine with the default +regions. These new regions are called the +client bounding region, +the client clip region and the +client input region. They are specified +relative to the origin of +the window and are always defined by offsets relative to the window origin +(that is, region adjustments are not required when the window is moved). +Three mechanisms for specifying regions are provided: a list of rectangles, +a bitmap, and an existing bounding or clip region from a window. This is +modeled on the specification of regions in graphics contexts in the core +protocol and allows a variety of different uses of the extension. + + + +When using an existing window shape as an operand in specifying a new shape, +the client region is used, unless none has been set, in which case the +default region is used instead. + + + +The effective bounding region of a window +is defined to be the intersection of +the client bounding region with the default bounding region. Any portion of +the client bounding region that is not included in the default bounding +region will not be included in the effective bounding region on the screen. +This means that window managers (or other geometry managers) used to dealing +with rectangular client windows will be able to constrain the client to a +rectangular area of the screen. + + + +Construction of the effective bounding region is dynamic; the client bounding +region is not mutated to obtain the effective bounding region. If a client +bounding region is specified that extends beyond the current default bounding +region, and the window is later enlarged, the effective bounding region will +be enlarged to include more of the client bounding region. + + + +The effective clip region of a window is defined to be the intersection of the +client clip region with both the default clip region and the client bounding +region. Any portion of the client clip region that is not included in both +the default clip region and the client bounding region will not be included in +the effective clip region on the screen. + + + +Construction of the effective clip region is dynamic; the client clip region is +not mutated to obtain the effective clip region. If a client clip region is +specified that extends beyond the current default clip region and the +window or its bounding region is later enlarged, the effective clip region will +be enlarged to include more of the client clip region if it is included in +the effective bounding region. + + + +The border of a window is defined to be the difference between the effective +bounding region and the effective clip region. If this region is empty, no +border is displayed. If this region is nonempty, the border is filled +using the border-tile or border-pixel of the window as specified in the core +protocol. Note that a window with a nonzero border width will never be able +to draw beyond the default clip region of the window. Also note that a zero +border width does not prevent a window from having a border, since the clip +shape can still be made smaller than the bounding shape. + + + +All output to the window and visible regions of any subwindows will be +clipped to the effective clip region. The server must not retain window +contents beyond the effective bounding region with backing store. The window's +origin (for graphics operations, background tiling, and subwindow placement) +is not affected by the existence of a bounding region or clip region. + + + +The effective input region of a window is +defined to be the intersection of the +client input region with both the default input region and the client bounding +region. Any portion of the client input region that is not included in both +the default input region and the client bounding region will not be included in +the effective input region on the screen. + + + +Construction of the effective input region is dynamic; the client input region is +not mutated to obtain the effective input region. If a client input region is +specified that extends beyond the current default input region and the +window or its bounding region is later enlarged, the effective input region will +be enlarged to include more of the client input region if it is included in +the effective bounding region. + + + +Areas that are inside the default bounding region but outside the effective +bounding region are not part of the window; these areas of the screen will +be occupied by other windows. Input events that occur within the default +bounding region but outside the effective bounding region will be delivered as +if the window was not occluding the event position. Events that occur in +a nonrectangular border of a window will be delivered to that window, just +as for events that occur in a normal rectangular border. + + + +An +InputOnly +window can have its bounding or input region set, but it is a +Match +error to attempt to set a clip region on an +InputOnly +window or to specify its clip region as a source to a request +in this extension. + + + +The server must accept changes to the clip and input regions of a root window, but +the server is permitted to ignore requested changes to the bounding region +of a root window. If the server accepts bounding region changes, the contents +of the screen outside the bounding region are implementation dependent. + + + + +Types + + +The following types are used in the request and event definitions in +subsequent sections. + + + +SHAPE_KIND: +{ Bounding, +Clip, +Input } + + + +SHAPE_OP: +{ Set, +Union, +Intersect, +Subtract, +Invert } + + + +Set +indicates that the region specified as an explicit source in the request is +stored unaltered as the new destination client region. +Union +indicates that the source and destination regions are unioned together to +produce the new destination client region. +Intersect +indicates that the source and destination regions are intersected together to +produce the new destination client region. +Subtract +indicates that the source region is subtracted from the destination region to +produce the new destination region. +Invert +indicates that the destination region is subtracted from the source region to +produce the new destination region. + + + + +Requests + +ShapeQueryVersion + + + + => + + + +majorVersion: CARD16 + + +minorVersion: CARD16 + + + +This request can be used to ensure that the server version of the SHAPE +extension is usable by the client. This document defines major version one +(1), minor version one (1). + + + +ShapeRectangles + + + + + + + + + dest: WINDOW + + + destKind: SHAPE_KIND + + + op: SHAPE_OP + + + xOff, yOff: INT16 + + + rectangles: LISTofRECTANGLES + + + ordering: +{ UnSorted, +YSorted, +YXSorted, +YXBanded } + + + + +Errors: +Window, +Length, +Match, +Value + + + + + + + +This request specifies an array of rectangles, relative to the origin of the +window plus the specified offset (xOff and yOff) that together +define a region. This region is combined (as specified by the operator +op) with the existing client region (specified by destKind) of the +destination window, and the result is stored as the specified client region of +the destination window. Note that the list of rectangles can be empty, +specifying an empty region; this is not the same as passing +None to +ShapeMask, + + + +If known by the client, +ordering relations on the rectangles can be specified with the ordering +argument. +This may provide faster operation by the server. +The meanings of the ordering values are the same as in the core protocol +SetClipRectangles +request. +If an incorrect ordering is specified, +the server may generate a +Match +error, but it is not required to do so. +If no error is generated, +the graphics results are undefined. +Except for +UnSorted , +the rectangles should be nonintersecting, or the resulting region will +be undefined. +UnSorted +means that the rectangles are in arbitrary order. +YSorted +means that the rectangles are nondecreasing in their Y origin. +YXSorted +additionally constrains +YSorted +order in that all rectangles with an equal Y origin are +nondecreasing in their X origin. +YXBanded +additionally constrains +YXSorted +by requiring that, for every possible Y scanline, +all rectangles that include that scanline have identical Y origins and Y +extents. + + + +ShapeMask + + + + + + + + + +dest: WINDOW +destKind: SHAPE_KIND +op: SHAPE_OP +xOff, yOff: INT16 +source: PIXMAP or +None + + + + +Errors: +Window, +Pixmap, +Match, +Value + + + + + + + +The source in this request is a 1-bit deep pixmap, or +None . +If source is +None , +the specified client region is removed from the window, causing the effective +region to revert to the default region. The +ShapeNotify +event generated by this request and subsequent +ShapeQueryExtents +will report that a client shape has not been specified. +If a valid pixmap is specified, it is converted +to a region, with bits set to one included in the region and bits set to +zero excluded, and an offset from the window origin as specified by +xOff and yOff. The resulting region is then combined (as +specified by the operator op) with the existing client region +(indicated by destKind) of the destination window, and the result is +stored as the specified client region of the destination window. The source +pixmap and destination window must have been created on the same screen, +or else a +Match +error results. + + + +ShapeCombine + + + + + + + + + +dest: WINDOW + + + + +destKind: SHAPE_KIND + + + + +op: SHAPE_OP + + + + +xOff, yOff: INT16 + + + + +source: WINDOW + + + + +sourceKind: SHAPE_KIND + + + + +Errors: +Window, +Match, +Value + + + + + + + +The client region, indicated by sourceKind, of the source window is +offset from the window origin by xOff and yOff and combined with +the client region, indicated by destKind, of the destination window. +The result is stored as the specified client region of the destination +window. +The source and destination windows must be on the same screen, or else a +Match +error results. + + + +ShapeOffset + + + + + + + + + +dest: WINDOW + + + + +destKind: SHAPE_KIND + + + + +xOff, yOff: INT16 + + + + +Errors: +Window, +Match, +Value + + + + + + + +The client region, indicated by destKind, is moved relative to its +current position by the amounts xOff and yOff. + + + +ShapeQueryExtents + + + + + + + + + +dest: WINDOW + + + + + + + + => + + + + + + + + + +boundingShaped: BOOL + + + + +clipShaped: BOOL + + + + +xBoundingShape: INT16 + + + + +yBoundingShape: INT16 + + + + +widthBoundingShape: CARD16 + + + + +heightBoundingShape: CARD16 + + + + +xClipShape: INT16 + + + + +yClipShape: INT16 + + + + +widthClipShape: CARD16 + + + + +heightClipShape: CARD16 + + + + +Errors: +Window + + + + + + + +The boundingShaped and clipShaped results are +True +if the corresponding client regions have been specified, else they are +False . +The x, y, width, and height values define the extents of the client regions, +when a client region has not been specified, the extents of the +corresponding default region are reported. + + + +ShapeSelectInput + + + + + + + + + +window: WINDOW + + + + +enable: BOOL + + + + +Errors: +Window, +Value + + + + + + + +Specifying enable as +True +causes the server to send the requesting client a +ShapeNotify +event whenever the bounding, clip or input region of the specified window is +altered by any client. +Specifying enable as +False +causes the server to stop sending such events. + + + +ShapeInputSelected + + + + + + + + + +window: WINDOW + + + + +=> +enable: BOOL + + + + +Errors: +Window + + + + + + + +If enable is +True, then +ShapeNotify +events for the window are generated for this client. + + + +ShapeGetRectangles + + + + + + + + + +window: WINDOW + + + + +kind: SHAPE_KIND + + + + + => +rectangles: LISTofRECTANGLE + + + + +ordering: +{ UnSorted, +YSorted, +YXSorted, +YXBanded } + + + + +Errors: +Window, +Match + + + + + + + +A list of rectangles describing the region indicated by kind, and the +ordering of those rectangles, is returned. The meaning of the ordering +values is the same as in the +ShapeRectangles +request. + + + + +Events + +ShapeNotify + + + + + + + + + +window: WINDOW + + + + +kind: SHAPE_KIND + + + + +shaped: BOOL + + + + +x, y: INT16 + + + + +width, +height: CARD16 + + + + +time: TIMESTAMP + + + + + + + +Whenever the client bounding, clip or input shape of a window is modified, a +ShapeNotify +event is sent to each client that has used +ShapeSelectInput +to request it. + + + +Kind indicates which client region (bounding or clip) has been modified; +shaped is +True +when the window has a client shape of type kind, and is +False +when the window no longer has a client shape of this type. +The x, y, width, and height indicate the extents of the +current shape. When shaped is +False +these will indicate the extents of the default region. The timestamp +indicates the server time when the shape was changed. + + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this document uses +conventions established there. + + + +The name of this extension is "SHAPE". + + + +New Types + + +SHAPE_KIND + 0 Bounding + 1 Clip + 2 Input + + + +SHAPE_OP + 0 Set + 1 Union + 2 Intersect + 3 Subtract + 4 Invert + + + + +Requests + +ShapeQueryVersion + 1 CARD8 opcode + 1 0 shape opcode + 2 1 request length + +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 2 CARD16 major version + 2 CARD16 minor version + 20 unused + + + +ShapeRectangles + 1 CARD8 opcode + 1 1 shape opcode + 2 4+2n request length + 1 SHAPE_OP operation + 1 SHAPE_KIND destination kind + 1 ordering + 0 UnSorted + 1 YSorted + 2 YXSorted + 3 YXBanded + 1 unused + 4 WINDOW destination window + 2 INT16 x offset + 2 INT16 y offset + 8n LISTofRECTANGLE rectangles + + + + +ShapeMask + 1 CARD8 opcode + 1 2 shape opcode + 2 5 request length + 1 SHAPE_OP operation + 1 SHAPE_KIND destination kind + 2 unused + 4 WINDOW destination window + 2 INT16 x offset + 2 INT16 y offset + 4 PIXMAP source bitmap + 0 None + + + + +ShapeCombine + 1 CARD8 opcode + 1 3 shape opcode + 2 5 request length + 1 SHAPE_OP operation + 1 SHAPE_KIND destination kind + 1 SHAPE_KIND source kind + 1 unused + 4 WINDOW destination window + 2 INT16 x offset + 2 INT16 y offset + 4 WINDOW source window + + + +ShapeOffset + 1 CARD8 opcode + 1 4 shape opcode + 2 4 request length + 1 SHAPE_KIND destination kind + 3 unused + 4 WINDOW destination window + 2 INT16 x offset + 2 INT16 y offset + + + +ShapeQueryExtents + 1 CARD8 opcode + 1 5 shape opcode + 2 2 request length + 4 WINDOW destination window + + => + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 1 BOOL bounding shaped + 1 BOOL clip shaped + 2 unused + 2 INT16 bounding shape extents x + 2 INT16 bounding shape extents y + 2 CARD16 bounding shape extents width + 2 CARD16 bounding shape extents height + 2 INT16 clip shape extents x + 2 INT16 clip shape extents y + 2 CARD16 clip shape extents width + 2 CARD16 clip shape extents height + 4 unused + + + +ShapeSelectInput + 1 CARD8 opcode + 1 6 shape opcode + 2 3 request length + 4 WINDOW destination window + 1 BOOL enable + 3 unused + + + +ShapeInputSelected + 1 CARD8 opcode + 1 7 shape opcode + 2 2 request length + 4 WINDOW destination window + => + 1 1 Reply + 1 BOOL enabled + 2 CARD16 sequence number + 4 0 reply length + 24 unused + + + +ShapeGetRectangles + 1 CARD8 opcode + 1 8 shape opcode + 2 3 request length + 4 WINDOW window + 1 SHAPE_KIND source kind + 3 unused + => + 1 1 Reply + 1 ordering + 0 UnSorted + 1 YSorted + 2 YXSorted + 3 YXBanded + 2 CARD16 sequence number + 4 2n reply length + 4 CARD32 nrects + 20 unused + 8n LISTofRECTANGLE rectangles + + + + +Events + +ShapeNotify + 1 CARD8 type (0 + extension event base) + 1 SHAPE_KIND shape kind + 2 CARD16 sequence number + 4 WINDOW affected window + 2 INT16 x value of extents + 2 INT16 y value of extents + 2 CARD16 width of extents + 2 CARD16 height of extents + 4 TIMESTAMP server time + 1 BOOL shaped + 11 unused + + + + + +Glossary + + bounding region + + +The area of the parent window that this window will occupy. This area is +divided into two parts: the border and the interior. + + + + + + clip region + + +The interior of the window, as a subset of the bounding region. This +region describes the area that will be painted with the window background +when the window is cleared, will contain all graphics output to the window, +and will clip any subwindows. + + + + + + input region + + +The subset of the bounding region which can ``contain'' the +pointer. + + + + + + default bounding region + + +The rectangular area, as described by the core protocol window size, that +covers the interior of the window and its border. + + + + + + default clip region + + +The rectangular area, as described by the core protocol window size, that +covers the interior of the window and excludes the border. + + + + + + default input region + + +The rectangular area, as described by the core protocol window size, that +covers the interior of the window and its border. + + + + + + client bounding region + + +The region associated with a window that is directly modified via this +extension when specified by + ShapeBounding . +This region is used in conjunction with the default bounding region +to produce the effective bounding region. + + + + + + client clip region + + +The region associated with a window that is directly modified via this +extension when specified by + ShapeClip . +This region is used in conjunction with the default clip region +and the client bounding region to produce the effective clip region. + + + + + + client input region + + +The region associated with a window that is directly modified via this +extension when specified by + ShapeInput . +This region is used in conjunction with the default input region +and the client bounding region to produce the effective input region. + + + + + + effective bounding region + + +The actual shape of the window on the screen, including border and interior +(but excluding the effects of overlapping windows). When a window has a client +bounding region, the effective bounding region is the intersection of the +default bounding region and the client bounding region. Otherwise, the +effective bounding region is the same as the default bounding region. + + + + + + effective clip region + + +The actual shape of the interior of the window on the screen (excluding the +effects of overlapping windows). When a window has a client clip region or +a client bounding region, the effective clip region is the intersection of +the default clip region, the client clip region (if any) and the client +bounding region (if any). Otherwise, the effective clip region is the +same as the default clip region. + + + + + + effective input region + + +The actual shape of the window on the screen (excluding the +effects of overlapping windows) which can ``contain'' the pointer. +When a window has a client input region or +a client bounding region, the effective input region is the intersection of +the default input region, the client input region (if any) and the client +bounding region (if any). Otherwise, the effective input region is the +same as the default input region. + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/shm.xml b/miniconda3/envs/ladir/share/doc/xextproto/shm.xml new file mode 100644 index 0000000000000000000000000000000000000000..8e04e7d50fe7efb965daf247ea1c7d4843e0a1ca --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/shm.xml @@ -0,0 +1,476 @@ + + %defs; +]> + + + + + + + MIT-SHM(The MIT Shared Memory Extension) + How the shared memory extension works + + + JonathanCorbet + + National Center for Atmospheric Research + Atmospheric Technology Division + + corbet@ncar.ucar.edu + + + KeithPackard + MIT X Consortium + + + X Version 11, Release &fullrelvers; + Version 1.0 + 1991X Consortium + + + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the name of the X Consortium shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the X Consortium. + +X Window System is a trademark of The OpenGroup. + + + + +This document briefly describes how to use the MIT-SHM shared memory +extension. I have tried to make it accurate, but it would not surprise me +if some errors remained. If you find anything wrong, do let me know and I +will incorporate the corrections. Meanwhile, please take this document "as +is" (eman improvement over what was there before, but certainly not the +definitive word.) + + + + + + +REQUIREMENTS + +The shared memory extension is provided only by some X servers. To find out +if your server supports the extension, use xdpyinfo(1). In particular, to +be able to use this extension, your system must provide the SYSV shared +memory primitives. There is not an mmap-based version of this extension. +To use shared memory on Sun systems, you must have built your kernel with +SYSV shared memory enabled -- which is not the default configuration. +Additionally, the shared memory maximum size will need to be increased on +both Sun and Digital systems; the defaults are far too small for any useful +work. + + + + +WHAT IS PROVIDED + + +The basic capability provided is that of shared memory XImages. This is +essentially a version of the ximage interface where the actual image data +is stored in a shared memory segment, and thus need not be moved through +the Xlib interprocess communication channel. For large images, use of this +facility can result in some real performance increases. + + + +Additionally, some implementations provided shared memory pixmaps. These +are 2 dimensional arrays of pixels in a format specified by the X server, +where the image data is stored in the shared memory segment. Through use of +shared memory pixmaps, it is possible to change the contents of these +pixmaps without using any Xlib routines at all. Shared memory pixmaps can +only be supported when the X server can use regular virtual memory for +pixmap data; if the pixmaps are stored in some magic graphics hardware, your +application will not be able to share them with the server. Xdpyinfo(1) +doesn't print this particular nugget of information. + + + + +HOW TO USE THE SHARED MEMORY EXTENSION + +Code which uses the shared memory extension must include a number of header +files: + + + +#include <X11/Xlib.h> /* of course */ +#include <sys/ipc.h> +#include <sys/shm.h> +#include <X11/extensions/XShm.h> + + + +Of course, if the system you are building on does not support shared +memory, the file XShm.h may not be present. You may want to make +liberal use of #ifdefs. + + + +Any code which uses the shared memory extension should first check to see +that the server provides the extension. You could always be running over +the net, or in some other environment where the extension will not work. +To perform this check, call either + + + + + Status XShmQueryExtension + Display *display + + + + +or + + + + + Status XShmQueryVersion + Display *display + int *major + int *minor + Bool *pixmaps + + + + +Where "display" is, of course, the display on which you are running. If +the shared memory extension may be used, the return value from either +function will be True; otherwise your program should operate using +conventional Xlib calls. When the extension is available, +\fCXShmQueryVersion\fP also returns "major" and "minor" which are the +version numbers of the extension implementation, and "pixmaps" which is +True iff shared memory pixmaps are supported. + + + + +USE OF SHARED MEMORY XIMAGES + +The basic sequence of operations for shared memory XImages is as follows: + + + + + +Create the shared memory XImage structure + + + + +Create a shared memory segment to store the image data + + + + +Inform the server about the shared memory segment + + + + +Use the shared memory XImage, much like a normal one. + + + + + +To create a shared memory XImage, use: + + + + + XImage *XShmCreateImage + Display *display + Visual *visual + unsigned int depth + int format + char *data + XShmSegmentInfo *shminfo + unsigned int width + unsigned int height + + + + +Most of the arguments are the same as for XCreateImage; I will not go +through them here. Note, however, that there are no "offset", "bitmap_pad", +or "bytes_per_line" arguments. These quantities will be defined by the +server itself, and your code needs to abide by them. Unless you have already +allocated the shared memory segment (see below), you should pass in NULL for +the "data" pointer. + + + +There is one additional argument: "shminfo", which is a pointer to a +structure of type XShmSegmentInfo. You must allocate one of these +structures such that it will have a lifetime at least as long as that of +the shared memory XImage. There is no need to initialize this structure +before the call to XShmCreateImage. + + + +The return value, if all goes well, will be an XImage structure, which you +can use for the subsequent steps. + + + +The next step is to create the shared memory segment. This is +best done after the creation of the XImage, since you need to make use of +the information in that XImage to know how much memory to allocate. To +create the segment, you need a call like: + + + + +shminfo.shmid = shmget (IPC_PRIVATE, + image->bytes_per_line * image->height, IPC_CREAT|0777); + + + +(assuming that you have called your shared memory XImage "image"). You +should, of course, follow the Rules and do error checking on all of these +system calls. Also, be sure to use the bytes_per_line field, not the width +you used to create the XImage as they may well be different. + + + +Note that the shared memory ID returned by the system is stored in the +shminfo structure. The server will need that ID to attach itself to the +segment. + + + +Also note that, on many systems for security reasons, the X server +will only accept to attach to the shared memory segment if it's +readable and writeable by "other". On systems where the X server is +able to determine the uid of the X client over a local transport, the +shared memory segment can be readable and writeable only by the uid of +the client. + + + +Next, attach this shared memory segment to your process: + + + +shminfo.shmaddr = image->data = shmat (shminfo.shmid, 0, 0); + + + +The address returned by shmat should be stored in *both* the XImage +structure and the shminfo structure. + + + +To finish filling in the shminfo structure, you need to decide how you want +the server to attach to the shared memory segment, and set the "readOnly" +field as follows. Normally, you would code: + + +shminfo.readOnly = False; + + + +If you set it to True, the server will not be able to write to this +segment, and thus XShmGetImage calls will fail. + + + +Finally, tell the server to attach to your shared memory segment with: + + + +Status XShmAttach (display, shminfo); + + + +If all goes well, you will get a non-zero status back, and your XImage is +ready for use. + + + +To write a shared memory XImage into an X drawable, use XShmPutImage: + + + + + Status XShmPutImage + Display *display + Drawable d + GC gc + XImage *image + int src_x + int src_y + int dest_x + int dest_y + unsigned int width + unsigned int height + bool send_event + + + + +The interface is identical to that of XPutImage, so I will spare my fingers +and not repeat that documentation here. There is one additional parameter, +however, called "send_event". If this parameter is passed as True, the +server will generate a "completion" event when the image write is complete; +thus your program can know when it is safe to begin manipulating the shared +memory segment again. + + + +The completion event has type XShmCompletionEvent, which is defined as the +following: + + + +typedef struct { + int type; /* of event */ + unsigned long serial; /* # of last request processed */ + Bool send_event; /* true if came from a SendEvent request */ + Display *display; /* Display the event was read from */ + Drawable drawable; /* drawable of request */ + int major_code; /* ShmReqCode */ + int minor_code; /* X_ShmPutImage */ + ShmSeg shmseg; /* the ShmSeg used in the request */ + unsigned long offset; /* the offset into ShmSeg used */ +} XShmCompletionEvent; + + + +The event type value that will be used can be determined at run time with a +line of the form: + + + +int CompletionType = XShmGetEventBase (display) + ShmCompletion; + + + +If you modify the shared memory segment before the arrival of the +completion event, the results you see on the screen may be inconsistent. + + + +To read image data into a shared memory XImage, use the following: + + + + + Status XShmGetImage + Display *display + Drawable d + XImage *image + int x + int y + unsigned long plane_mask + + + + +Where "display" is the display of interest, "d" is the source drawable, +"image" is the destination XImage, "x" and "y" are the offsets within +"d", and "plane_mask" defines which planes are to be read. + + + +To destroy a shared memory XImage, you should first instruct the server to +detach from it, then destroy the segment itself, as follows: + + + +XShmDetach (display, shminfo); +XDestroyImage (image); +shmdt (shminfo.shmaddr); +shmctl (shminfo.shmid, IPC_RMID, 0); + + + + + +USE OF SHARED MEMORY PIXMAPS + +Unlike X images, for which any image format is usable, the shared memory +extension supports only a single format (i.e. XYPixmap or ZPixmap) for the +data stored in a shared memory pixmap. This format is independent of the +depth of the image (for 1-bit pixmaps it doesn't really matter what this +format is) and independent of the screen. Use XShmPixmapFormat to get the +format for the server: + + + + + int XShmPixmapFormat + Display *display + + + + +If your application can deal with the server pixmap data format (including +bits-per-pixel et al.), create a shared memory segment and "shminfo" +structure in exactly the same way as is listed above for shared memory +XImages. While it is, not strictly necessary to create an XImage first, +doing so incurs little overhead and will give you an appropriate +bytes_per_line value to use. + + + +Once you have your shminfo structure filled in, simply call: + + + + + Pixmap XShmCreatePixmap + Display *display + Drawable d + char *data + XShmSegmentInfo *shminfo + unsigned int width + unsigned int height + unsigned int depth + + + + +The arguments are all the same as for XCreatePixmap, with two additions: +"data" and "shminfo". The second of the two is the same old shminfo +structure that has been used before. The first is the pointer to the shared +memory segment, and should be the same as the shminfo.shmaddr field. I am +not sure why this is a separate parameter. + + + +If everything works, you will get back a pixmap, which you can manipulate in +all of the usual ways, with the added bonus of being able to tweak its +contents directly through the shared memory segment. Shared memory pixmaps +are destroyed in the usual manner with XFreePixmap, though you should detach +and destroy the shared memory segment itself as shown above. + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/sync.xml b/miniconda3/envs/ladir/share/doc/xextproto/sync.xml new file mode 100644 index 0000000000000000000000000000000000000000..afb07838c55ab1d0c76df0aa6b024f6235382941 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/sync.xml @@ -0,0 +1,1274 @@ + + %defs; +]> + + + + + + + + X Synchronization Extension Protocol + X Consortium Standard + + + TimGlauert + + Olivetti Research + MultiWorks + + + + Dave + Carver + + Digital Equipment Corporation + MIT/Project Athena + + + + Jim + Gettys + + Digital Equipment Corporation + Cambridge Research Laboratory + + + + David + P. + Wiggins + X Consortium, Inc. + + + James + Jones + NVIDIA Corporation + + + X Version 11, Release &fullrelvers; + Version 3.1 + 1991 + Olivetti Research Limited, Cambridge England + Digital Equipment Corporation, Maynard, Massachusetts + X Consortium + + 2010NVIDIA Corporation + + + +Permission to use, copy, modify, and distribute this documentation for any +purpose and without fee is hereby granted, provided that the above +copyright notice appear in all copies. Olivetti, Digital, MIT, the +X Consortium, and NVIDIA make no representations about the suitability for +any purpose of the information in this document. This documentation is +provided as is without express or implied warranty. + + + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files +(the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, copy, +modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY +KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO +EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +Except as contained in this notice, the name of the X Consortium shall +not be used in advertising or otherwise to promote the sale, use or other +dealings in this Software without prior written authorization from the X +Consortium. + + + + + +Synchronization Protocol + +The core X protocol makes no guarantees about the relative order of execution +of requests for different clients. This means that any synchronization between +clients must be done at the client level in an operating system-dependent and +network-dependent manner. Even if there was an accepted standard for such +synchronization, the use of a network introduces unpredictable delays between +the synchronization of the clients and the delivery of the resulting requests +to the X server. + + + +The core X protocol also makes no guarantees about the time at which requests +are executed, which means that all clients with real-time constraints must +implement their timing on the host computer. Any such timings are subject to +error introduced by delays within the operating system and network and are +inefficient because of the need for round-trip requests that keep the client +and server synchronized. + + + +The synchronization extension provides primitives that allow synchronization +between clients to take place entirely within the X server. This removes any +error introduced by the network and makes it possible to synchronize clients +on different hosts running different operating systems. This is important for +multimedia applications, where audio, video, and graphics data streams are +being synchronized. The extension also provides internal timers within the +X server to which client requests can be synchronized. This allows simple +animation applications to be implemented without any round-trip requests and +makes best use of buffering within the client, network, and server. + + + +Description + +The mechanism used by this extension for synchronization within the X +server is to block the processing of requests from a client until a +specific synchronization condition occurs. When the condition occurs, the +client is released and processing of requests continues. Multiple clients +may block on the same condition to give inter-client synchronization. +Alternatively, a single client may block on a condition such as an animation +frame marker. + + + +The extension adds Counter, Alarm, +and Fence to the set of resources managed by the +server. A counter has a 64-bit integer value that may be increased or +decreased by client requests or by the server internally. A client can block +by sending an Await request that waits until one of a set of synchronization +conditions, called TRIGGERs, becomes TRUE. Alarms generate events when +counter values go through a specified transition. A fence has two possible +states: triggered and not triggered. Client requests can put the fence in +either of these states. A client can block until one of a set of fences +becomes triggered by sending an AwaitFence request. Fences are bound to a +particular screen at creation time. + + + +The CreateCounter request allows a client to create a +Counter that can be changed by explicit +SetCounter and ChangeCounter +requests. These can be used to implement synchronization between different +clients. + + + +There are some counters, called System Counters, that +are changed by the server internally rather than by client requests. The +effect of any change to a system counter is not visible until the server +has finished processing the current request. In other words, system +counters are apparently updated in the gaps between the execution of +requests rather than during the actual execution of a request. The extension +provides a system counter that advances with the server time as defined by +the core protocol, and it may also provide counters that advance with the +real-world time or that change each time the CRT screen is refreshed. +Other extensions may provide their own extension-specific system counters. + + + +The extension provides an Alarm mechanism that allows +clients to receive an event on a regular basis when a particular counter +is changed. + + + +The CreateFence request allows a client to create a +Fence that can be triggered and reset using +TriggerFence and ResetFence +requests, respectively. CreateFence takes a drawable +argument that implies which screen the fence should be created on. The +TriggerFence request changes the fence's state only +after all previous rendering commands affecting objects owned by the given +fence's screen have completed. Note that while fence objects are bound +to a screen and the simple trigger operation provided by this extension +operates at screen granularity, other extensions may add more fine-grained +trigger operations based on any number of events. The screen binding +merely establishes an upper bound for the scope of fence operations. + + + + +Types + +Please refer to the X11 Protocol specification as this document uses +syntactic conventions established there and references types defined there. + + +The following new types are used by the extension. + + +INT64: 64-bit signed integer +COUNTER: XID +VALUETYPE: {Absolute,Relative}; +TESTTYPE: {PositiveTransition,NegativeTransition, + PositiveComparison,NegativeComparison} +TRIGGER: [ + counter:COUNTER, + value-type:VALUETYPE, + wait-value:INT64, + test-type:TESTTYPE + ] +WAITCONDITION: [ + trigger:TRIGGER, + event-threshold:INT64 + ] +SYSTEMCOUNTER: [ + name:STRING8, + counter:COUNTER, + resolution:INT64 + ] +ALARM: XID +ALARMSTATE: {Active,Inactive,Destroyed} +FENCE: XID + + + +The COUNTER type defines the client-side handle on a server +Counter. The value of a counter is an INT64. + + + +The TRIGGER type defines a test on a counter that is either TRUE or FALSE. The +value of the test is determined by the combination of a test value, the value +of the counter, and the specified test-type. + + + +The test value for a trigger is calculated using the value-type and +wait-value fields when the trigger is initialized. If the value-type field +is not one of the named VALUETYPE constants, the request that initialized the +trigger will return a Value error. If the value-type +field is Absolute, the test value is given by the +wait-value field. If the value-type field is Relative, +the test value is obtained by adding the wait-value field to the value of the +counter. If the resulting test value would lie outside the range for an +INT64, the request that initialized the trigger will return a +Value error. If counter is None +and the value-type is Relative, the request that +initialized the trigger will return a Match error. If +counter is not None and does not name a valid counter, a Counter error is +generated. + + + +If the test-type is PositiveTransition, the trigger is +initialized to FALSE, and it will become TRUE when the counter changes from +a value less than the test value to a value greater than or equal to the +test value. If the test-type is NegativeTransition, +the trigger is initialize to FALSE, and it will become TRUE when the counter +changes from a value greater than the test value to a value less than or +equal to the test value. If the test-type is +PositiveComparison, the trigger is TRUE if the +counter is greater than or equal to the test value and FALSE otherwise. If the +test-type is NegativeComparison, the trigger is TRUE +if the counter is less than or equal to the test value and FALSE otherwise. +If the test-type is not one of the named TESTTYPE constants, the request that +initialized the trigger will return a Value error. A trigger with a counter +value of None and a valid test-type is always TRUE. + + + +The WAITCONDITION type is simply a trigger with an associated event-threshold. +The event threshold is used by the Await request to +decide whether or not to generate an event to the client after the trigger has +become TRUE. By setting the event-threshold to an appropriate value, it is +possible to detect the situation where an Await request +was processed after the TRIGGER became TRUE, which usually indicates that +the server is not processing requests as fast as the client expects. + + + +The SYSTEMCOUNTER type provides the client with information about a +SystemCounter. The name field is the textual name of +the counter that identifies the counter to the client. The counter field +is the client-side handle that should be used in requests that require a +counter. The resolution field gives the approximate step size of the system +counter. This is a hint to the client +that the extension may not be able to resolve two wait conditions with test +values that differ by less than this step size. A microsecond clock, for +example, may advance in steps of 64 microseconds, so a counter based on this +clock would have a resolution of 64. + + + +The only system counter that is guaranteed to be present is called SERVERTIME, +which counts milliseconds from some arbitrary starting point. The least +significant 32 bits of this counter track the value of Time used by the +server in Events and Requests. Other system counters may be provided by +different implementations of the extension. The X Consortium will maintain a +registry of system counter names to avoid collisions in the name space. + + + +An ALARM is the client-side handle on an Alarm resource. + + + +The FENCE type defines the client-side handle on a server +Fence. A fence can only be in one of two states, +represented by a BOOL. If the value is TRUE, the fence is in the triggered +state. Otherwise, the fence is in the not triggered state. + + + + + +Errors + + + + Counter + + +This error is generated if the value for a COUNTER argument in a request +does not name a defined COUNTER. + + + + + Alarm + + +This error is generated if the value for an ALARM argument in a request +does not name a defined ALARM. + + + + + Fence + + +This error is generated if the value for a FENCE argument in a request +does not name a defined FENCE. + + + + + + + +Requests + + + + Initialize + + +version-major,version-minor: CARD8 +=> +version-major,version-minor: CARD8 + + + +This request must be executed before any other requests for this extension. If a +client violates this rule, the results of all SYNC requests that it issues are +undefined. The request takes the version number of the extension that the +client wishes to use and returns the actual version number being implemented +by the extension for this client. The extension may return different +version numbers to a client depending of the version number supplied by +that client. This request should be executed only once for each client +connection. + + +Given two different versions of the SYNC protocol, v1 and v2, v1 is +compatible with v2 if and only if v1.version_major = v2.version_major +and v1.version_minor <= v2.version_minor. Compatible means that the +functionality is fully supported in an identical fashion in the two versions. + + +This document describes major version 3, minor version 1 of the SYNC protocol. + + + + + ListSystemCounters + + +=> +system-counters: LISTofSYSTEMCOUNTER +Errors: Alloc + + +This request returns a list of all the system counters that are available at +the time the request is executed, which includes the system counters +that are maintained by other extensions. The list returned by this +request may change as counters are created and destroyed by other extensions. + + + + + CreateCounter + + +id: COUNTER +initial-value: INT64 +Errors: IDChoice,Alloc + + +This request creates a counter and assigns the specified id to it. The counter +value is initialized to the specified initial-value and there are no clients +waiting on the counter. + + + + + DestroyCounter + + +counter: COUNTER +Errors: Counter,Access + + +This request destroys the given counter and sets the counter fields for all +triggers that specify this counter to None. All clients +waiting on the counter are released and a CounterNotify +event with the destroyed field set to TRUE is sent to each waiting client, +regardless of the event-threshold. All alarms specifying the counter become +Inactive and an AlarmNotify +event with a state field of Inactive is generated. A +counter is destroyed automatically when the connection to the creating client +is closed down if the close-down mode is Destroy. An +Access error is generated if counter is a system +counter. A Counter error is generated if counter does +not name a valid counter. + + + + + QueryCounter + + +counter: COUNTER +=> +value: INT64 +Errors: Counter + + +This request returns the current value of the given counter or a generates +Counter error if counter does not name a valid counter. + + + + + Await + + +wait-list: LISTofWAITCONDITION +Errors: Counter,Alloc,Value + + +When this request is executed, the triggers in the wait-list are initialized +using the wait-value and value-type fields, as described in the definition of +TRIGGER above. The processing of further requests for the client is blocked +until one or more of the triggers becomes TRUE. This may happen immediately, +as a result of the initialization, or at some later time, as a result of +a subsequent SetCounter, +ChangeCounter or +DestroyCounter request. + + +A Value error is generated if wait-list is empty. + + +When the client becomes unblocked, each trigger is checked to determine +whether a CounterNotify event should be generated. +The difference between the counter and the test value is calculated by +subtracting the test value from the value of the counter. If the test-type +is PositiveTransition or +PositiveComparison, a +CounterNotify event is generated if the difference is +at least event-threshold. If the test-type is +NegativeTransition or +NegativeComparison, a +CounterNotify event is generated if the difference +is at most event-threshold. If the difference lies outside the range for an +INT64, an event is not generated. + + +This threshold check is made for each trigger in the list and a +CounterNotify event is generated for every trigger for +which the check succeeds. The check for +CounterNotify events is performed even if one of the +triggers is TRUE when the request is first executed. Note that a +CounterNotify event may be generated for a trigger +that is FALSE if there are multiple triggers in the request. A +CounterNotify event with the destroyed flag set to +TRUE is always generated if the counter for one of the triggers is +destroyed. + + + + + ChangeCounter + + +counter: COUNTER +amount: INT64 +Errors: Counter,Access,Value + + +This request changes the given counter by adding amount to the current +counter value. If the change to this counter satisfies a trigger for which a client +is waiting, that client is unblocked and one or more +CounterNotify events may be generated. If the change to +the counter satisfies the trigger for an alarm, an +AlarmNotify event is generated and the +alarm is updated. An Access error is generated if +counter is a system counter. A Counter error is +generated if counter does not name a valid counter. If the resulting value +for the counter would be outside the range for an INT64, a +Value error is generated and the counter is not changed. + + +It should be noted that all the clients whose triggers are satisfied by this +change are unblocked, so this request cannot be used to implement mutual +exclusion. + + + + + SetCounter + + +counter: COUNTER +value: INT64 +Errors: Counter,Access + + +This request sets the value of the given counter to value. The effect is +equivalent to executing the appropriate ChangeCounter request to change +the counter value to value. An Access error is generated if counter names a +system counter. A Counter error is generated if counter does not name a valid +counter. + + + + + CreateAlarm + + +id: ALARM +values-mask: CARD32 +values-list: LISTofVALUE +left">Errors: IDChoice,Counter,Match,Value,Alloc + + +This request creates an alarm and assigns the identifier id to it. The +values-mask and values-list specify the attributes that are to be explicitly +initialized. The attributes for an Alarm and their defaults are: + + + + + + + + + + + Attribute + Type + Default + + + + + trigger + TRIGGER + counter + None + + + + + value-type + Absolute + + + + + value + 0 + + + + + test-type + PositiveComparison + + + delta + INT64 + 1 + + + events + BOOL + TRUE + + + + + +The trigger is initialized as described in the definition of TRIGGER, with an +error being generated if necessary. + + +If the counter is None, the state of the alarm is set +to Inactive, else it is set to Active. + + +Whenever the trigger becomes TRUE, either as a result of this request or as the +result of a SetCounter, +ChangeCounter, DestroyCounter, or +ChangeAlarm request, an +AlarmNotify event is generated and the alarm is +updated. The alarm is updated by repeatedly adding delta to the value of the +trigger and reinitializing it until it becomes FALSE. If this update would +cause value to fall outside the range for an INT64, or if the counter +value is None, or if the delta is 0 and test-type +is PositiveComparison or +NegativeComparison, no change is made to value and +the alarm state is changed to Inactive before the +event is generated. No further events are generated by an +Inactive alarm until a ChangeAlarm +or DestroyAlarm request is executed. + + +If the test-type is PositiveComparison or +PositiveTransition and delta is less than zero, or +if the test-type is NegativeComparison or +NegativeTransition and delta is greater than zero, +a Match error is generated. + + +The events value enables or disables delivery of +AlarmNotify events +to the requesting client. The alarm keeps a separate event flag for +each client so that other clients may select to receive events from this +alarm. + + +An AlarmNotify event is always generated at some time +after the execution of a CreateAlarm request. This +will happen immediately if the trigger is TRUE, or it will happen later +when the trigger becomes TRUE or the Alarm is destroyed. + + + + + ChangeAlarm + + +id: ALARM +values-mask: CARD32 +values-list: LISTofVALUE +Errors: Alarm,Counter,Value,Match + + +This request changes the parameters of an Alarm. All of the parameters +specified for the CreateAlarm request may be changed +using this request. The trigger is reinitialized and an +AlarmNotify event is generated if appropriate, as +explained in the description of the CreateAlarm request. + + +Changes to the events flag affect the event delivery to the requesting +client only and may be used by a client to select or deselect event delivery +from an alarm created by another client. + + +The order in which attributes are verified and altered is server-dependent. +If an error is generated, a subset of the attributes may have been altered. + + + + + DestroyAlarm + + +alarm: ALARM +Errors: Alarm + + +This request destroys an alarm. An alarm is automatically destroyed when the +creating client is closed down if the close-down mode is +Destroy. When an alarm is destroyed, an +AlarmNotify event is generated with a state value of +Destroyed. + + + + + QueryAlarm + + +alarm: ALARM +=> +trigger: TRIGGER +delta: INT64 +events: ALARMEVENTMASK +state: ALARMSTATE +Errors: Alarm + + This request retrieves the current parameters for an Alarm. + + + + SetPriority + + +client-resource: XID +priority: INT32 +Errors: Match + + +This request changes the scheduling priority of the client that created +client-resource. If client-resource is None, then +the priority for the client making the request is changed. A +Match error is generated if client-resource is not +None and does not name an existing resource in the +server. For any two priority values, A and B, A is higher priority if +and only if A is greater than B. + + +The priority of a client is set to 0 when the initial client connection is + made. + + +The effect of different client priorities depends on the particular +implementation of the extension, and in some cases it may have no effect at +all. However, the intention is that higher priority clients will have +their requests executed before those of lower priority clients. + + +For most animation applications, it is desirable that animation clients be +given priority over nonrealtime clients. This improves the smoothness of the +animation on a loaded server. Because a server is free to implement very strict +priorities, processing requests for the highest priority client to the +exclusion of all others, it is important that a client that may potentially +monopolize the whole server, such as an animation that produces continuous +output as fast as it can with no rate control, is run at low rather than high +priority. + + + + + GetPriority + + +client-resource: XID +=> +priority: INT32 +Errors: Match + + +This request returns the scheduling priority of the client that created +client-resource. If client-resource is None, then the +priority for the client making the request is returned. A +Match error is generated if client-resource is +not None and does not name an existing resource in the +server. + + + + + CreateFence + + +drawable: DRAWABLE +id: FENCE +initially-triggered: BOOL +Errors: IDChoice,Alloc + + +This request creates a fence on the screen associated with drawable and +assigns the specified id to it. The fence is in the triggered state iff +initially-triggered is TRUE. There are no clients waiting on the fence. + + + + + TriggerFence + + +fence: FENCE +Errors: Fence + + +This request puts the given fence in the triggered state after all rendering +from previous requests that affects resources owned by the fence's screen has +completed. This includes requests from other clients if those requests have +been dispatched. This request has no visible effects if the fence was already +in the triggered state. A Fence error is generated if +fence does not name a valid fence. + + +Note that the given fence's state is not necessarily directly modified by this +request. The state change need only be queued to occur after the required +rendering has completed. Clients should take care to not assume the fence will +be in the triggered state in subsequent requests, such as those that operate +on the given fence immediately. AwaitFence should first +be issued if subsequent requests require the fence to be in the triggered +state. + + + + + ResetFence + + +fence: FENCE +Errors: Fence,Match + + +This request immediately puts the given fence in the not triggered state. +A Match error is generated if the fence is not in the +triggered state. A Fence error is generated if fence +does not name a valid fence. + + +See the warnings above regarding TriggerFence's delayed +effect. In particular, a TriggerFence request +immediately followed by a ResetFence request is likely +to result in a Match error. An +AwaitFence request should be issued between the two. + + + + + DestroyFence + + +fence: FENCE +Errors: Fence + + +This request destroys the given fence. All clients waiting on this fence are +released. A fence is destroyed automatically when the connection to the client +that created the fence is closed if the close-down mode is +DestroyAll. A Fence error is +generated if fence does not name a valid fence. + + + + + QueryFence + + +fence: FENCE +=> +triggered: BOOL +Errors: Fence + + +This request returns TRUE if the given fence is triggered, or FALSE if it +is not triggered. A Fence error is generated if +fence does not name a valid fence. + + + + + AwaitFence + + +fence-list: LISTofFENCE +Errors: Fence,Alloc + + +When this request is executed, the processing of further requests for the +client is blocked until one or more of the fences in fence-list reaches the +triggered state. If any of the fences are already in the triggered state, +request processing resumes immediately. A Fence error +is generated if any member of fence-list does not name a valid fence. + + + + + + + +Events + + + + CounterNotify + + +counter: COUNTER +wait-value: INT64 +counter-value: INT64 +time: TIME +count: CARD16 +destroyed: BOOL + + +CounterNotify events may be generated when a client +becomes unblocked after an Await request has been +processed. The wait-value is the value being waited for, and counter-value +is the actual value of the counter at the time the event was generated. +The destroyed flag is TRUE if this request was generated as the result of +the destruction of the counter and FALSE otherwise. The time is the server +time at which the event was generated. + + +When a client is unblocked, all the CounterNotify +events for the Await request are generated contiguously. If count is 0, +there are no more events to follow for this request. If count is n, +there are at least n more events to follow. + + + + + AlarmNotify + + +alarm: ALARM +counter-value: INT64 +alarm-value: INT64 +state: ALARMSTATE +time: TIME + + +An AlarmNotify event is generated when an alarm is +triggered. alarm-value is the test value of the trigger in the alarm when +it was triggered, counter-value is the value of the counter that triggered +the alarm, and time is the server time at which the event was generated. +The state is the new state of the alarm. If state is +Inactive, no more events will be generated by this +alarm until a ChangeAlarm request is executed, the alarm +is destroyed, or the counter for the alarm is destroyed. + + + + + + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this section uses +syntactic conventions established there and references types defined there. + +The name of this extension is "SYNC". + + +Encoding New Types + +The following new types are used by the extension. + + + +ALARM: CARD32 +ALARMSTATE: + 0 Active + 1 Inactive + 2 Destroyed +COUNTER: CARD32 +INT64: 64-bit signed integer +SYSTEMCOUNTER: + 4 COUNTER counter + 8 INT64 resolution + 2 n length of name in bytes + n STRING8 name + p pad,p=pad(n+2) +TESTTYPE: + 0 PositiveTransition + 1 NegativeTransition + 2 PositiveComparison + 3 NegativeComparison +TRIGGER: + 4 COUNTER counter + 4 VALUETYPE wait-type + 8 INT64 wait-value + 4 TESTTYPE test-type VALUETYPE: + 0 Absolute + 1 Relative +WAITCONDITION: + 20 TRIGGER trigger + 8 INT64 event threshold +FENCE: CARD32 + + + +An INT64 is encoded in 8 bytes with the most significant 4 bytes +first followed by the least significant 4 bytes. Within these 4-byte +groups, the byte ordering determined during connection setup is used. + + + + +Encoding Errors + +Counter + 1 0 Error + 1 Base + 0 code + 2 CARD16 sequence number + 4 CARD32 bad counter + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused +Alarm + 1 0 Error + 1 Base + 1 code + 2 CARD16 sequence number + 4 CARD32 bad alarm + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused +Fence + 1 0 Error + 1 Base + 2 code + 2 CARD16 sequence number + 4 CARD32 bad fence + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + + + + + +Encoding Requests + + +Initialize + 1 CARD8 major opcode + 1 0 minor opcode + 2 2 request length + 1 CARD8 major version + 1 CARD8 minor version + 2 unused +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 1 CARD8 major version + 1 CARD8 minor version + 2 unused + 20 unused + +ListSystemCounters + 1 CARD8 major opcode + 1 1 minor opcode + 2 1 request length +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 INT32 list length + 20 unused + 4n list of SYSTEMCOUNTER system counters + +CreateCounter + 1 CARD8 major opcode + 1 2 minor opcode + 2 4 request length + 4 COUNTER id + 8 INT64 initial value + +DestroyCounter + 1 CARD8 major opcode + 1 6 minor opcodeA previous version of this document gave an incorrect minor opcode + 2 2 request length + 4 COUNTER counter +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 8 INT64 counter value + 16 unused + +Await + 1 CARD8 major opcode + 1 7 minor opcodeA previous version of this document gave an incorrect minor opcode. + 2 1 + 7*n request length + 28n LISTofWAITCONDITION wait conditions + +ChangeCounter + 1 CARD8 major opcode + 1 4 minor opcodeA previous version of this document gave an incorrect minor opcode. + 2 4 request length + 4 COUNTER counter + 8 INT64 amount + +SetCounter + 1 CARD8 major opcode + 1 3 minor opcodeA previous version of this document gave an incorrect minor opcode. + 2 4 request length + 4 COUNTER counter + 8 INT64 value + +CreateAlarm + 1 CARD8 major opcode + 1 8 minor opcode + 2 3+n request length + 4 ALARM id + 4 BITMASK values mask + + #x00000001 counter + #x00000002 value-type + #x00000004 value + #x00000008 test-type + #x00000010 delta + #x00000020 events + + 4n LISTofVALUE values + +VALUES + 4 COUNTER counter + 4 VALUETYPE value-type + 8 INT64 value + 4 TESTTYPE test-type + 8 INT64 delta + 4 BOOL events + +ChangeAlarm + 1 CARD8 major opcode + 1 9 minor opcode + 2 3+n request length + 4 ALARM id + 4 BITMASK values mask + encodings as for CreateAlarm + 4n LISTofVALUE values + encodings as for CreateAlarm + +DestroyAlarm + 1 CARD8 major opcode + 1 11 minor opcodeA previous version of this document gave an incorrect minor opcode. + 2 2 request length + 4 ALARM alarm + +QueryAlarm + 1 CARD8 major opcode + 1 10 minor opcodeA previous version of this document gave an incorrect minor opcode. + 2 2 request length + 4 ALARM alarm +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 2 reply length + 20 TRIGGER trigger + 8 INT64 delta + 1 BOOL events + 1 ALARMSTATE state + 2 unused + +SetPriority + 1 CARD8 major opcode + 1 12 minor opcode + 2 3 request length + 4 CARD32 id + 4 INT32 priority + +GetPriority + 1 CARD8 major opcode + 1 13 minor opcode + 2 1 request length + 4 CARD32 id +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 INT32 priority + 20 unused + +CreateFence + 1 CARD8 major opcode + 1 14 minor opcode + 2 4 request length + 4 DRAWABLE drawable + 4 FENCE id + 1 BOOL initially triggered + 3 unused + +TriggerFence + 1 CARD8 major opcode + 1 15 minor opcode + 2 2 request length + 4 FENCE id + +ResetFence + 1 CARD8 major opcode + 1 16 minor opcode + 2 2 request length + 4 FENCE id + +DestroyFence + 1 CARD8 major opcode + 1 17 minor opcode + 2 2 request length + 4 FENCE id + +QueryFence + 1 CARD8 major opcode + 1 18 minor opcode + 2 2 request length + 4 FENCE id +=> + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 1 BOOL triggered + 23 unused + +AwaitFence + 1 CARD8 major opcode + 1 19 minor opcode + 2 1 + n request length + 4*n LISTofFENCE wait conditions + + + + + + +Encoding Events + + +CounterNotify + 1 Base + 0 code + 1 0 kind + 2 CARD16 sequence number + 4 COUNTER counter + 8 INT64 wait value + 8 INT64 counter value + 4 TIME timestamp + 2 CARD16 count + 1 BOOL destroyed + 1 unused + +AlarmNotify + 1 Base + 1 code + 1 1 kind + 2 CARD16 sequence number + 4 ALARM alarm + 8 INT64 counter value + 8 INT64 alarm value + 4 TIME timestamp + 1 ALARMSTATE state + 3 unused + + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/tog-cup.xml b/miniconda3/envs/ladir/share/doc/xextproto/tog-cup.xml new file mode 100644 index 0000000000000000000000000000000000000000..c59e7687ee13e98bb5c0ba8bf61da33c0dacf088 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/tog-cup.xml @@ -0,0 +1,564 @@ + + %defs; +]> + + + + + + Colormap Utilization Policy and Extension + X Project Team Standard + X Version 11, Release &fullrelvers; + Version 1.0 + + + Kaleb + S. + Keithley + The Open Group + + + 1986-1997The Open Group + + + + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this +software and associated documentation files (the Software), to use the +Software +without restriction, including, without limitation, the rights to copy, +modify, merge, +publish, distribute and sublicense the Software, to make, have made, +license and +distribute derivative works thereof, and to permit persons to whom the +Software is +furnished to do so, subject to the following conditions: + + +The above copyright notice and the following permission notice shall be +included in all copies of the Software: + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON- +INFRINGEMENT. IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF +CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OF OTHER DEALINGS IN +THE SOFTWARE. + + +Except as contained in this notice, the name of The Open Group shall not be +used in +advertising or otherwise to promote the use or other dealings in this +Software without prior written authorization from The Open Group. + + +X Window System is a trademark of The Open Group. + + + + + + +Overview + +This extension has three purposes: a) to provide mechanism for a special +application (a colormap manager) to discover any special colormap +requirements, e.g. the colormap entries that are nominally reserved for +desktop colors in the MS-Windows environment and initialize the default +colormap so that it can be more easily shared; and b) to encourage colormap +sharing and reduce colormap flashing on low-end 8-bit frame buffers by +providing a policy for sharing; and c) when colormaps aren't shared, +define a behavior in the X server color allocation scheme to reduce +colormap flashing. + + + +To encourage colormap sharing and accommodate special colormap requirements +two new protocols are defined: the first provides a way to query the +server for a list of reserved colormap entries, and the second is a way +to initialize read-only (shareable) colormap entries at specific locations +in a colormap. + + + +To minimize colormap flashing when the root window's default visual is one +of GrayScale, PseudoColor, or DirectColor, and a private colormap for the +default visual is being used, a minor (but compatible) change to the +server implementation of the AllocColor and AllocNamedColor requests is +required. Where the core protocol says nothing about the pixel values +returned, when this extension is in effect, the AllocColor and AllocNamedColor +requests will first look for a matching color in the default colormap, and, +if a match is found and the same cell in the private colormap has not +already been allocated, the color will be allocated in the private colormap +at the same locaton as in the default colormap (instead of in the first +available location.) + + + + +Requests + +QueryVersion + + + + + + + + + +client_major_version: CARD16 + + + + +client_minor_version: CARD16 + + + + +=> + + + + +server_major_version: CARD16 + + + + +server_minor_version: CARD16 + + + + + + + +If supplied, the client_major_version and client_minor_version indicate +what version of the protocol the client wants the server to implement. +The server version numbers returned indicate the protocol this extension +actually supports. This might not equal the version sent by the client. +An implementation can (but need not) support more than one version +simultaneously. The server_major_version and the server_minor_version +are a mechanism to support future revisions of the TOG-CUP protocol that +may be necessary. In general, the major version would increment for +incompatible changes, and the minor version would increment for small +upward-compatible changes. Servers that support the protocol defined in +this document will return a server_major_version of one (1), and a +server_minor_version of zero (0). + + + +GetReservedColormapEntries + + + + + + + + + +screen: CARD32 + + + + +=> + + + + +entries: LISTofCOLORITEM + + + + + + + +This request returns a list of colormap entries (pixels) that are reserved +by the system, e.g. MS-Windows reserved desktop colors. This list will, at a +minimum, contain entries for the BlackPixel and WhitePixel of the specified +screen. The do-red, do-green, and do-blue elements of the COLORITEMs are +unused in this reply. + + + +Rationale: There are colormap entries (pixels) that, e.g., MS-Windows +desktop reserves as desktop colors, that should not be altered. If they +are altered then X programs will cause colormap flashing between X and +MS-Windows applications running/displaying on the same desktop. + + + +StoreColors + + + + + + + + + +cmap: COLORMAP + + + + +items: LISTofCOLORITEM + + + + +=> + + + + +items: LISTofCOLORITEM + + + + + + + +This request changes the colormap entries of the specified pixels. The +colormap entries are allocated as if by an AllocColor request. The do-red, +do-green, and do-blue elements of the COLORITEMs are unused in this request. +A boolean alloc-ok element (a bit) is returned indicating whether the +particular pixel was successfully allocated or not. If successfully +allocated the RGB and pixel are returned. + + + +A Value error is generated if a pixel is not a valid index into cmap. A +BadMatch error is generated if if cmap does not belong to a GrayScale, +PseudoColor, or DirectColor visual. + + + + + +Events and Errors + +No new events or errors are defined by this extension. + + + + +Changes to existing protocol. + +None. + + + + +Encoding + +The name of this extension is "TOG-CUP". + + + +The conventions used here are the same as those for the core X11 +Protocol Encoding. + + + +QueryVersion + 1 CARD8 opcode + 1 0 TOG-CUP opcode + 2 2 request length + 2 CARD16 client_major_version + 2 CARD16 client_minor_version +=> + 1 1 reply + 1 unused + 2 CARD16 sequence number + 4 0 length + 2 CARD16 server_major_version + 2 CARD16 server_minor_number + 20 unused + + + +GetReservedColormapEntries + 1 CARD8 opcode + 1 1 TOG-CUP opcode + 2 2 request length + 4 CARD32 screen +=> + 1 1 reply + 1 unused + 2 CARD16 sequence number + 4 3n length + 24 unused + 12n LISTofCOLORITEM items + + + +StoreColors + 1 CARD8 opcode + 1 2 TOG-CUP opcode + 2 2+3n request length + 4 COLORMAP cmap + 12n LISTofCOLORITEM items +=> + 1 1 reply + 1 unused + 2 CARD16 sequence number + 4 3n length + 24 unused + 12n LISTofCOLORITEM items + + + +(The definition of COLORITEM here is only for the purpose of defining the +additional alloc-ok member in the CUPStoreColors reply.) + + + + COLORITEM + 4 CARD32 pixel + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 1 alloc-ok + #x07 unused + #x08 alloc-ok (1 is True, 0 is False) + #xF0 unused + 1 unused + + + + +C Language Binding + + +The C functions provide direct access to the protocol and add no additional +semantics. For complete details on the effects of these functions, refer +to the appropriate protocol request, which can be derived by deleting XCup +at the start of the function. All functions that have return type Status +will return nonzero for success and zero for failure. + + + +The include file for this extension is +<X11/extensions/Xcup.h>. + + + + + Status XCupQueryVersion + Display* display + int* major_version_return + int* minor_version_return + + + + + + + display + + + +Specifies the connection to the X server. + + + + + + major_version_return + + + +Returns the major version supported by the server. + + + + + + minor_version_return + + + +Returns the minor version supported by the server. + + + + + + + +XCupQueryVersions sets major_version_return and minor_version_return to +the major and minor TOG-CUP protocol version supported by the server. If +the TOG-CUP library is compatible with the version returned by the server, +it returns nonzero. If dpy does not support the TOG-CUP extension, or if +there was an error during communication with the server, or if the server +and library protocol versions are incompatible, it returns zero. No other +XCup functions may be called before this function. If a client violates +this rule, the effects of all subsequent XCup calls that it makes are +undefined. + + + +To get the list of reserved colormap entries, use +XCupGetReservedColormapEntries. + + + + + Status XCupGetReservedColormapEntries + Display* display + int screen + XColor** colors_out + int* ncolors + + + + + + + display + + + +Specifies the connection to the X server. + + + + + + colors_out + + + +Returns the values reserved by the server. + + + + + + ncolors + + + +Returns the number of items in colors_out. + + + + + + +The XCupGetReservedColormapEntries function gets system specific colormap +entries. E.g. the MS-Windows desktop uses N colormap entries at the beginning +(0..N) and end (256-N..255) of the colormap. Use XFree to free colors_out. + + + +To allocate one or more read-only color cells with RGB values, use +XCupStoreColors. + + + + + Status XCupStoreColors + Display* display + Colormap colormap + XColor* colors_in_out + int ncolors + + + + + + + display + + + +Specifies the connection to the X server. + + + + + + colormap + + + +Specifies the colormap. + + + + + + colors_in_out + + + +Specifies and returns the values actually used in the colormap. + + + + + + ncolors + + + +Specifies the number of items in colors_in_out. + + + + + + +The XCupStoreColors function changes the colormap entries of the pixel +values specified in the pixel members of the XColor structures. The colormap +entries are allocated as if an AllocColor had been used instead, i.e. the +colors are read-only (shareable). XCupStoreColors returns the number of +colors that were successfully allocated in the colormap. + + + + + +Using the TOG-CUP extension and Colormap Utilization Policy + +The X server preallocates any hardware or desktop special colors in the +default colormap; e.g. UNIX X servers preallocate Black and White pixels. +PC X servers should also preallocate the MS-Windows desktop colors. (Note +to implementors: in the Sample Implementation special colors are allocated +in the default colormap in cfbCreateDefColormap for dumb memory framebuffers.) + + + +To minimize colormap flash an application which installs its own private +colormap should query the special colors by calling +XCupGetReservedColormapEntries, and can then store those entries (in the +proper location) in its private colormap using XCupStoreColors. + + + +Applications which allocate many colors in a screen's default colormap, e.g. +a color-cube or a gray-ramp, should allocate them with XCupStoreColors. By +using XCupStoreColors the colors will be allocated shareable (read-only) and +any other application which allocates the same color will share that color +cell. + + + + diff --git a/miniconda3/envs/ladir/share/doc/xextproto/xtest.xml b/miniconda3/envs/ladir/share/doc/xextproto/xtest.xml new file mode 100644 index 0000000000000000000000000000000000000000..4893b883d0404e6e99916236b13a3e4f03eb062a --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xextproto/xtest.xml @@ -0,0 +1,723 @@ + + %defs; +]> + + + + + XTEST Extension Protocol + X Consortium Standard + + + KieronDrake + UniSoft Ltd. + + + X Version 11, Release &fullrelvers; + Version 2.2 + 1992UniSoft Group Ltd. + 19921994X Consortium + + + +Permission to use, copy, modify, and distribute this documentation for any +purpose and without fee is hereby granted, provided that the above copyright +notice and this permission notice appear in all copies. UniSoft makes no +representations about the suitability for any purpose of the information in +this document. This documentation is provided "as is" without express or +implied warranty. + + + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + + +Except as contained in this notice, the name of the X Consortium shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the X Consortium. + + + + + + +Overview + +This extension is a minimal set of client and server extensions +required to completely test the X11 server with no user intervention. + + + +This extension is not intended to support general journaling and +playback of user actions. This is a difficult area [XTrap, 89] as it attempts +to synchronize synthetic user interactions with their effects; it is at the +higher level of dialogue recording/playback rather than at the strictly lexical +level. We are interested only in the latter, simpler, case. A more detailed +discussion and justification of the extension functionality is given in +[Drake, 91]. + + + +We are aiming only to provide a minimum set of facilities that +solve immediate testing and validation problems. The testing extension +itself needs testing, where possible, and so should be as simple as possible. + + + +We have also tried to: + + + + + +Confine the extension to an appropriate high level within the server +to minimize portability problems. In practice this means that the extension +should be at the DIX level or use the DIX/DDX interface, or both. This +has effects, in particular, on the level at which "input synthesis" +can occur. + + + + +Minimize the changes required in the rest of the server. + + + + +Minimize performance penalties on normal server operation. + + + + + + +Description + +The functions provided by this extension fall into two groups: + + + + + Client Operations + + +These routines manipulate otherwise hidden client-side behavior. The +actual implementation will depend on the details of the actual language +binding and what degree of request buffering, GContext caching, and so on, is +provided. +In the C binding, defined in "XTEST Extension Library", routines are +provided to access the internals of two opaque data structures +-- GCs +and +Visuals -- +and to discard any requests pending within the +output buffer of a connection. The exact details can be expected to differ for +other language bindings. + + + + + Server Requests + + +The first of these requests is similar to that provided in most +extensions: it allows a client to specify a major and minor version +number to the server and for the server to respond with major and minor +versions of its own. The remaining two requests allow the following: + + + + + +Access to an otherwise "write-only" server resource: the cursor +associated with a given window + + + + +Perhaps most importantly, limited synthesis of input device events, +almost as if a cooperative user had moved the pointing device +or pressed a key or button. + + + + + + + + + + +Types + +The following types are used in the request and event definitions in +subsequent sections: + + + + + + + + + +FAKE_EVENT_TYPE +{ KeyPress, +KeyRelease, +MotionNotify, +ButtonPress, +ButtonRelease } + + + + + + + FAKE_EVENT + [type: FAKE_EVENT_TYPE, + + + + detail: BYTE, + + + + time: TIME, + + + + root: WINDOW, + + + + rootX, rootY: INT16] + + + + + + +CURSOR { CurrentCursor, None } +or a cursor as defined by the X11 Protocol. + + + + + +Client Operations + + +These are abstract definitions of functionality. They refer to client-side +objects such as "GC" and "VISUAL" that are quoted to +denote their abstract nature. Concrete versions of these functions are +defined only for particular language bindings. In some circumstances +a particular language binding may not implement the relevant abstract +type or may provide it as a transparent, rather than opaque, type, with +the result that the corresponding function does not make sense or is +not required, respectively. + + + +XTestSetGContextOfGC + + + + + + + + +gc: "GC" + + + + +gid: GCONTEXT + + + + + + + +Sets the GCONTEXT within the "GC" gc to have +the value specified by gid. + + + +XTestSetVisualIDOfVisual + + + + + + + + +visual: "VISUAL" + + + + +visualid: VISUALID + + + + + + + +Sets the VISUALID within the "VISUAL" visual to have +the value specified by visualid. + + + +XTestDiscard + + + + + + + + +dpy: "CONNECTION" + + + + +=> + + + + +status: BOOL + + + + + + + +Discards any requests that are present in the request buffer associated with +the "CONNECTION" dpy. +The status returned is +True +if there were one or more requests +in the buffer and +False +otherwise. + + + + +Server Requests + +XTestGetVersion + + + + + + + + +clientMajorVersion: CARD16 + + + + +clientMinorVersion: CARD16 + + + + + => + + + + +serverMajorVersion: CARD16 + + + + +serverMinorVersion: CARD16 + + + + +Errors: Length + + + + + + + + +This request can be used to ensure that the server version of the XTEST +extension is usable by the client. This document defines major version two +(2), minor version one (1). + + + +XTestCompareCursor + + + + + + + + +window: WINDOW + + + + +cursor-id: CURSOR or +CurrentCursor +or +None + + + + +=> + + + + +same: BOOL + + + + +Errors: +Window, +Length, +Cursor + + + + + + + +This request looks up the cursor associated with the window and +compares it with either the null cursor if cursor-id is +None , +or the current cursor (that is, the one being displayed), +or the cursor whose ID is cursor-id, and returns +the result of the comparison in same. + + + +XTestFakeInput + + + + + + + + +events: LISTofFAKE_EVENT + + + + +Errors: +Window, +Length, +Alloc, +Value + + + + + + + +This request simulates the limited set of core protocol +events within the set FAKE_EVENT_TYPE. Only the following event fields, +defined in FAKE_EVENT, are interpreted: + + + + + + type + + + +This must be one of +KeyPress, +KeyRelease, +MotionNotify, +ButtonPress, +or +ButtonRelease, +or else a +Value +error occurs. + + + + + + detail + + + +For key events, this field is interpreted as the physical keycode. +If the keycode is less than min-keycode or greater than max-keycode, +as returned in the connection setup, then a +Value +error occurs. +For button events, this field is interpreted as the physical (or core) button, +meaning it will be mapped to the corresponding logical button according to +the most recent +SetPointerMapping +request. +If the button number is less than one or greater than the number of physical +buttons, then a +Value +error occurs. +For motion events, if this field is +True , +then rootX and rootY +are relative distances from the current pointer location; if this field is +False, +then they are absolute positions. + + + + + + time + + + +This is either +CurrentTime +(meaning no delay) +or the delay in milliseconds that the server should wait before +simulating this event. No other requests from this client will be +processed until this delay, if any, has expired and subsequent processing +of the simulated event has been completed. + + + + + + root + + + +In the case of motion events this field is the ID of the root window on +which the new motion is to take place. If +None +is specified, the root window of the screen the pointer is currently on +is used instead. +If this field is not a valid window, then a +Window +error occurs. + + + + + + rootX & + rootY + + + +In the case of motion events these fields indicate relative distance or +absolute pointer coordinates, according to the setting of detail. +If the specified coordinates are off-screen, the closest on-screen +coordinates will be substituted. + + + + + + +When the simulated event(s) are processed, they cause event propagation, +passive grab activation, and so on, just as if the corresponding input device +action had occurred. However, motion events might not be recorded in the +motion history buffer. + + + +For the currently supported event types, the event list must have length one, +otherwise a +BadLength +error occurs. + + + +XTestGrabControl + + + + + + + + +impervious: BOOL + + + + + + + +If impervious is +True, +then the executing client becomes impervious to server grabs; +that is, it can continue executing requests even if another client +grabs the server. +If impervious is +False, +then the executing client returns to the normal state of being +susceptible to server grabs. + + + + +Encoding + +Please refer to the X11 Protocol Encoding document as this document uses +conventions established there. + + + +The name of this extension is "XTEST". + + + +New Types + +FAKE_EVENT_TYPE + 2 KeyPress + 3 KeyRelease + 4 ButtonPress + 5 ButtonRelease + 6 MotionNotify + + + +NOTE that the above values are defined to be the same as those for +the corresponding core protocol event types. + + + + +Requests + + +XTestGetVersion + 1 CARD8 opcode + 1 0 xtest opcode + 2 2 request length + 1 CARD8 client major version + 1 unused + 2 CARD16 client minor version +=> + 1 1 Reply + 1 CARD8 server major version + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 server minor version + 22 unused + + + +XTestCompareCursor + 1 CARD8 opcode + 1 1 xtest opcode + 2 3 request length + 4 WINDOW window + 4 CURSOR cursor-id + 0 None + 1 CurrentCursor +=> + 1 1 Reply + 1 BOOL cursors are the same + 2 CARD16 sequence number + 4 0 reply length + 24 unused + + + +XTestFakeInput + 1 CARD8 opcode + 1 2 xtest opcode + 2 1+(1*8) request length + 1 FAKE_EVENT_TYPE fake device event type + 1 BYTE detail: button or keycode + 2 unused + 4 TIME delay (milliseconds) + 0 CurrentTime + 4 WINDOW root window for MotionNotify + 0 None + 8 unused + 2 INT16 x position for MotionNotify + 2 INT16 y position for MotionNotify + 8 unused + + + +XTestGrabControl + 1 CARD8 opcode + 1 3 xtest opcode + 2 2 request length + 1 BOOL impervious + 3 unused + + + + + +References + +Annicchiarico, D., et al., +XTrap: The XTrap Architecture. +Digital Equipment Corporation, July 1991. + + + +Drake, K. J., +Some Proposals for a +Minimum X11 Testing Extension. +UniSoft Ltd., June 1991. + + + + diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/compositeproto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/compositeproto.txt new file mode 100644 index 0000000000000000000000000000000000000000..c1a78780fc2fa12dc9db6e6793eb074722ee90eb --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/compositeproto.txt @@ -0,0 +1,305 @@ + Composite Extension + Version 0.4 + 2007-7-3 + Keith Packard + keithp@keithp.com + Deron Johnson + deron.johnson@sun.com + +1. Introduction + +Many user interface operations would benefit from having pixel contents of +window hierarchies available without respect to sibling and antecedent +clipping. In addition, placing control over the composition of these pixel +contents into a final screen image in an external application will enable +a flexible system for dynamic application content presentation. + +2. Acknowledgements + +This small extension has been brewing for several years, contributors to +both early prototypes and the final design include: + + + Bill Haneman for motivating the ability to magnify occluded windows + with his work on accessibility + + + Carsten Haitzler for Enlightenment, the original eye-candy window + manager which demonstrated that clever hacks are an awfully + close substitute for changes in the underlying system. + + + Jim Gettys for key insights into the relationship between damage + events and per-window pixmap usage + + + Mike Harris and Owen Taylor for figuring out what to call it. + + + Deron Johnson for the Looking Glass implementation and + a prototype of the coordinate transformation mechanism. + + + Ryan Lortie for helping figure out reasonable parent clipping + semantics in the presence of manual redirected children. + +3. Architecture + +The composite extension provides three related mechanisms: + + 1. Per-hierarchy storage. The rendering of an entire hierarchy of windows + is redirected to off-screen storage. The pixels of that hierarchy + are available whenever it is viewable. Storage is automatically + reallocated when the top level window changes size. Contents beyond + the geometry of the top window are not preserved. + + 2. Automatic shadow update. When a hierarchy is rendered off-screen, + the X server provides an automatic mechanism for presenting those + contents within the parent window. The implementation is free to + make this update lag behind actual rendering operations by an + unspecified amount of time. This automatic update mechanism may + be disabled so that the parent window contents can be completely + determined by an external application. + + 3. External parent - child pointer coordinate transformation. + When a hierarchy is under manual compositing, the relationship + of coordinates within the parent to those in the child may + not be known within the X server. This mechanism provides + for redirection of these transformations through a client. + +Per-hierarchy storage may be created for individual windows or for all +children of a window. Manual shadow update may be selected by only a single +application for each window; manual update may also be selected on a +per-window basis or for each child of a window. Detecting when to update +may be done with the Damage extension. + +The off-screen storage includes the window contents, its borders and the +contents of all descendants. + +3.1 NameWindowPixmap + +Version 0.2 of the protocol introduces a mechanism for associating an XID +with the off-screen pixmap used to store these contents. This can be used +to hold onto window contents after the window is unmapped (and hence animate +it's disappearance), and also to access the border of the window, which is +not reachable through the Window ID itself. A new pixmap is created each +time the window is mapped or resized; as these events are nicely signalled +with existing events, no additional notification is needed. The old pixmap +will remain allocated as long as the Pixmap ID is left valid, it is +important that the client use the FreePixmap request when it is done with +the contents and to create a new name for the newly allocated pixmap. + +In automatic update mode, the X server is itself responsible for presenting +the child window contents within the parent. It seems reasonable, then, for +rendering to the parent window to be clipped so as not to interfere with any +child window content. In an environment with a mixture of manual and +automatic updating windows, rendering to the parent in the area nominally +occupied by a manual update window should be able to affect parent pixel +values in those areas, but such rendering should be clipped to automatic +update windows, and presumably to other manual update windows managed by +other applications. In any of these cases, it should be easy to ensure that +rendering has no effect on any non-redirected windows. + +Instead of attempting to define new clipping modes for rendering, the +Composite extension instead defines ClipByChildren rendering to the parent +to exclude regions occupied by redirected windows (either automatic or +manual). The CreateRegionFromBorderClip request can be used along with +IncludeInferiors clipping modes to restrict manual shadow updates to the +apporpriate region of the screen. Bracketing operations with +GrabServer/UngrabServer will permit atomic sequences that can update the +screen without artifact. As all of these operations are asynchronous, +network latency should not adversely affect update latency. + +3.2 Composite Overlay Window + +Version 0.3 of the protocol adds the Composite Overlay Window, which +provides compositing managers with a surface on which to draw without +interference. This window is always above normal windows and is always +below the screen saver window. It is an InputOutput window whose width +and height are the screen dimensions. Its visual is the root visual +and its border width is zero. Attempts to redirect it using the +composite extension are ignored. This window does not appear in the +reply of the QueryTree request. It is also an override redirect window. +These last two features make it invisible to window managers and other X11 +clients. The only way to access the XID of this window is via the +CompositeGetOverlayWindow request. Initially, the Composite Overlay +Window is unmapped. + +CompositeGetOverlayWindow returns the XID of the Composite Overlay +Window. If the window has not yet been mapped, it is mapped by this +request. When all clients who have called this request have terminated +their X11 connections the window is unmapped. + +Composite managers may render directly to the Composite Overlay +Window, or they may reparent other windows to be children of this +window and render to these. Multiple clients may render to the +Composite Overlay Window, create child windows of it, reshape it, and +redefine its input region, but the specific arbitration rules followed +by these clients is not defined by this specification; these policies +should be defined by the clients themselves. + +3.3 Clipping semantics redefined + +Version 0.4 of the protocol changes the semantics of clipping in the +presence of manual redirect children. In version 0.3, a parent was always +clipped to child windows, independent of the kind of redirection going on. +With version 0.4, the parent is no longer clipped to child windows which are +manually redirected. This means the parent can draw in the child region without using +IncludeInferiors mode, and (perhaps more importantly), it will receive +expose events in those regions caused by other actions. This new behaviour +is not selectable. + +4. Errors + +The composite extension does not define any new errors. + +5. Types + + UPDATETYPE { Automatic, Manual } + + CompositeCoordinate + child: Window + x, y: CARD16 + +7. Extension Initialization + +The client must negotiate the version of the extension before executing +extension requests. Otherwise, the server will return BadRequest for any +operations other than QueryVersion. + + QueryVersion + + client-major-version: CARD32 + client-minor-version: CARD32 + + -> + + major-version: CARD32 + minor-version: CARD32 + + The client sends the highest supported version to the server and + the server sends the highest version it supports, but no higher than + the requested version. Major versions changes can introduce + incompatibilities in existing functionality, minor version + changes introduce only backward compatible changes. It is + the client's responsibility to ensure that the server supports + a version which is compatible with its expectations. Servers + are encouraged to support multiple versions of the extension. + +8. Hierarchy Redirection + + RedirectWindow + + window: Window + update: UPDATETYPE + + errors: Window, Access, Match + + The hierarchy starting at 'window' is directed to off-screen + storage. 'update' specifies whether the contents are mirrored to + the parent window automatically or not. Only one client may specify + an update type of Manual, another attempt will result in an + Access error. When all clients enabling redirection terminate, + the redirection will automatically be disabled. + + The root window may not be redirected. Doing so results in a Match + error. + + RedirectSubwindows + + window: Window + update UPDATETYPE + + errors: Window, Access + + Hierarchies starting at all current and future children of window + will be redirected as in RedirectWindow. If update is Manual, + then painting of the window background during window manipulation + and ClearArea requests is inhibited. + + UnredirectWindow: + + window: Window + update: UPDATETYPE + + errors: Window, Value + + Redirection of the specified window will be terminated. If + the specified window was not selected for redirection by the + current client, or if the update type does not match the + current client's previously requested update type, a 'Value' + error results. + + UnredirectSubwindows: + + window: Window + update: UPDATETYPE + + errors: Window, Value + + Redirection of all children of window will be terminated. If + the specified window was not selected for sub-redirection by the + current client, or if the update type does not match the + current client's previously requested update type, a 'Value' + error results. + +9. Clip lists + + CreateRegionFromBorderClip + + region: Region + window: Window + + errors: Window, IDChoice + + This request creates a region containing the "usual" border clip + value; that is the area of the window clipped against siblings and + the parent. This region can be used to restrict rendering to + suitable areas while updating only a single window. The region + is copied at the moment the request is executed; future changes + to the window hierarchy will not be reflected in this region. + +10. Associating a Pixmap ID with the off-screen storage (0.2 and later) + + NameWindowPixmap + + window: Window + pixmap: Pixmap + + errors: Window, Match, IDChoice + + This request makes 'pixmap' a reference to the off-screen storage + for 'window'. This pixmap will remain allocated until freed, even + if 'window' is unmapped, reconfigured or destroyed. However, + 'window' will get a new pixmap allocated each time it is + mapped or resized, so this request will need to be reinvoked for + the client to continue to refer to the storage holding the current + window contents. Generates a 'Match' error if 'window' is not + redirected or is not visible. + +11. Composite Overlay Window (0.3 and later) + + CompositeGetOverlayWindow + + window: Window + + -> + + overlayWin: Window + + This request returns the XID of the Composite Overlay Window for + the screen specified by the argument 'window'. This request + indicates that the client wishes to use the Composite Overlay + Window of this screen. If this Composite Overlay Window has not + yet been mapped, it is mapped by this request. + + The Composite Overlay Window for a particular screen will be + unmapped when all clients who have invoked this request have + also invoked CompositeReleaseOverlayWindow for that screen. Also, + CompositeReleaseOverlayWindow for a screen will be implicitly + called when a client using the Composite Overlay Window on that + screen terminates its X11 connection. + + + CompositeReleaseOverlayWindow + + window: Window + + This request specifies that the client is no longer using the + Composite Overlay Window on the screen specified by the + argument 'window'. A screen's Composite Overlay Window is + unmapped when there are no longer any clients using it. diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/damageproto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/damageproto.txt new file mode 100644 index 0000000000000000000000000000000000000000..cea232252279de50fee1087b027539c562d14883 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/damageproto.txt @@ -0,0 +1,222 @@ + The DAMAGE Extension + Protocol Version 1.1 + Document Revision 1 + 2007-01-08 + + Keith Packard + keithp@keithp.com + + Eric Anholt + eric@anholt.net + Open Source Technology Center + Intel Corporation +1. Introduction + +Monitoring the regions affected by rendering has wide-spread use, from +VNC-like systems scraping the screen to screen magnifying applications +designed to aid users with limited visual acuity. The DAMAGE extension is +designed to make such applications reasonably efficient in the face of +server-client latency. + +2. Acknowledgements + +As usual, the author had significant input from many people, in particular: + + + Havoc Pennington who designed and implemented a Damage extension + last year which was then lost to the mists of time. + + + Bill Haneman whose work on accessibility in the Gnome environment + is legendary. + + + Jim Gettys who found a way to avoid streaming damage rectangles + to the client in many cases. + + + Owen Taylor who suggested that streaming damage rectangles may + be warranted in some cases after all. + +3. Damage Model + +We call changes made to pixel contents of windows and pixmaps 'damage' +throughout this extension. Another notion of 'damage' are drawable regions +which are in need of redisplay to repair the effects of window manipulation +or other data loss. This extension doesn't deal with this second notion at +all; suggestions on a better term which isn't easily conflated with existing +notions are eagerly solicited. + +Damage accumulates as drawing occurs in the drawable. Each drawing operation +'damages' one or more rectangular areas within the drawable. The rectangles +are guaranteed to include the set of pixels modified by each operation, but +may include significantly more than just those pixels. The desire is for +the damage to strike a balance between the number of rectangles reported and +the extraneous area included. A reasonable goal is for each primitive +object drawn (line, string, rectangle) to be represented as a single +rectangle and for the damage area of the operation to be the union of these +rectangles. + +The DAMAGE extension allows applications to either receive the raw +rectangles as a stream of events, or to have them partially processed within +the X server to reduce the amount of data transmitted as well as reduce the +processing latency once the repaint operation has started. + +Damage to a window reflects both drawing within the window itself as well as +drawing within any inferior window that affects pixels seen by +IncludeInferiors rendering operations. To reduce the computational +complexity of this, the DAMAGE extension allows the server to monitor all +rendering operations within the physical target pixel storage that fall +within the bounds of the window. In a system with a single frame buffer +holding all windows, this means that damage will accumulate for all +rendering operations that lie within the visible part of the window. + +The precise reason for this architecture is to enable the Composite +extension which provides multiple pixel storage areas for the screen +contents. + +3.1 Additions in the 1.1 version of the protocol + +Damage is automatically computed by the X Server for X rendering operations, +but direct rendering extensions have allowed clients to perform rendering +outside of the control of the X Server. The 1.1 version of the protocol +added a request to allow direct rendering clients to report damage to a +drawable. Some direct rendering clients, due to architectural limitations, +always perform rendering to the root window, even in when it should be +performed to the backing pixmap in the Composite case. To provide +less-incorrect rendering in this cases, the direct rendering client should +translate its damage region to screen coordinates and report the damage against +the root window rather than the drawable. + +4. Data types + +The "Damage" object holds any accumulated damage region and reflects the +relationship between the drawable selected for damage notification and the +drawable for which damage is tracked. + +5. Errors + +Damage + A value for a DAMAGE argument does not name a defined DAMAGE. + +6. Types + + DAMAGE 32-bit value (top three bits guaranteed to be zero) + + DamageReportLevel { DamageReportRawRectangles, + DamageReportDeltaRectangles, + DamageReportBoundingBox, + DamageReportNonEmpty } + + DamageReportRawRectangles + + Delivers DamageNotify events each time the screen + is modified with rectangular bounds that circumscribe + the damaged area. No attempt to compress out overlapping + rectangles is made. + + DamageReportDeltaRectangles + + Delivers DamageNotify events each time damage occurs + which is not included in the damage region. The + reported rectangles include only the changes to that + area, not the raw damage data. + + DamageReportBoundingBox + + Delivers DamageNotify events each time the bounding + box enclosing the damage region increases in size. + The reported rectangle encloses the entire damage region, + not just the changes to that size. + + DamageReportNonEmpty + + Delivers a single DamageNotify event each time the + damage rectangle changes from empty to non-empty, and + also whenever the result of a DamageSubtract request + results in a non-empty region. + +7. Events + +DamageNotify + + level: DamageReportLevel + drawable: Drawable + damage: DAMAGE + more: Bool + timestamp: Timestamp + area: Rectangle + drawable-geometry: Rectangle + + 'more' indicates whether there are subsequent damage events + being delivered immediately as part of a larger damage region + +8. Extension Initialization + +The client must negotiate the version of the extension before executing +extension requests. Otherwise, the server will return BadRequest for any +operations other than QueryVersion. + +QueryVersion + + client-major-version: CARD32 + client-minor-version: CARD32 + + -> + + major-version: CARD32 + minor-version: CARD32 + + The client sends the highest supported version to the server and + the server sends the highest version it supports, but no higher than + the requested version. Major versions changes can introduce + incompatibilities in existing functionality, minor version + changes introduce only backward compatible changes. It is + the clients responsibility to ensure that the server supports + a version which is compatible with its expectations. Servers + are encouraged to support multiple versions of the extension. + +9. Enable Monitoring + +DamageCreate + + damage: DAMAGE + drawable: Drawable + level: DamageReportLevel + + Creates a damage object to monitor changes to Drawable + +DamageDestroy + damage: DAMAGE + + Destroys damage. + +DamageSubtract + + damage: DAMAGE + repair: Region or None + parts: Region or None + + Synchronously modifies the regions in the following manner: + + If repair is None: + + 1) if parts is not None, parts = damage + 2) damage = + + Otherwise: + + 1) tmp = damage INTERSECT repair + 2) damage = damage - tmp + 3) if parts is not None, parts = tmp + 4) Generate DamageNotify for remaining damage areas + +DamageAdd + + drawable: Drawable + region: Region + + Reports damage of the region within the given drawable. This may be + used by direct rendering clients to report damage that the server would + otherwise be unaware of. The damage region is relative to the origin + of the drawable. + + Damage posted in this way will appear in DamageNotify events as normal, + and also in server internal damage tracking (for shadow framebuffer + updates, pixmap damage, and other uses). diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/dri2proto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/dri2proto.txt new file mode 100644 index 0000000000000000000000000000000000000000..0e581714b02250ba3f5b9ecac760cc2b60bb0a47 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/dri2proto.txt @@ -0,0 +1,909 @@ + The DRI2 Extension + Version 2.0 + 2008-09-04 + + Kristian Høgsberg + krh@redhat.com + Red Hat, Inc + + +1. Introduction + +The DRI2 extension is designed to associate and access auxiliary +rendering buffers with an X drawable. + +DRI2 is a essentially a helper extension to support implementation of +direct rendering drivers/libraries/technologies. + +The main consumer of this extension will be a direct rendering OpenGL +driver, but the DRI2 extension is not designed to be OpenGL specific. +Direct rendering implementations of OpenVG, Xv, cairo and other +graphics APIs should find the functionality exposed by this extension +helpful and hopefully sufficient. + +Relation to XF86DRI + + +1.1. Acknowledgements + +Kevin E. Martin +Keith Packard +Eric Anholt +Keith Whitwell +Jerome Glisse +Ian Romanick +Michel Dänzer +Jesse Barnes + + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +2. DRI2 Concepts + + +2.1. Attachment points + +Stolen from OpenGL FBOs, I guess. + + +2.2. Kernel rendering manager + +This specification assumes a rendering architecture, where an +underlying kernel rendering manager that can provide 32 bit integer +handles to video memory buffers. These handles can be passed between +processes, which, through a direct rendering driver, submit rendering +to the kernel rendering manager, targeting and/or sourcing from these +buffers. This extension provides a means to communicate about such +buffers as associated with an X drawable. + +The details of how the direct rendering driver use the buffer names +and submit the rendering requests is outside the scope of this +specification. However, Appendix B does discuss implementation of +this specification on the Graphics Execution Manager (GEM). + + +2.3. Request ordering + +No ordering between swap buffers and X rendering. X rendering to src +buffers will block if they have a vblank pending. + + +2.4 Authentication model + +The purpose of the DRM authentication scheme is to grant access to the +kernel rendering manager buffers created by the X server if, and only +if, the client has access to the X server. This is achieved in a +three-step protocol: + + 1) The client gets a token from the kernel rendering manager + that uniquely identifies it. The token is a 32 bit integer. + + 2) The client passes the token to the X server in the + DRI2Authenticate request. This request is a round trip to + make sure the X server has received and processed the + authentication before the client starts accessing the DRM. + + 3) The X server authorizes the client by passing the token to + the kernel rendering manager. + +A kernel rendering manager can choose not to implement any +authentication and just allow access to all buffers. + + +2.5 Rendering to the X front buffer + +OpenGL allows the client to render to the front buffer, either by +using a single-buffered configuration or but explicitly setting the +draw buffer to GL_FRONT_LEFT. Not allowed! + +The client must ask for a fake front buffer, render to that and then +use DRI2CopyRegion to copy contents back and forth between the fake +front buffer and the real front buffer. When X and direct rendering +to a front buffer is interleaved, it is the responsibility of the +application to synchronize access using glXWaitGL and glXWaitX. A +DRI2 implementation of direct rendering GLX, should use these entry +points to copy contents back and forth to as necessary to ensure +consistent rendering. + +The client may also use the DRI2SwapBuffers function to request a swap +of the front and back buffers. If the display server supports it, this +operation may be preferred, since it may be easier and/or more performant +for the server to perform a simple buffer swap rather than a blit. + +2.6 Synchronizing rendering + +DRI2 provides several methods for synchronizing drawing with various events. +The protocol for these methods is based on the SGI_video_sync and +OML_sync_control GLX extensions. Using the DRI2WaitMSC request, a client +can wait for a specific frame count or divisor/remainder before continuing +its processing. With the DRI2WaitSBC request, clients can block until a given +swap count is reached (as incremented by DRI2SwapBuffers). Finally, using +DRI2SwapBuffers, clients can limit their frame rate by specifying a swap +interval using the swap interval call (currently only available through GLX) +or by using the OML swap buffers routine. + +2.7 Events + +DRI2 provides an event to indicate when a DRI2SwapBuffers request has +been completed. This can be used to throttle drawing on the client +side and tie into application main loops. + +Another event is generated when the validity of the requested buffers +changes. + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +3. Data Types + +The server side region support specified in the Xfixes extension +version 2 is used in the CopyRegion request. + + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +4. Errors + +No errors are defined by the DRI2 extension. + + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + +5. Events + +The only events provided by DRI2 are DRI2_BufferSwapComplete +and DRI2InvalidateBuffers. + + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +6. Protocol Types + +DRI2DRIVER { DRI2DriverDRI + DRI2DriverVDPAU } + + These values describe the type of driver the client will want + to load. The server sends back the name of the driver to use + for the screen in question. + +DRI2ATTACHMENT { DRI2BufferFrontLeft + DRI2BufferBackLeft + DRI2BufferFrontRight + DRI2BufferBackRight + DRI2BufferDepth + DRI2BufferStencil + DRI2BufferAccum + DRI2BufferFakeFrontLeft + DRI2BufferFakeFrontRight + DRI2BufferDepthStencil + DRI2BufferHiz } + + These values describe various attachment points for DRI2 + buffers. + +DRI2BUFFER { attachment: CARD32 + name: CARD32 + pitch: CARD32 + cpp: CARD32 + flags: CARD32 } + + The DRI2BUFFER describes an auxiliary rendering buffer + associated with an X drawable. 'attachment' describes the + attachment point for the buffer, 'name' is the name of the + underlying kernel buffer, + + +DRI2ATTACH_FORMAT { attachment: CARD32 + format: CARD32 } + + The DRI2ATTACH_FORMAT describes an attachment and the associated + format. 'attachment' describes the attachment point for the buffer, + 'format' describes an opaque, device-dependent format for the buffer. + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +7. Extension Initialization + +The name of this extension is "DRI2". + +┌─── + DRI2QueryVersion + client-major-version: CARD32 + client-minor-version: CARD32 + ▶ + major-version: CARD32 + minor-version: CARD32 +└─── + + The client sends the highest supported version to the server + and the server sends the highest version it supports, but no + higher than the requested version. Major versions changes can + introduce incompatibilities in existing functionality, minor + version changes introduce only backward compatible changes. + It is the clients responsibility to ensure that the server + supports a version which is compatible with its expectations. + + Backwards compatible changes included addition of new + requests, but also new value types in the DRI2CopyRegion + request. When new values are introduced, the minor version + will be increased so the client can know which values the X + server understands from the version number. + + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +8. Extension Requests + +┌─── + DRI2Connect + window: WINDOW + driverType: DRI2DRIVER + ▶ + driver: STRING + device: STRING +└─── + + Returns the driver name and device file to use for the + specified driver type for the screen associated with 'window'. + + 'type' identifies the type of driver to query for. + + 'driver' is the name of the driver to load. The client is + assumed to know where to look for the drivers and what to do + with it. + + 'device' is the filename of the DRM device file. + + If the client is not local, or the request driver type is + unknown or not available, 'driver' and 'device' will be empty + strings. We are not using an regular X + error here to indicate failure, which will allow the client + fall back to other options more easily. + + ISSUE: We could add the list of supported attachments and the + supported DRI2CopyRegion values here (just the bitmask of all + supported values). + +┌─── + DRI2Authenticate + window: WINDOW + token: CARD32 + ▶ + authenticated: CARD32 +└─── + Errors: Window + + Request that the X server authenticates 'token', allowing the + client to access the DRM buffers created by the X server on + the screen associated with 'window'. + + Authentication shouldn't fail at this point, except if an + invalid token is passed, in which case authenticated is False. + +┌─── + DRI2GetBuffers + drawable: DRAWABLE + attachments: LISTofDRI2ATTACHMENTS + ▶ + width, height: CARD32 + buffers: LISTofDRI2BUFFER +└─── + Errors: Window + + Get buffers for the provided attachment points for the given + drawable. + + If the DDX driver does not support one or more of the + specified attachment points, a Value error is generated, with + the first unsupported attachment point as the error value. + + 'width' and 'height' describes the dimensions of the drawable. + + 'buffers' is a list of DRI2BUFFER for the given DRI2 + attachment points. + +┌─── + DRI2CopyRegion + drawable: DRAWABLE + region: REGION + source: DRI2ATTACHMENT + destination: DRI2ATTACHMENT + ▶ +└─── + Errors: Window, Value + + Schedule a copy from one DRI2 buffer to another. + + The DRICopyRegion request has a reply but it is empty. The + reply is there to let the direct rendering client wait until + the server has seen the request before proceeding with + rendering the next frame. + +┌─── + DRI2SwapBuffers + drawable: DRAWABLE + target_msc: two CARD32s + divisor: two CARD32s + remainder: two CARD32s + ▶ + swap: two CARD32s +└─── + Errors: Window + + Schedule a swap of the front and back buffers with the display + server. + + Returns the swap count value when the swap will actually occur (e.g. + the last queued swap count + (pending swap count * swap interval)). + + This request is only available with protocol version 1.2 or + later. + +┌─── + DRI2GetBuffersWithFormat + drawable: DRAWABLE + attachments: LISTofDRI2ATTACH_FORMAT + ▶ + width, height: CARD32 + buffers: LISTofDRI2BUFFER +└─── + Errors: Window + + Get buffers for the provided attachment points with the specified + formats for the given drawable. + + If the DDX driver does not support one or more of the + specified attachment points or formats, a Value error is generated, + with the first unsupported attachment point as the error value. + + 'width' and 'height' describes the dimensions of the drawable. + + 'buffers' is a list of DRI2BUFFER for the given DRI2 + attachment points. + + This request is only available with protocol version 1.1 or + later. + +┌─── + DRI2GetMSC + drawable: DRAWABLE + ▶ + ust, msc, sbc: CARD64 +└─── + Errors: Window + + Get the current media stamp counter (MSC) and swap buffer count (SBC) + along with the unadjusted system time (UST) when the MSC was last + incremented. + + This request is only available with protocol version 1.2 or + later. + +┌─── + DRI2WaitMSC + drawable: DRAWABLE + target_msc: two CARD32s + divisor: two CARD32s + remainder: two CARD32s + ▶ + ust, msc, sbc: CARD64 +└─── + Errors: Window + + Blocks the client until either the frame count reaches target_msc or, + if the frame count is already greater than target_msc when the request + is received, until the frame count % divisor = remainder. If divisor + is 0, the client will be unblocked if the frame count is greater than + or equal to the target_msc. + + Returns the current media stamp counter (MSC) and swap buffer count + (SBC) along with the unadjusted system time (UST) when the MSC was last + incremented. + + This request is only available with protocol version 1.2 or + later. + +┌─── + DRI2WaitSBC + drawable: DRAWABLE + target_sbc: two CARD32s + ▶ + ust, msc, sbc: CARD64 +└─── + Errors: Window + + Blocks the client until the swap buffer count reaches target_sbc. If + the swap buffer count is already greater than or equal to target_sbc + when the request is received, this request will return immediately. + + If target_sbc is 0, this request will block the client until all + previous DRI2SwapBuffers requests have completed. + + Returns the current media stamp counter (MSC) and swap buffer count + (SBC) along with the unadjusted system time (UST) when the MSC was last + incremented. + + This request is only available with protocol version 1.2 or + later. + +┌─── + DRI2SwapInterval + drawable: DRAWABLE + interval: CARD32 + ▶ +└─── + Errors: Window + + Sets the swap interval for DRAWABLE. This will throttle + DRI2SwapBuffers requests to swap at most once per interval frames, + which is useful useful for limiting the frame rate. + +┌─── + DRI2GetParam + drawable: DRAWABLE + param: CARD32 + ▶ + is_param_recognized: BOOL + value: CARD64 +└─── + Errors: Drawable + + Get the value of a parameter. The parameter's value is looked up on + the screen associated with 'drawable'. + + Parameter names in which the value of the most significant byte is + 0 are reserved for the X server. Currently, no such parameter names + are defined. (When any such names are defined, they will be defined in + this extension specification and its associated headers). + + Parameter names in which the byte's value is 1 are reserved for the + DDX. Such names are private to each driver and shall be defined in the + respective driver's headers. + + Parameter names in which the byte's value is neither 0 nor 1 are + reserved for future use. + + Possible values of 'is_param_recognized' are true (1) and false (0). + If false, then 'value' is undefined. + + This request is only available with protocol version 1.4 or later. + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + +9. Extension Events + +┌─── + DRI2BufferSwapComplete + ▶ + event_type: CARD16 + drawable: CARD32 + ust: CARD64 + msc: CARD64 + sbc: CARD64 +└─── + + This event reports the status of the last DRI2SwapBuffers event to + the client. The event type should be one of DRI2_EXCHANGE_COMPLETE, + indicating a successful buffer exchange, DRI2_BLIT_COMPLETE, indicating + the swap was performed with a blit, and DRI2_FLIP_COMPLETE, indicating + a full page flip was completed. + +┌─── + DRI2InvalidateBuffers + ▶ + drawable: CARD32 +└─── + + This event is generated when the buffers the client had + requested for 'drawable' (with DRI2GetBuffers or + DRI2GetBuffersWithFormat) become inappropriate because they + don't match the drawable dimensions anymore, or a buffer swap + has been performed. + + Note that the server is only required to warn the client once + about this condition, until the client takes care of bringing + them back up-to-date with another GetBuffers request. + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + +10. Extension Versioning + +The DRI2 extension has undergone a number of revisions before + + 1.0: Released, but never used. Relied on a number of + constructs from the XF86DRI extension, such as a + shared memory area (SAREA) to communicate changes in + cliprects and window sizes, and + + 1.99.1: Move the swap buffer functionality into the X server, + introduce SwapBuffer request to copy back buffer + contents to the X drawable. + + 1.99.2: Rethink the SwapBuffer request as an asynchronous + request to copy a region between DRI2 buffers. Drop + CreateDrawable and DestroyDrawable, update Connect to + support different driver types and to send the + authentication group. + + 1.99.3: Drop the bitmask argument intended to indicate + presence of optional arguments for CopyRegion. + + 2.0: Awesomeness! + + 2.1: True excellence. Added DRI2GetBuffersWithFormat to allow + more flexible object creation. + + 2.2: Approaching perfection. Added requests for swapbuffers, + MSC and SBC related requests, and events. + + 2.3: Added the DRI2InvalidateBuffers event. + + 2.6: Enlightenment attained. Added the DRI2BufferHiz attachment. + + 2.7: Added the DRI2GetParam request. + +Compatibility up to 2.0 is not preserved, but was also never released. + + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +11. Relationship with other extensions + +As an extension designed to support other extensions, there is +naturally some interactions with other extensions. + + +11.1 GLX + +The GL auxiliary buffers map directly to the DRI2 buffers... eh + + +11.2 DBE + +The DBE back buffer must correspond to the DRI2_BUFFER_FRONT_LEFT +DRI2 buffer for servers that support both DBE and DRI2. + + +11.3 XvMC / Xv + +We might add a DRI2_BUFFER_YUV to do vsynced colorspace conversion +blits. Maybe... not really sure. + + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +Appendix A. Protocol Encoding + +Syntactic Conventions + +This document uses the same syntactic conventions as the core X +protocol encoding document. + + +A.1 Common Types + +┌─── + DRI2DRIVER + 0x0 DRI2DriverDRI + 0x1 DRI2DriverVDPAU +└─── + +┌─── + DRI2ATTACHMENT + 0x0 DRI2BufferFrontLeft + 0x1 DRI2BufferBackLeft + 0x2 DRI2BufferFrontRight + 0x3 DRI2BufferBackRight + 0x4 DRI2BufferDepth + 0x5 DRI2BufferStencil + 0x6 DRI2BufferAccum + 0x7 DRI2BufferFakeFrontLeft + 0x8 DRI2BufferFakeFrontRight + 0x9 DRI2BufferDepthStencil + 0xa DRI2BufferHiz +└─── + Used to encode the possible attachment points. The attachment + DRI2BufferDepthStencil is only available with protocol version 1.1 or + later. + +┌─── + DRI2BUFFER + 4 CARD32 attachment + 4 CARD32 name + 4 CARD32 pitch + 4 CARD32 cpp + 4 CARD32 flags +└─── + A DRI2 buffer specifies the attachment, the kernel memory + manager name, the pitch and chars per pixel for a buffer + attached to a given drawable. + +┌─── + DRI2ATTACH_FORMAT + 4 CARD32 attachment + 4 CARD32 format +└─── + Used to describe the attachment and format requested from the server. + This data type is only available with protocol version 1.1 or + later. + +A.2 Protocol Requests + +┌─── + DRI2QueryVersion + 1 CARD8 major opcode + 1 0 DRI2 opcode + 2 3 length + 4 CARD32 major version + 4 CARD32 minor version + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 major version + 4 CARD32 minor version + 16 unused +└─── + +┌─── + DRI2Connect + 1 CARD8 major opcode + 1 1 DRI2 opcode + 2 3 length + 4 WINDOW window + 4 CARD32 driver type + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 (n+m+p+q)/4 reply length + 4 n driver name length + 4 m device name length + 16 unused + n CARD8 driver name + p unused, p=pad(n) + m CARD8 device name + q unused, q=pad(m) +└─── + +┌─── + DRI2Authenticate + 1 CARD8 major opcode + 1 2 DRI2 opcode + 2 3 length + 4 WINDOW window + 4 CARD32 authentication token + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 authenticated + 20 unused +└─── + +┌─── + DRI2GetBuffers + 1 CARD8 major opcode + 1 5 DRI2 opcode + 2 3 length + 4 DRAWABLE drawable + 4 n number of attachments + 4n LISTofDRI2ATTACHMENTS attachments + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 width of drawable + 4 CARD32 height of drawable + 4 CARD32 buffer count + 12 unused + 5n LISTofDRI2BUFFER buffers +└─── + +┌─── + DRI2CopyRegion + 1 CARD8 major opcode + 1 6 DRI2 opcode + 2 3 length + 4 DRAWABLE drawable + 4 REGION region + 4 DRI2ATTACHMENT source + 4 DRI2ATTACHMENT destination + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 24 unused +└─── + +┌─── + DRI2GetBuffersWithFormat + 1 CARD8 major opcode + 1 7 DRI2 opcode + 2 3 length + 4 DRAWABLE drawable + 4 n number of attachments + 8n LISTofDRI2ATTACH_FORMAT attachments and formats + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 width of drawable + 4 CARD32 height of drawable + 4 CARD32 buffer count + 12 unused + 5n LISTofDRI2BUFFER buffers +└─── + +┌─── + DRI2SwapBuffers + 1 CARD8 major opcode + 1 8 DRI2 opcode + 2 8 length + 4 DRAWABLE drawable + 4 CARD32 target_msc_hi + 4 CARD32 target_msc_lo + 4 CARD32 divisor_hi + 4 CARD32 divisor_lo + 4 CARD32 remainder_hi + 4 CARD32 remainder_lo + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 swap_hi + 4 CARD32 swap_lo + 20 unused +└─── + +┌─── + DRI2GetMSC + 1 CARD8 major opcode + 1 9 DRI2 opcode + 2 8 length + 4 DRAWABLE drawable + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 ust_hi + 4 CARD32 ust_lo + 4 CARD32 msc_hi + 4 CARD32 msc_lo + 4 CARD32 sbc_hi + 4 CARD32 sbc_lo +└─── + +┌─── + DRI2WaitMSC + 1 CARD8 major opcode + 1 10 DRI2 opcode + 2 8 length + 4 DRAWABLE drawable + 4 CARD32 target_msc_hi + 4 CARD32 target_msc_lo + 4 CARD32 divisor_hi + 4 CARD32 divisor_lo + 4 CARD32 remainder_hi + 4 CARD32 remainder_lo + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 ust_hi + 4 CARD32 ust_lo + 4 CARD32 msc_hi + 4 CARD32 msc_lo + 4 CARD32 sbc_hi + 4 CARD32 sbc_lo +└─── + +┌─── + DRI2WaitSBC + 1 CARD8 major opcode + 1 11 DRI2 opcode + 2 8 length + 4 DRAWABLE drawable + 4 CARD32 swap_hi + 4 CARD32 swap_lo + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 ust_hi + 4 CARD32 ust_lo + 4 CARD32 msc_hi + 4 CARD32 msc_lo + 4 CARD32 sbc_hi + 4 CARD32 sbc_lo +└─── + +┌─── + DRI2SwapInterval + 1 CARD8 major opcode + 1 12 DRI2 opcode + 2 8 length + 4 DRAWABLE drawable + 4 CARD32 interval + ▶ +└─── + +┌─── + DRI2GetParam + 1 CARD8 major opcode + 1 13 DRI2 opcode + 2 8 length + 4 DRAWABLE drawable + 4 CARD32 param + ▶ + 1 1 Reply + 1 BOOL is_param_recognized + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 value_hi + 4 CARD32 value_lo + 16 unused +└─── + +A.3 Protocol Events + +The DRI2 extension specifies DRI2_BufferSwapComplete and +DRI2_InvalidateBuffers events. + +┌─── + DRI2_BufferSwapComplete + 1 CARD8 type + 1 CARD8 extension + 2 CARD16 sequenceNumber + 2 CARD16 event_type + 4 DRAWABLE drawable + 4 CARD32 ust_hi + 4 CARD32 ust_lo + 4 CARD32 msc_hi + 4 CARD32 msc_lo + 4 CARD32 sbc_hi + 4 CARD32 sbc_lo +└─── + + +┌─── + DRI2_InvalidateBuffers + 1 CARD8 type + 1 CARD8 extension + 2 CARD16 sequenceNumber + 4 DRAWABLE drawable + 4 CARD32 unused + 4 CARD32 unused + 4 CARD32 unused + 4 CARD32 unused + 4 CARD32 unused + 4 CARD32 unused +└─── + +A.4 Protocol Errors + +The DRI2 extension specifies no errors. + + + ⚙ ⚙ ⚙ ⚙ ⚙ ⚙ + + +Appendix B. Implementation on GEM + +Where to begin... diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/dri3proto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/dri3proto.txt new file mode 100644 index 0000000000000000000000000000000000000000..f1f74c482a1c07fa815b0a0ec10b9796371c668a --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/dri3proto.txt @@ -0,0 +1,762 @@ + The DRI3 Extension + Version 1.4 + 2021-11-30 + + Keith Packard + keithp@keithp.com + Intel Corporation + + Daniel Stone + daniels@collabora.com + Collabora + + +1. Introduction + +The DRI3 extension provides mechanisms to translate between direct +rendered buffers and X pixmaps. When combined with the Present extension, +a complete direct rendering solution for hardware-accelerated devices +such as GPUs is provided. + +The direct rendered buffers are passed across the protocol via +standard POSIX file descriptor passing mechanisms. On Linux, these +buffers are DMA-BUF objects. + +DRI3 also includes a mechanism to translate between Linux Futexes +and X Sync extension Fences. This provides a synchronization mechanism +which can be used to serialize access to shared render buffers. + +1.1. Acknowledgments + +Eric Anholt +Dave Airlie +Kristian Høgsberg +James Jones +Arthur Huillet +Louis-Francis Ratté-Boulianne +Austin Shafer + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +2. Data Types + +The DRI3 extension uses the RandR extension Provider data type to +select among multiple GPUs on a single screen and the Sync extension +fence object to provide graphics object synchronization. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +4. Errors + +DRI3 defines no errors. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +5. Events + +DRI3 defines no events. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +6. Protocol Types + +SYNCOBJ { XID } + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +7. Extension Initialization + +The name of this extension is "DRI3" + +┌─── + DRI3QueryVersion + client-major-version: CARD32 + client-minor-version: CARD32 + ▶ + major-version: CARD32 + minor-version: CARD32 +└─── + + The client sends the highest supported version to the server + and the server sends the highest version it supports, but no + higher than the requested version. Major versions changes can + introduce incompatibilities in existing functionality, minor + version changes introduce only backward compatible changes. + It is the clients responsibility to ensure that the server + supports a version which is compatible with its expectations. + + Backwards compatible changes included addition of new + requests. + + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +8. Extension Requests + +┌─── + DRI3Open + drawable: DRAWABLE + provider: PROVIDER + ▶ + nfd: CARD8 + device: FD +└─── + Errors: Drawable, Value, Match + + This requests that the X server open the direct rendering + device associated with drawable and RandR provider. The + provider must support SourceOutput or SourceOffload. + + The file descriptor for the device is returned in + 'device'. 'nfd' will be set to one (this is strictly a + convenience for XCB which otherwise would need + request-specific information about how many file descriptors + were associated with this reply). + +┌─── + DRI3PixmapFromBuffer + pixmap: PIXMAP + drawable: DRAWABLE + size: CARD32 + width, height, stride: CARD16 + depth, bpp: CARD8 + buffer: FD +└─── + Errors: Alloc, Drawable, IDChoice, Value, Match + + Creates a pixmap for the direct rendering object associated + with 'buffer' and the screen associated with 'drawable'. + Changes to pixmap will be visible in that direct rendered + object and changes to the direct rendered object will be + visible in the pixmap. + + 'size' specifies the total size of the buffer bytes. 'width', + 'height' describe the geometry (in pixels) of the underlying + buffer. 'stride' specifies the number of bytes per scanline in + the buffer. The pixels within the buffer are not required to + be arranged in a simple linear fashion, but 'size' will be at + least 'height' * 'stride'. + + Precisely how any additional information about the buffer is + shared is outside the scope of this extension. + + If buffer cannot be used with the screen associated with + drawable, a Match error is returned. + + If depth or bpp are not supported by the screen, a Value error + is returned. + + For information on synchronization of buffer access between + the client and the X server, please see section 12. + +┌─── + DRI3BufferFromPixmap + pixmap: PIXMAP + ▶ + nfd: CARD8 + size: CARD32 + width, height, stride: CARD16 + depth, bpp: CARD8 + buffer: FD +└─── + Errors: Pixmap, Match + + Pass back a direct rendering object associated with + pixmap. Changes to pixmap will be visible in that + direct rendered object and changes to the direct rendered + object will be visible in the pixmap. + + 'size' specifies the total size of the buffer bytes. 'width', + 'height' describe the geometry (in pixels) of the underlying + buffer. 'stride' specifies the number of bytes per scanline in + the buffer. The pixels within the buffer are not required to + be arranged in a simple linear fashion, but 'size' will be at + least 'height' * 'stride'. + + Precisely how any additional information about the buffer is + shared is outside the scope of this extension. + + If buffer cannot be used with the screen associated with + drawable, a Match error is returned. + + For information on synchronization of buffer access between + the client and the X server, please see section 12. + +┌─── + DRI3FenceFromFD + drawable: DRAWABLE + fence: FENCE + initially-triggered: BOOL + fd: FD +└─── + Errors: IDchoice, Drawable + + Creates a Sync extension Fence that provides the regular Sync + extension semantics along with a file descriptor that provides + a device-specific mechanism to manipulate the fence directly. + Details about the mechanism used with this file descriptor are + outside the scope of the DRI3 extension. + + For information on synchronization of buffer access between + the client and the X server, please see section 12. + +┌─── + DRI3FDFromFence + drawable: DRAWABLE + fence: FENCE + ▶ + fd: FD +└─── + Errors: IDchoice, Drawable, Match + + Given a Sync extension Fence that provides the regular Sync + extension semantics, returns a file descriptor that provides a + device-specific mechanism to manipulate the fence directly. + Details about the mechanism used with this file descriptor are + outside the scope of the DRI3 extension. 'drawable' must be + associated with a direct rendering device that 'fence' can + work with, otherwise a Match error results. + + For information on synchronization of buffer access between + the client and the X server, please see section 12. + +┌─── + DRI3GetSupportedModifiers + window: WINDOW + depth: CARD8 + bpp: CARD8 + ▶ + num_window_modifiers: CARD32 + num_screen_modifiers: CARD32 + window_modifiers: ListOfCARD64 + screen_modifiers: ListOfCARD64 +└─── + Errors: Window, Match + + Return supported DRM FourCC modifiers for the specified + 'window'. + + The first list of 'window_modifiers' contains a set of + modifiers which the server considers optimal for the window's + current configuration. Using these modifiers to allocate, even + if locally suboptimal to the client driver, may result in a + more optimal display pipeline, e.g. by avoiding composition. + + The second list of 'screen_modifiers', is the total set of + modifiers which are acceptable for use on the Screen associated + with 'window'. This set of modifiers will not change over the + lifetime of the client. Using this set of modifiers to allocate + may not result in a globally optimal pipeline, if separate + 'window_modifiers' are available. + + It is expected that a client calling this request will obtain + the modifiers for a particular window, allocate buffers using + the preferred modifier set as described above, create a Pixmap + referring to the storage of those buffers using the + DRI3BuffersFromPixmap request, then make the content visible + in the storage of those buffers visible with a request such as + the Present extension's PresentPixmap. + + The meaning of any modifier is canonically defined in + drm_fourcc.h. + +┌─── + DRI3PixmapFromBuffers + pixmap: PIXMAP + window: WINDOW + num_buffers: CARD8 + width, height: CARD16 + stride0, offset0: CARD32 + stride1, offset1: CARD32 + stride2, offset2: CARD32 + stride3, offset3: CARD32 + depth, bpp: CARD8 + modifier: CARD64 + buffers: ListOfFD +└─── + Errors: Alloc, Window, IDChoice, Value, Match + + Creates a pixmap for the direct rendering object associated + with 'buffers' and the screen associated with 'window'. + Changes to pixmap will be visible in that direct rendered + object and changes to the direct rendered object will be + visible in the pixmap. The pixmap will be available for + presentation to the window. + + In contrast to PixmapFromBuffer, multiple buffers may be + combined to specify a single logical source for pixel + sampling: 'num_buffers' may be set from 1 (single buffer, + akin to PixmapFromBuffer) to 4. This is the number of file + descriptors which will be sent with this request; one per + buffer. + + Modifiers allow explicit specification of non-linear sources, + such as tiled or compressed buffers. The combination of bpp, + depth, and modifier allows unambiguous declaration of the + buffer layout in a manner defined by the DRM tokens. + + If 'modifier' is DRM_FORMAT_MOD_INVALID, the client does + not have information on the buffer layout. In this case, the + buffer may only have a single plane. The driver may make its + own inference through unspecified means to determine the exact + buffer layout, however this is neither required nor defined + by the specification, and is considered an implementation + detail of the particular driver. + + 'width' and 'height' describe the geometry (in pixels) of the + logical pixel-sample source. + + 'strideN' and 'offsetN' define the number of bytes per logical + scanline, and the distance in bytes from the beginning of the + buffer passed for that plane until the start of the sample + source for that plane, respectively for plane N. If the plane + is not used according to the format and modifier specification, + both values for that plane must be zero. + + Precisely how any additional information about the buffer (such + as memory placement) is shared is outside the scope of this + extension. + + If the buffer(s) cannot be used with the screen associated with + 'window', a Match error is returned. + + If the bpp, depth, and modifier combination is not supported by + the screen, a Value error is returned. + + For information on synchronization of buffer access between + the client and the X server, please see section 12. + +┌─── + DRI3BuffersFromPixmap + pixmap: PIXMAP + ▶ + nfd: CARD8 + width, height: CARD16 + depth, bpp: CARD8 + modifier: CARD64 + strides: ListOfCARD32 + offsets: ListOfCARD32 + buffers: ListOfFD +└─── + Errors: Pixmap, Match + + Returns direct rendering objects associated with 'pixmap'. + Changes to 'pixmap' will be visible in the direct rendered + objects and changes to the direct rendered objects will be + visible in 'pixmap' after flushing and synchronization. + + 'width' and 'height' describe the geometry (in pixels) of the + logical pixel-sample source from combining the direct rendering + objects. + + See PixmapFromBuffers for more details on DRM modifiers usage. + + 'nfd' describes the number of buffers returned for the pixmap, + which must be combined together according to 'depth', 'bpp', and + 'modifier'. + + For each buffer, there is an entry in the 'strides', + 'offsets', and 'buffers' list. 'buffer' contains a single file + descriptor referring to the buffer. 'stride' specifies the + number of bytes per logical scanline for this plane, and + 'offset' specifies the distance in bytes from the beginning + of 'buffer' until the start of the sample source for that + plane. + + Precisely how any additional information about the buffer is + shared is outside the scope of this extension. + + If buffers cannot be exported from the the screen associated + with 'pixmap', a Match error is returned. + + For information on synchronization of buffer access between + the client and the X server, please see section 12. + +┌─── + DRI3SetDRMDeviceInUse + window: WINDOW + drmMajor: CARD32 + drmMinor: CARD32 +└─── + Errors: Window + + This request provides a hint to the server about the device + in use by this window. This is used to provide + DRI3GetSupportedModifiers with a hint of what device to + return modifiers for in the window_modifiers return value. + Using this hint allows for device-specific modifiers to + be returned by DRI3GetSupportedModifiers, for example + when an application is renderoffloaded and eligible for + direct scanout. + + This is only a hint, and may or may not be reflected in + the modifier list returned. + + If the window specified was not found, a Window error will + be returned. + + +┌─── + DRI3ImportSyncobj + syncobj: SYNCOBJ + drawable: DRAWABLE + fd: FD +└─── + Errors: IDchoice, Drawable + + Imports the DRM synchronization object bound to the given 'fd'. This + may then be used to enable explicit synchronization with the + server-side direct rendering device associated with 'drawable'. + + The provided syncobj must be a timeline syncobj. + + If 'drawable' is not found, a Drawable error will be returned. + + +┌─── + DRI3FreeSyncobj + syncobj: SYNCOBJ +└─── + Errors: Value + + Indicates that any resources associated with the given 'syncobj' should + be released by the server. The actual release may be deferred until any + pending operations that depend on the object have completed. + + If 'syncobj' is not found, a Value error will be returned. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +9. Extension Events + +DRI3 defines no events. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +10. Extension Versioning + +The DRI3 extension is adapted from the DRI2 extension. + + 1.0: First published version + + 1.1: Cosmetic changes + + 1.2: Add GetSupportedModifiers, + PixmapFromBuffers, and BuffersFromPixmap requests. + + 1.3: Add SetDRMDeviceInUse + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + + +11. Relationship with other extensions + +As an extension designed to support other extensions, there is +naturally some interactions with other extensions. + +11.1 GLX + +GLX is both an application interface and an X extension. OpenGL +applications using the GLX API will use the GLX extension, DRI3 and +Present when doing direct rendering. + +11.2 Present + +The Present extension provides a way to synchronize the display of pixmap +contents to the screen. When used in conjunction with DRI3, they +provide a complete direct rendering solution for OpenGL or other APIs. + +11.3 DRI2 + +DRI3 provides similar functionality to the DRI2Connect and +DRI2GetBuffersWithFormat requests, however DRI3 uses file descriptors +to refer to the direct rendering device and buffers. + +Present and DRI3 are designed in conjunction to replace DRI2 + +11.2 XvMC / Xv + +It might be nice to be able to reference YUV formatted direct rendered +objects from the X server. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +12. Synchronization + +Synchronization of access to buffers shared between processes is not +currently explicitly controlled by this protocol. + +Without the use of additional extensions not defined by the DRI3 +protocol as of version 1.2, synchronization between multiple +processes and contexts is considered to follow the implicit model. + +In this model, the driver is required to have a global view of +access requests issued by all processes with a reference to the +buffer, and control scheduling of all operations on that buffer, +whether performed by the CPU or auxiliary hardware. + +The driver is responsible for enforcing a strict ordering to protect +against write-after-read or read-after-write hazards, such that any +reads requested by one process or context, are fulfilled before any +writes requested by another process or context, as long as that read +was definitively submitted before the write. + +A similar dependency exists for reads submitted after writes: the +driver must ensure that the write is fully visible and coherent to +the read request. + +As a purely illustrative example, if two processes share a buffer, +where one process reads from a buffer using an OpenGL texture +sampler and submits this work by calling 'glFlush', and the other +process submits work to the driver to write to that buffer, the +driver is responsible for ensuring that the results of the latter +write are not visible to the texture sampler. + +The Sync fences provided by DRI3 control only this submission of +work and ensuing global visibility of the requests, rather than the +completion of the work within any hardware. To further the example +above, a fence used to prevent any writes to the buffer before the +sampler had completed access, the fence would be signaled when +'glFlush' had been called, at which point the request has become +globally visible to the driver's request-scheduling and +synchronization mechanisms. The logical ordering of requests made +by software has been preserved, and the driver then takes care +to ensure that these requests are scheduled such they do not +observe effects from requests made later in time. + +This presents a fully coherent in-order FIFO-like model across +processes, where synchronzation is handled externally to the DRI3 +client with no explicit intervention. + +This restriction also applies for cross-device usage. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +Appendix A. Protocol Encoding + +Syntactic Conventions + +This document uses the same syntactic conventions as the core X +protocol encoding document. + + +A.1 Common Types + +None. + +A.2 Protocol Requests + +┌─── + DRI3QueryVersion + 1 CARD8 major opcode + 1 0 DRI3 opcode + 2 3 length + 4 CARD32 major version + 4 CARD32 minor version + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 major version + 4 CARD32 minor version + 16 unused +└─── + + +┌─── + DRI3Open + 1 CARD8 major opcode + 1 1 DRI3 opcode + 2 4 length + 4 DRAWABLE drawable + 4 PROVIDER provider + ▶ + 1 1 Reply + 1 1 nfd + 2 CARD16 sequence number + 4 0 reply length + 24 unused + + 0 FD device +└─── + +┌─── + DRI3PixmapFromBuffer + 1 CARD8 major opcode + 1 2 DRI3 opcode + 2 6 length + 4 Pixmap pixmap + 4 Drawable drawable + 4 CARD32 size + 2 CARD16 width + 2 CARD16 height + 2 CARD16 stride + 1 CARD8 depth + 1 CARD8 bpp + + 0 FD buffer +└─── + +┌─── + DRI3BufferFromPixmap + 1 CARD8 major opcode + 1 3 DRI3 opcode + 2 2 length + 4 Pixmap pixmap + ▶ + 1 1 Reply + 1 1 nfd + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 size + 2 CARD16 width + 2 CARD16 height + 2 CARD16 stride + 1 CARD8 depth + 1 CARD8 bpp + 12 unused + + 0 FD buffer +└─── + +┌─── + DRI3FenceFromFD + 1 CARD8 major opcode + 1 4 DRI3 opcode + 2 4 length + 4 Drawable drawable + 4 Fence fence + 1 BOOL initially triggered + 3 unused + + 0 FD fence fd +└─── + +┌─── + DRI3FDFromFence + 1 CARD8 major opcode + 1 5 DRI3 opcode + 2 3 length + 4 Drawable drawable + 4 Fence fence + ▶ + 1 1 Reply + 1 1 nfd + 2 CARD16 sequence number + 4 0 reply length + 24 unused + + 0 FD fence fd +└─── + +┌─── + DRI3GetSupportedModifiers + 1 CARD8 major opcode + 1 6 DRI3 opcode + 2 3 length + 4 Window window + 1 CARD8 depth + 1 CARD8 bpp + 2 unused + ▶ + 1 1 Reply + 1 0 unused + 2 CARD16 sequence number + 4 CARD32 reply length + 4 CARD32 num_window_modifiers + 4 CARD32 num_screen_modifiers + 16 unused + + 4 ListOfCARD64 window_modifiers[num_window_modifiers] + 4 ListOfCARD64 screen_modifiers[num_screen_modifiers] +└─── + +┌─── + DRI3PixmapFromBuffers + 1 CARD8 major opcode + 1 7 DRI3 opcode + 2 8 length + 4 Pixmap pixmap + 4 Window window + 1 CARD8 num_buffers + 3 unused + 2 CARD16 width + 2 CARD16 height + 4 CARD32 stride0 + 4 CARD32 offset0 + 4 CARD32 stride1 + 4 CARD32 offset1 + 4 CARD32 stride2 + 4 CARD32 offset2 + 4 CARD32 stride3 + 4 CARD32 offset3 + 1 CARD8 depth + 1 CARD8 bpp + 2 unused + 8 CARD64 modifier + + 0 ListOfFD buffers[num_buffers] +└─── + +┌─── + DRI3BuffersFromPixmap + 1 CARD8 major opcode + 1 8 DRI3 opcode + 2 2 length + 4 Pixmap pixmap + ▶ + 1 1 Reply + 1 CARD8 nfd + 2 CARD16 sequence number + 4 CARD32 reply length + 2 CARD16 width + 2 CARD16 height + 4 CARD8 unused + 8 CARD64 modifier + 1 CARD8 depth + 1 CARD8 bpp + 6 unused + + 0 ListOfFD buffer[nfd] + 4 ListOfCARD32 strides[nfd] + 4 ListOfCARD32 offsets[nfd] +└─── + +┌─── + DRI3SetDRMDeviceInUse + 1 CARD8 major opcode + 1 9 DRI3 opcode + 2 4 length + 4 Window window + 4 CARD32 drmMajor + 4 CARD32 drmMinor +└─── + +┌─── + DRI3ImportSyncobj + 1 CARD8 major opcode + 1 11 DRI3 opcode + 2 3 length + 4 SYNCOBJ syncobj + 4 Drawable drawable + 0 FD syncobj fd +└─── + +┌─── + DRI3FreeSyncobj + 1 CARD8 major opcode + 1 12 DRI3 opcode + 2 2 length + 4 SYNCOBJ syncobj +└─── + +A.3 Protocol Events + +The DRI3 extension defines no events. + +A.4 Protocol Errors + +The DRI3 extension defines no errors. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/fixesproto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/fixesproto.txt new file mode 100644 index 0000000000000000000000000000000000000000..f462606d6fd00408fa4aaa37265ff3ffadad8291 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/fixesproto.txt @@ -0,0 +1,734 @@ + The XFIXES Extension + Version 6.1 + Document Revision 1 + 2010-11-15 + Keith Packard + keithp@keithp.com + +1. Introduction + +X applications have often needed to work around various shortcomings in the +core X window system. This extension is designed to provide the minimal +server-side support necessary to eliminate problems caused by these +workarounds. + +2. Acknowledgements + +This extension is a direct result of requests made by application +developers, in particular, + + + Owen Taylor for describing the issues raised with the XEMBED + mechanisms and SaveSet processing and his initial extension + to handle this issue, and for pointer barriers + + + Bill Haneman for the design for cursor image tracking. + + + Havoc Pennington + + + Fredrik Höglund for cursor names + + + Deron Johnson for cursor visibility + +3. Basic Premise + +Requests in this extension may seem to wander all over the map of X server +capabilities, but they are tied by a simple rule -- resolving issues raised +by application interaction with core protocol mechanisms that cannot be +adequately worked around on the client side of the wire. + +4. Extension initialization + +The client must negotiate the version of the extension before executing +extension requests. Behavior of the server is undefined otherwise. + +QueryVersion + + client-major-version: CARD32 + client-minor-version: CARD32 + + -> + + major-version: CARD32 + minor-version: CARD32 + + The client sends the highest supported version to the server and + the server sends the highest version it supports, but no higher than + the requested version. Major versions changes can introduce + new requests, minor version changes introduce only adjustments to + existing requests or backward compatible changes. It is + the clients responsibility to ensure that the server supports + a version which is compatible with its expectations. + +************* XFIXES VERSION 1 OR BETTER *********** + +5. Save Set processing changes + +Embedding one application within another provides a way of unifying +disparate documents and views within a single framework. From the X +protocol perspective, this appears similar to nested window managers; the +embedding application "manages" the embedded windows much as a window +manager does for top-level windows. To protect the embedded application +from embedding application failure, it is reasonable to use the core SaveSet +mechanism so that embedding application failure causes embedded windows to +be preserved instead of destroyed. + +The core save set mechanism defines the target for each save set member +window as the nearest enclosing window not owned by the terminating client. +For embedding applications, this nearest window is usually the window +manager frame. The problem here is that the window manager will not +generally expect to receive and correctly manage new windows appearing within +that window by the save set mechanism, and will instead destroy the frame +window in response to the client window destruction. This causes the +embedded window to be destroyed. + +An easy fix for this problem is to change the target of the save set member +to a window which won't be affected by the underlying window destruction. +XFIXES chooses the root window as the target. + +Having embedded windows suddenly appear at the top level can confuse users, +so XFIXES also lets the client select whether the window should end up +unmapped after the save set processing instead of unconditionally making +them be mapped. + +5.1 Requests + +ChangeSaveSet + + window: Window + mode: { Insert, Delete } + target: { Nearest, Root } + map: { Map, Unmap } + + ChangeSaveSet is an extension of the core protocol ChangeSaveSet + request. As in that request, mode specifies whether the indicated + window is inserted or deleted from the save-set. Target specifies + whether the window is reparented to the nearest non-client window as + in the core protocol, or reparented to the root window. Map + specifies whether the window is mapped as in the core protocol or + unmapped. + +6. Selection Tracking + +Applications wishing to monitor the contents of current selections must +poll for selection changes. XFIXES improves this by providing an event +delivered whenever the selection ownership changes. + +6.1 Types + + SELECTIONEVENT { SetSelectionOwner, + SelectionWindowDestroy, + SelectionClientClose } + +6.1 Events + +SelectionNotify + + subtype: SELECTIONEVENT + window: Window + owner: Window + selection: Atom + timestamp: Timestamp + selection-timestamp: Timestamp + +6.2 Requests + +SelectSelectionInput + + window: Window + selection: Atom + event-mask: SETofSELECTIONEVENT + + Selects for events to be delivered to window when various causes of + ownership of selection occur. Subtype indicates the cause of the + selection ownership change. Owner is set to the current selection + owner, or None. Timestamp indicates the time the event was + generated while selection-timestamp indicates the timestamp used to + own the selection. + +7. Cursor Image Monitoring + +Mirroring the screen contents is easily done with the core protocol or VNC +addons, except for the current cursor image. There is no way using the core +protocol to discover which cursor image is currently displayed. The +cursor image often contains significant semantic content about the user +interface. XFIXES provides a simple mechanism to discover when the cursor +image changes and to fetch the current cursor image. + +As the current cursor may or may not have any XID associated with it, there +is no stable name available. Instead, XFIXES returns only the image of the +current cursor and provides a way to identify cursor images to avoid +refetching the image each time it changes to a previously seen cursor. + +7.1 Types + CURSOREVENT { DisplayCursor } + +7.2 Events + +CursorNotify + + subtype: CURSOREVENT + window: Window + cursor-serial: CARD32 + timestamp: Timestamp + name: Atom (Version 2 only) + +7.3 Requests + +SelectCursorInput + + window: Window + event-mask: SETofCURSOREVENT + + This request directs cursor change events to the named window. + Events will be delivered irrespective of the screen on which they + occur. Subtype indicates the cause of the cursor image change + (there is only one subtype at present). Cursor-serial is a number + assigned to the cursor image which identifies the image. Cursors + with different serial numbers may have different images. Timestamp + is the time of the cursor change. + + Servers supporting the X Input Extension Version 2.0 or higher only + notify the clients of cursor change events for the ClientPointer, not + of any other master pointer (see Section 4.4. in the XI2 protocol + specification). + +GetCursorImage + + -> + + x: INT16 + y: INT16 + width: CARD16 + height: CARD16 + x-hot: CARD16 + y-hot: CARD16 + cursor-serial: CARD32 + cursor-image: LISTofCARD32 + + GetCursorImage returns the image of the current cursor. X and y are + the current cursor position. Width and height are the size of the + cursor image. X-hot and y-hot mark the hotspot within the cursor + image. Cursor-serial provides the number assigned to this cursor + image, this same serial number will be reported in a CursorNotify + event if this cursor image is redisplayed in the future. + + The cursor image itself is returned as a single image at 32 bits per + pixel with 8 bits of alpha in the most significant 8 bits of the + pixel followed by 8 bits each of red, green and finally 8 bits of + blue in the least significant 8 bits. The color components are + pre-multiplied with the alpha component. + +************* XFIXES VERSION 2 OR BETTER *********** + +8. Region Objects + +The core protocol doesn't expose regions as a primitive object and this +makes many operations more complicated than they really need to be. Adding +region objects simplifies expose handling, the Shape extension and other +operations. These operations are also designed to support a separate +extension, the X Damage Extension. + +8.1 Types + + Region: XID + WINDOW_REGION_KIND: { Bounding, Clip } + +8.2 Errors + + Region The specified region is invalid + +8.3 Requests + +CreateRegion + + region: REGION + rects: LISTofRECTANGLE + + Creates a region initialized to the specified list of rectangles. + The rectangles may be specified in any order, their union becomes + the region. The core protocol allows applications to specify an + order for the rectangles, but it turns out to be just as hard to + verify the rectangles are actually in that order as it is to simply + ignore the ordering information and union them together. Hence, + this request dispenses with the ordering information. + + Errors: IDChoice + +CreateRegionFromBitmap + + region: REGION + bitmap: PIXMAP + + Creates a region initialized to the set of 'one' pixels in bitmap + (which must be depth 1, else Match error). + + Errors: Pixmap, IDChoice, Match + +CreateRegionFromWindow + + window: Window + kind: WINDOW_REGION_KIND + region: Region + + Creates a region initialized to the specified window region. See the + Shape extension for the definition of Bounding and Clip regions. + + Errors: Window, IDChoice, Value + +CreateRegionFromGC + + gc: GContext + region: Region + + Creates a region initialized from the clip list of the specified + GContext. + + Errors: GContext, IDChoice + +CreateRegionFromPicture + + picture: Picture + region: Region + + + Creates a region initialized from the clip list of the specified + Picture. + + Errors: Picture, IDChoice + +DestroyRegion + + region: Region + + Destroys the specified region. + + Errors: Region + +SetRegion + + region: Region + rects: LISTofRECTANGLE + + This replaces the current contents of region with the region formed + by the union of rects. + +CopyRegion + source: Region + destination: Region + + This replaces the contents of destination with the contents of + source. + +UnionRegion +IntersectRegion +SubtractRegion + + source1: Region + source2: Region + destination: Region + + Combines source1 and source2, placing the result in destination. + Destination may be the same as either source1 or source2. + + Errors: Region, Value + +InvertRegion + + source: Region + bounds: RECTANGLE + destination: Region + + The source region is subtracted from the region specified by + bounds. The result is placed in destination, replacing its contents. + + Errors: Region + +TranslateRegion + + region: Region + dx, dy: INT16 + + The region is translated by dx, dy in place. + + Errors: Region + +RegionExtents + + source: Region + destination: Region + + The extents of the source region are placed in the destination + +FetchRegion + + region: Region + -> + extents: RECTANGLE + rectangles: LISTofRECTANGLE + + The region is returned as a list of rectangles in YX-banded order. + + Errors: Region + +SetGCClipRegion + + gc: GCONTEXT + clip-x-origin, clip-y-origin: INT16 + region: Region or None + + This request changes clip-mask in gc to the specified region and + sets the clip origin. Output will be clipped to remain contained + within the region. The clip origin is interpreted relative to the + origin of whatever destination drawable is specified in a graphics + request. The region is interpreted relative to the clip origin. + Future changes to region have no effect on the gc clip-mask. + + Errors: GContext, Region + +SetWindowShapeRegion + + dest: Window + destKind: SHAPE_KIND + xOff, yOff: INT16 + region: Region or None + + This request sets the specified (by destKind) Shape extension region + of the window to region, offset by xOff and yOff. Future changes to + region have no effect on the window shape. + + Errors: Window, Value, Region + +SetPictureClipRegion + + picture: Picture + clip-x-origin, clip-y-origin: INT16 + region: Region or None + + This request changes clip-mask in picture to the specified region + and sets the clip origin. Input and output will be clipped to + remain contained within the region. The clip origin is interpreted + relative to the origin of the drawable associated with picture. The + region is interpreted relative to the clip origin. Future changes + to region have no effect on the picture clip-mask. + + Errors: Picture, Region + +9. Cursor Names + +Attaching names to cursors permits some abstract semantic content to be +associated with specific cursor images. Reflecting those names back to +applications allows that semantic content to be related to the user through +non-visual means. + +9.1 Events + +CursorNotify + + subtype: CURSOREVENT + window: Window + cursor-serial: CARD32 + timestamp: Timestamp + name: Atom or None + + In Version 2 of the XFIXES protocol, this event adds the atom + of any name associated with the current cursor (else None). + +9.2 Requests + +SetCursorName + + cursor: CURSOR + name: LISTofCARD8 + + This request interns name as an atom and sets that atom as the name + of cursor. + + Errors: Cursor + +GetCursorName + + cursor: CURSOR + -> + atom: ATOM or None + name: LISTofCARD8 + + This request returns the name and atom of cursor. If no name is + set, atom is None and name is empty. + + Errors: Cursor + +GetCursorImageAndName + + -> + + x: INT16 + y: INT16 + width: CARD16 + height: CARD16 + x-hot: CARD16 + y-hot: CARD16 + cursor-serial: CARD32 + cursor-atom: ATOM + cursor-image: LISTofCARD32 + cursor-name: LISTofCARD8 + + This is similar to GetCursorImage except for including both + the atom and name of the current cursor. + +ChangeCursor + + source, destination: CURSOR + + This request replaces all references to the destination with a + reference to source. Any existing uses of the destination cursor + object will now show the source cursor image. + +ChangeCursorByName + + src: CURSOR + name: LISTofCARD8 + + This request replaces the contents of all cursors with the specified + name with the src cursor. + +************* XFIXES VERSION 3 OR BETTER *********** + +10. Region Expansion + +This update provides another operation on the region objects defined in +Section 8 of this document. + +10.1 Requests + +ExpandRegion + source: REGION + destination: REGION + left, right, top, bottom: CARD16 + + Creates destination region containing the area specified by + expanding each rectangle in the source region by the specified + number of pixels to the left, right, top and bottom. + +************* XFIXES VERSION 4 OR BETTER *********** + +11. Cursor Visibility + +Composite managers may want to render the cursor themselves instead of +relying on the X server sprite drawing, this provides a way for them to +do so without getting a double cursor image. + +11.1 Requests + +HideCursor + + window: WINDOW + + A client sends this request to indicate that it wants the + cursor image to be hidden (i.e. to not be displayed) when + the sprite is on the same screen as the specified window. + The sprite will be hidden if one or more clients have called + HideCursor and not ShowCursor. + + Note that even though cursor hiding causes the cursor image + to be invisible, CursorNotify events will still be sent + normally, as if the cursor image were visible. + + When a client with outstanding cursor hiding requests + terminates its connection these requests will be deleted. + + Servers supporting the X Input Extension Version 2.0 or higher hide + all visible cursors in response to a HideCursor request. If a master + pointer is created while the cursors are hidden, this master pointer's + cursor will be hidden as well. + +ShowCursor + + window: WINDOW + + A client sends this request to indicate that it wants the + cursor image to be displayed when the sprite is on the same + screen as the specified window. The sprite will be hidden + if one or more clients have called HideCursor and not ShowCursor. + + If the client has made no outstanding HideCursor requests + a BadMatch error is generated. + + Servers supporting the X Input Extension Version 2.0 or higher show + all visible cursors in response to a ShowCursor request. + +************* XFIXES VERSION 5 OR BETTER *********** + +12. Pointer Barriers + +Compositing managers and desktop environments may have UI elements in +particular screen locations such that for a single-headed display they +correspond to easy targets according to Fitt's Law, for example, the top +left corner. For a multi-headed environment these corners should still be +semi-impermeable. Pointer barriers allow the application to define +additional constraint on cursor motion so that these areas behave as +expected even in the face of multiple displays. + +Absolute positioning devices like touchscreens do not obey pointer barriers. +There's no advantage to target acquisition to do so, since on a touchscreen +all points are in some sense equally large, whereas for a relative +positioning device the edges and corners are infinitely large. + +WarpPointer and similar requests do not obey pointer barriers, for +essentially the same reason. + +12.1 Types + + BARRIER: XID + + BarrierDirections + + BarrierPositiveX: 1 << 0 + BarrierPositiveY: 1 << 1 + BarrierNegativeX: 1 << 2 + BarrierNegativeY: 1 << 3 + +12.2 Errors + + Barrier + +12.3 Requests + +CreatePointerBarrier + + barrier: BARRIER + window: Window + x1, y2, x2, y2: INT16 + directions: CARD32 + devices: LISTofDEVICEID + + Creates a pointer barrier along the line specified by the given + coordinates on the screen associated with the given window. The + barrier has no spatial extent; it is simply a line along the left + or top edge of the specified pixels. Barrier coordinates are in + screen space. + + The coordinates must be axis aligned, either x1 == x2, or + y1 == y2, but not both. The varying coordinates may be specified + in any order. For x1 == x2, either y1 > y2 or y1 < y2 is valid. + If the coordinates are not valid BadValue is generated. + + Motion is allowed through the barrier in the directions specified: + setting the BarrierPositiveX bit allows travel through the barrier + in the positive X direction, etc. Nonsensical values (forbidding Y + axis travel through a vertical barrier, for example) and excess set + bits are ignored. + + If the server supports the X Input Extension version 2 or higher, + the devices element names a set of master device to apply the + barrier to. If XIAllDevices or XIAllMasterDevices are given, the + barrier applies to all master devices. If a slave device is named, + BadDevice is generated; this does not apply to slave devices named + implicitly by XIAllDevices. Naming a device multiple times is + legal, and is treated as though it were named only once. If a + device is removed, the barrier continues to apply to the remaining + devices, but will not apply to any future device with the same ID + as the removed device. Nothing special happens when all matching + devices are removed; barriers must be explicitly destroyed. + + Errors: IDChoice, Window, Value, Device + +DestroyPointerBarrier + + barrier: BARRIER + + Destroys the named barrier. + + Errors: Barrier + +************* XFIXES VERSION 6 OR BETTER *********** + +13. Disconnect mode + +The X11 server is capable of terminating itself once all X11 clients are +gone. + +Yet, in a typical user session, there are a number of X11 clients running +continuously (e.g. Xsettings daemon, IBus, etc.). Those always-running +clients will prevent the X11 server from terminating, because the actual +number of X11 clients will never drop to 0. + +Disconnect mode allows the X11 clients themselves to specify that they +should not be accounted for when checking the remaining clients prior +to terminate the X11 server. + +This can be particularly useful for Wayland compositors which are able to +start Xwayland on demand, as this allows Xwayland to terminate automatically +when the relevant X11 clients have quit. + +13.1 Types + + XFixesClientDisconnectFlags + + XFixesClientDisconnectFlagDefault: 0 + XFixesClientDisconnectFlagTerminate: 1 << 0 + XFixesClientDisconnectFlagForceTerminate: 1 << 1 + + XFixesClientDisconnectFlagDefault is the default behavior for + regular clients: the X11 server won't terminate as long as such + clients are still connected and no other clients trigger + termination. + + XFixesClientDisconnectFlagTerminate indicates to the X11 server that + it can ignore the client and terminate itself even though the client + is still connected to the X11 server. + + If XFixesClientDisconnectFlagForceTerminate is set at the time the + client disconnects, the X11 server MUST terminate and/or reset without + delivering further events to clients, even if other clients that have + not set XFixesClientDisconnectFlagTerminate are still connected. + Screen lockers SHOULD use this flag to ensure that the screen does not + unlock if they exit, which would create a security vulnerability. + Programs SHOULD NOT use this flag unless unexpected termination would + create a security vulnerability or other severe problem. + + Because XFixesClientDisconnectFlagForceTerminate allows the client to + cause the server to terminate, it is subject to security checks to + prevent unauthorized use. Servers that support the X Access Control + Extension (XACE) MUST deny attempts to set + XFixesClientDisconnectFlagForceTerminate, unless the client has + DixManageAccess to the server. Servers that support the SECURITY + extension MUST forbid untrusted clients from setting + XFixesClientDisconnectFlagForceTerminate. Servers MAY refuse to allow + clients to set this flag for other reasons. For instance, a server + might only allow the flag to be set by local clients. If the server + refuses to allow the client to set this flag, an Access error results. + + XFixesClientDisconnectFlagForceTerminate is only available in XFixes + versions 6.1 and better. + +13.2 Requests + +SetClientDisconnectMode + + disconnect-mode: CARD32 + + Sets the disconnect mode for the client. + + The disconnect-mode is a bit mask of XFixesClientDisconnectFlags. + + +GetClientDisconnectMode + + Gets the disconnect mode for the client. + + -> + + disconnect-mode: CARD32 + + The disconnect-mode is a bit mask of XFixesClientDisconnectFlags. + + +99. Future compatibility + +This extension is not expected to remain fixed. Future changes will +strive to remain compatible if at all possible. The X server will always +support version 1 of the extension protocol if requested by a client. + +Additions to the protocol will always by marked by minor version number +changes so that applications will be able to detect what requests are +supported. diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/presentproto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/presentproto.txt new file mode 100644 index 0000000000000000000000000000000000000000..56c20d4d58f9d5aef3e9213e36045735ae26a2d3 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/presentproto.txt @@ -0,0 +1,931 @@ + The Present Extension + Version 1.4 + 2023-06-13 + + Keith Packard + keithp@keithp.com + Intel Corporation + +1. Introduction + +The Present extension provides a way for applications to update their +window contents from a pixmap in a well defined fashion, synchronizing +with the display refresh and potentially using a more efficient +mechanism than copying the contents of the source pixmap. + +1.1. Future Present extension versions + +This document includes speculation about future 'redirect' support +within the Present extension. All such information is subject to +change and is provided only as an aid to further Present development. + +1.2. Acknowledgments + +Eric Anholt +Owen Taylor +James Jones +Louis-Francis Ratté-Boulianne + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +2. Data Types + +PRESENTEVENTID { XID } + + Defines a unique event delivery target for Present + events. Multiple event IDs can be allocated to provide + multiple distinct event delivery contexts. + +PRESENTNOTIFY { + window: WINDOW + serial: CARD32 + } + + A list of these is passed to PresentPixmap; when the indicated + PresentPixmap completes, PresentCompletNotify events will be + delivered both to the PresentPixmap window/serial parameter as + well as each of the entries in the list of PRESENTNOTIFY parameter. + +PRESENTEVENTTYPE { PresentConfigureNotify, + PresentCompleteNotify, + PresentIdleNotify } + +PRESENTEVENTMASK { PresentConfigureNotifyMask, + PresentCompleteNotifyMask, + PresentIdleNotifyMask } + +PRESENTOPTION { PresentOptionAsync, + PresentOptionCopy, + PresentOptionUST, + PresentOptionSuboptimal, + PresentOptionAsyncMayTear } + +PRESENTCAPABILITY { PresentCapabilityAsync, + PresentCapabilityFence, + PresentCapabilityUST, + PresentCapabilityAsyncMayTear, + PresentCapabilitySyncobj } + +PRESENTCOMPLETEKIND { PresentCompleteKindPixmap, + PresentCompleteKindMSCNotify } + +PRESENTCOMPLETEMODE { PresentCompleteModeCopy, + PresentCompleteModeFlip, + PresentCompleteModeSkip, + PresentCompleteModeSuboptimalCopy } + +The Present extension also uses the Sync extension Fence data type to +provide synchronization for pixmaps. + +2.1. Data Types proposed for a later Present extension version + +PRESENTEVENTTYPE { ... + PresentRedirectNotify } + +PRESENTEVENTMASK { ... + PresentSubredirectNotifyMask } + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +3. Errors + +EventID + A value for an EventID argument does not name a defined EventID + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +5. Events + +ConfigureNotify events inform clients about window configuration +changes which can affect the allocation of window-related buffers. + +CompleteNotify events inform clients about the completion of a pending +PresentPixmap request. + +IdleNotify events inform clients when pixmaps are available for re-use. + +5.1. Events proposed for a later Present extension version + +RedirectNotify events inform clients about other clients PresentPixmap +requests. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +6. Extension Initialization + +The name of this extension is "Present" + +┌─── + PresentQueryVersion + client-major-version: CARD32 + client-minor-version: CARD32 + ▶ + major-version: CARD32 + minor-version: CARD32 +└─── + + The client sends the highest supported version to the server + and the server sends the highest version it supports, but no + higher than the requested version. Major versions changes can + introduce incompatibilities in existing functionality, minor + version changes introduce only backward compatible changes. + It is the clients responsibility to ensure that the server + supports a version which is compatible with its expectations. + + Backwards compatible changes include addition of new + requests. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +7. Extension Requests + +┌─── + PresentPixmap + window: WINDOW + pixmap: PIXMAP + serial: CARD32 + valid-area: REGION or None + update-area: REGION or None + x-off, y-off: INT16 + target-crtc: CRTC or None + wait-fence: FENCE + idle-fence: FENCE + options: SETofPRESENTOPTION + target-msc: CARD64 + divisor: CARD64 + remainder: CARD64 + notifies: LISTofPRESENTNOTIFY +└─── + Errors: Window, Pixmap, Match + + Provides new content for the specified window, to be made + visible at the specified time (defined by 'target-msc', 'divisor' + and 'remainder'). If the depth of 'pixmap' and 'window' do not + match, a Match error will be generated. + + 'serial' is an arbitrary client-specified value which will + be returned in the associated PresentCompleteNotify event so + that the client can associate the event and request. + + 'valid-area' defines the portion of 'pixmap' which contains + valid window contents, or None if the pixmap contains valid + contents for the whole window. + + 'update-area' defines the subset of the window to be updated, + or None if the whole window is to be updated. + + PresentPixmap may use any region of 'pixmap' which contains + 'update-area' and which is contained by 'valid-area'. In other + words, areas inside 'update-area' will be presented from + 'pixmap', areas outside 'valid-area' will not be presented + from 'pixmap' and areas inside 'valid-area' but outside + 'update-area' may or may not be presented at the discretion of + the X server. + + 'x-off' and 'y-off' define the location in the window where + the 0,0 location of the pixmap will be presented. valid-area + and update-area are relative to the pixmap. + + PresentPixmap will block until 'wait-fence' is triggered. + + When the X server has finished using 'pixmap' for this + operation, it will send a PresentIdleNotify event and arrange + for any 'idle-fence' to be triggered. This may be at any time + following the PresentPixmap request -- the contents may be + immediately copied to another buffer, copied just in time for + the vblank interrupt or the pixmap may be used directly for + display (in which case it will be busy until some future + PresentPixmap operation). + + If 'idle-fence' is not None, then the client guarantees to the + X server that it will wait for that fence to be signalled + before it uses the pixmap again. If 'idle-fence' is None, then + the X server must arrange for the pixmap to be re-usable by + the client as soon as the PresentIdleNotify event has been + received. Note that if PresentCapabilityFence is set for the + associated CRTC, then clients should use fences to improve + overall system performance. If PresentCapabilityFence is not + set, then using fences offers no benefit, but also no cost. + + If 'target-msc' is greater than the current msc for 'window', + the presentation will occur at (or after) the 'target-msc' + field. Otherwise, the presentation will occur after the next + field where msc % 'divisor' == 'remainder'. + + If 'target-crtc' is None, then the X server will choose a + suitable CRTC for synchronization. + + If 'options' contains PresentOptionAsync, and the 'target-msc' + is less than or equal to the current msc for 'window', then + the operation will be performed as soon as possible, not + necessarily waiting for the next vertical blank interval. If + the target-crtc does not support PresentCapabilityAsyncMayTear, + this may result in tearing. + + If the target-crtc supports PresentCapabilityAsyncMayTear, + 'options' contains PresentOptionAsyncMayTear, and the 'target-msc' + is less than or equal to the current msc for 'window', then + the operation will be performed as soon as possible, not + necessarily waiting for the next vertical blank interval, and + possibly resulting in tearing. + + If 'options' contains PresentOptionCopy, then 'pixmap' will be + idle, and 'idle-fence' triggered as soon as the operation occurs. + + If 'options' contains PresentOptionUST, then target-msc, + divisor and remainder will all be interpreted as UST values + instead of MSC values and the frame update will be scheduled + for the specified UST time, If the target-crtc supports + PresentCapabilityUST, then the swap time will be as close to + the target time as the driver can manage. Otherwise, the + server will take the target UST time and convert it to a + suitable target MSC value. + + If 'options' contains PresentOptionSuboptimal, then the + PresentCompleteNotify event can have mode + PresentCompleteModeSuboptimalCopy as the client supports it. + + After the presentation occurs, a PresentCompleteNotify event + with kind PresentCompleteKindPixmap will be generated, both to + 'window' as well as all members of 'notifies'. + + If 'window' is destroyed before the presentation occurs, then + the presentation action will not be completed. + + PresentPixmap holds a reference to 'pixmap' until the + presentation occurs, so 'pixmap' may be immediately freed + after the request executes, even if that is before the + presentation occurs. + + If 'idle-fence' is destroyed before the presentation occurs, + then idle-fence will not be signaled but the presentation will + occur normally. + + If 'wait-fence' is destroyed before it becomes triggered, then + the presentation operation will no longer wait for it and will + occur when the other conditions are satisfied. + +┌─── + PresentNotifyMSC + window: WINDOW + serial: CARD32 + target-msc: CARD64 + divisor: CARD64 + remainder: CARD64 +└─── + Errors: Window + + Delivers a PresentCompleteNotifyEvent with kind + PresentCompleteKindNotifyMSC after the time specified by + 'target-msc', 'divisor' and 'remainder'. + + 'serial' is an arbitrary client-specified value which will be + returned in the event so that the client can associate the + event and request. + + If 'target-msc' is greater than the current msc for 'window', + the event will be delivered at (or after) the 'target-msc' + field. Otherwise, the event delivery will occur after the next + field where msc % 'divisor' == 'remainder'. + + If 'window' is destroyed before the event is delivered, then + the event delivery will not be completed. + +┌─── + PresentSelectInput + event-id: PRESENTEVENTID + window: WINDOW + eventMask: SETofPRESENTEVENT +└─── + Errors: Window, Value, Match, IDchoice, Access + + Selects the set of Present events to be delivered for the + specified window and event context. PresentSelectInput can + create, modify, or delete event contexts. An event context is + associated with a specific window; using an existing event + context with a different window generates a Match error. + + If eventContext specifies an existing event context, then if + eventMask is empty, PresentSelectInput deletes the specified + context, otherwise the specified event context is changed to + select a different set of events. + + If eventContext is an unused XID, then if eventMask is empty + no operation is performed. Otherwise, a new event context is + created selecting the specified events. + +┌─── + PresentQueryCapabilities + target: CRTC or WINDOW + ▶ + capabilities: SETofPRESENTCAPABILITY +└─── + Errors: Window, CRTC + + Returns the supported capabilities for the target CRTC. If + 'target' is a CRTC, then it is used as the target CRTC. If + 'target' is a WINDOW, then the target CRTC is selected by the + X server from among the CRTCs on the screen specified by the window. + + PresentCapabilityAsyncMayTear means that the target device may be + able to flip the scanout buffer mid-frame instead of waiting for + a vertical blank interval. The precise latency between the flip + request and the actual scanout transition is not defined by this + specification, but is intended to be no more than a few + scanlines. + + If PresentCapabilityAsyncMayTear is not supported, + PresentCapabilityAsync means the same as + PresentCapabilityAsyncMayTear described above. + + If PresentCapabilityAsyncMayTear is supported, + PresentCapabilityAsync means that even if there is already a flip + pending in the target device, it may be possible to replace that + flip before the next vertical blank interval. The scanout buffer + does not change mid-frame though, i.e. there is no tearing. + + PresentCapabilityFence means that the target device can take + advantage of SyncFences in the Present operations to improve + GPU throughput. The driver must operate correctly in the + absence of fences, but may have reduced performance. Using + fences for drivers not advertising this capability should have + no performance impact. + + PresentCapabilityUST means that the target device can scanout + the image at an arbitrary UST time value, and is not driven by + a periodic scanout timer. Applications specifying UST times + for PresentPixmap can expect that their image will appear to + the user within a short amount of time from that specified in + the request. The precise accuracy of the scanout time is not + defined by the extension, but is expected to be on the order + of milliseconds or less. + + PresentCapabilitySyncobj means that the target device supports + explicit synchronization using timeline DRM synchronization + objects. See the PresentPixmapSynced request for details. + +┌─── + PresentPixmapSynced + window: WINDOW + pixmap: PIXMAP + serial: CARD32 + valid-area: REGION or None + update-area: REGION or None + x-off, y-off: INT16 + target-crtc: CRTC or None + acquire-syncobj: SYNCOBJ or None + release-syncobj: SYNCOBJ or None + acquire-point: CARD64 + release-point: CARD64 + options: SETofPRESENTOPTION + target-msc: CARD64 + divisor: CARD64 + remainder: CARD64 + notifies: LISTofPRESENTNOTIFY +└─── + Errors: Window, Pixmap, Match, Value + + Identical to the PresentPixmap request, except that instead of the + 'wait-fence' and 'idle-fence' arguments it accepts mandatory + 'acquire-syncobj' and 'release-syncobj' arguments, along with + corresponding acquire and release points, to be used for explicit + timeline-based GPU synchronization. The 'acquire-point' and + 'release-point' are assumed to correspond to timeline points on the + respective DRM syncobjs. + + The contents of the Pixmap will not be accessed by the server until the + 'acquire-point' on the acquire timeline has been signaled by the + client. The fence need not be submitted at the time the + PresentPixmapSynced request is issued. + + Once the 'release-point' on the release timeline has been signaled, the + client may assume that no further GPU or CPU access to the Pixmap by + the server will occur as part of the originating PresentPixmapSynced + request. Note that this is a stronger guarantee than what is provided + by the 'idle-fence' argument of the PresentPixmap request or the + delivery of a PresentIdleNotify event, as those do not necessarily + imply that the Pixmap is idle on the GPU. + + The server may wait for the acquire point and signal the release point + itself, as will typically happen if the request is executed by copying + the Pixmap's contents. Alternatively, it may forward the timelines, + acquire, and release points to an output sink directly, provided that + sink also supports explicit synchronization using DRM syncobjs. + + The server may signal the release point without waiting for the acquire + point if the Pixmap's contents are never accessed while servicing the + request. This may happen, for example, if a request is discarded due to + it being fully occluded by a later request. + + Beware that, if multiple Pixmaps are presented using the same release + timeline, the server makes no guarantees on the order in which the + release points will be signaled. Of particular concern is that, if the + later of the two release points is signaled before the earlier one, it + may appear to the client as though the Pixmap with the earlier release + point has been released before the server has finished its access to + it. Therefore, in general, clients are strongly advised to avoid using + the same release timeline with different Pixmaps. + + If the server does not support PresentCapabilitySyncobj, a Value error + is generated. + + If either 'acquire-syncobj' or 'release-syncobj' are None or do not + refer to previously imported syncobjs, a Value error is generated. + + If 'acquire-point' or 'release-point' is zero, a Value error is + generated. + + If 'acquire-syncobj' is equal to 'release-syncobj' and 'acquire-point' + is greater than or equal to 'release-point', a Value error is + generated. + + +7.1 Requests proposed for a later Present extension version + + These are not part of the standard and represent future plans + for the Present extension. + +┌─── + PresentSelectInput + ... +└─── + ... + + Specifying PresentSubredirectNotify Mask causes PresentPixmap + requests on any child of 'window' from other clients to + generate PresentRedirectNotify events to 'window' instead of + actually performing the operation. However, only one client at + a time can select for PresentRedirect on a window. An attempt + to violate this restriction results in an Access error. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +8. Extension Events + +┌─── + PresentConfigureNotify + type: CARD8 XGE event type (35) + extension: CARD8 Present extension request number + sequence-number: CARD16 + length: CARD32 2 + evtype: CARD16 Present_ConfigureNotify + eventID: PRESENTEVENTID + window: WINDOW + x: INT16 + y: INT16 + width: CARD16 + height: CARD16 + off_x: INT16 + off_y: INT16 + pixmap_width: CARD16 + pixmap_height: CARD16 + pixmap_flags: CARD32 +└─── + + PresentConfigureNotify events are sent when the window + configuration changes if PresentSelectInput has requested + it. PresentConfigureNotify events are XGE events and so do not + have a unique event type. + + 'x' and 'y' are the parent-relative location of 'window'. + +┌─── + PresentCompleteNotify + type: CARD8 XGE event type (35) + extension: CARD8 Present extension request number + sequence-number: CARD16 + length: CARD32 2 + evtype: PRESENTEVENTTYPE PresentCompleteNotify + eventID: PRESENTEVENTID + window: WINDOW + kind: PRESENTCOMPLETEKIND + mode: PRESENTCOMPLETEMODE + serial: CARD32 + ust: CARD64 + msc: CARD64 +└─── + + CompleteNotify events are delivered when a PresentPixmap or + PresentNotifyMSC operation has completed. + + 'kind' is PresentCompleteKindPixmap when generated by a + PresentPixmap operation completion or + PresentCompleteKindNotifyMsc when generated by a + PresentNotifyMSC operation completion. + + 'mode' is PresentCompleteModeCopy when the source pixmap + contents are taken from the pixmap and the pixmap is idle + immediately after the presentation completes. 'mode' is + PresentCompleteModeSuboptimalCopy when the source pixmap + contents are copied but it would be possible to flip the + pixmap if the buffer format/modifier was different (options + given to PresentPixmap must contain PresentOptionSuboptimal). + 'mode' is PresentCompleteModeFlip when the pixmap remains in-use + even after the presentation completes. It will become idle no + later than when the next PresentPixmap operation targeting the + same window by any client completes. If the presentation + operation was skipped because some later operation made it + irrelevant, then 'mode' will be PresentCompleteModeSkip. + + 'serial' is the value provided in the generating PresentPixmap + request. + + 'msc' and 'ust' indicate the frame count and system time when + the presentation actually occurred. + +┌─── + PresentIdleNotify + type: CARD8 XGE event type (35) + extension: CARD8 Present extension request number + sequence-number: CARD16 + length: CARD32 0 + evtype: PRESENTEVENTTYPE PresentIdleNotify + eventID: PRESENTEVENTID + window: WINDOW + serial: CARD32 + pixmap: PIXMAP + idle-fence: FENCE +└─── + + IdleNotify events are delivered when a pixmap used in a + PresentPixmap operation may be re-used by the client. + + 'window' is the window from the PresentPixmap to which this + event is delivered. + + 'serial' is the value provided in the associated PresentPixmap + request. + + 'pixmap' is the pixmap which is ready for re-use. + + 'idle-fence' is the fence which was provided in the + originating PresentPixmap request and is used to synchronize + rendering between the client and the X server's use of the + buffer. If not None, then the client must wait for the fence + to be signaled before using the pixmap. + +8.1. Extension Events proposed for a later Present extension version + +┌─── + PresentRedirectNotify + type: CARD8 XGE event type (35) + extension: CARD8 Present extension request number + sequence-number: CARD16 + length: CARD32 17 + 2 n + evtype: CARD16 Present_RedirectNotify + update-window: BOOL + + eventID: PRESENTEVENTID + event-window: WINDOW + window: WINDOW + pixmap: PIXMAP + serial: CARD32 + + valid-area: REGION + update-area: REGION + valid-rect: RECTANGLE + update-rect: RECTANGLE + x-off, y-off: INT16 + target-crtc: CRTC + wait-fence: FENCE + idle-fence: FENCE + options: SETofPRESENTOPTION + target-msc: CARD64 + divisor: CARD64 + remainder: CARD64 + notifies: LISTofPRESENTNOTIFY +└─── + + RedirectNotify events are delivered when the client has + selected for SubredirectNotify the parent of the target + window. All of the values provided to the PresentPixmap + request are provided. If the client simply passes these + parameters back to the X server, the effect will be as if the + original client executed the request. + + If 'update-window' is TRUE, then there are clients who have + requested composite automatic redirect on the window and who + presumably expect the window buffer to eventually contain + the application provided contents. The compositing manager + should at least occasionally update the window buffer with + suitable contents. The precise update interval is left to the + discretion of the client receiving this event. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +9. Extension Versioning + + 1.0: First published version + + 1.2: Added PresentCompleteModeSuboptimalCopy flag and + PresentOptionSuboptimal option + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + + +10. Relationship with other extensions + +As an extension designed to support other extensions, there is +naturally some interactions with other extensions. + +10.1 GLX + +GLX is both an application interface and an X extension. OpenGL +applications using the GLX API will use the GLX extension and may use +the Present extension to display application contents. + +10.2 DRI3 + +The DRI3 extension provides a way to share direct rendered pixel data +with the X server as X pixmaps. When used in conjunction with Present, +they provide a complete direct rendering solution for OpenGL or other +APIs. + +10.3 DRI2 + +Present provides similar functionality to the DRI2SwapBuffers and +requests, however Present uses X pixmaps to refer to the new window +contents instead of the DRI2 buffer attachments. + +Present and DRI3 are designed in conjunction to replace DRI2. + +10.4 XvMC / Xv + +It might be nice to be able to use YUV formatted objects as Present +sources. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +Appendix A. Protocol Encoding + +Syntactic Conventions + +This document uses the same syntactic conventions as the core X +protocol encoding document. + + +A.1 Common Types +┌─── + PresentEventType + 0 PresentConfigureNotify + 1 PresentCompleteNotify + 2 PresentIdleNotify +└─── + +┌─── + PresentEventMask + 1 PresentConfigureNotifyMask + 2 PresentCompleteNotifyMask + 4 PresentIdleNotifyMask +└─── + +┌─── + PresentOption + 1 PresentOptionAsync + 2 PresentOptionCopy; + 4 PresentOptionUST + 8 PresentOptionSuboptimal + 16 PresentOptionAsyncMayTear +└─── + +┌─── + PresentCapability + 1 PresentCapabilityAsync + 2 PresentCapabilityFence + 4 PresentCapabilityUST + 8 PresentCapabilityAsyncMayTear +└─── + +┌─── + PresentCompleteKind + 0 PresentCompleteKindPixmap + 1 PresentCompleteKindMSCNotify +└─── + +┌─── + PresentCompleteMode + 0 PresentCompleteModeCopy + 1 PresentCompleteModeFlip + 2 PresentCompleteModeSkip + 3 PresentCompleteModeSuboptimalCopy +└─── + +┌─── + PresentNotify + 4 Window window + 4 CARD32 serial +└─── + +A.1.1 Common Types proposed for a later Present extension version + +┌─── + PresentEventType + ... + 3 PresentRedirectNotify +└─── + +┌─── + PresentEventMask + ... + 8 PresentSubredirectNotifyMask +└─── + +A.2 Protocol Requests + +┌─── + PresentQueryVersion + 1 CARD8 major opcode + 1 0 Present opcode + 2 3 length + 4 CARD32 major version + 4 CARD32 minor version + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 major version + 4 CARD32 minor version + 16 unused +└─── + +┌─── + PresentPixmap + 1 CARD8 major opcode + 1 1 Present opcode + 2 18+2n length + 4 Window window + 4 Pixmap pixmap + 4 CARD32 serial + 4 Region valid-area + 4 Region update-area + 2 INT16 x-off + 2 INT16 y-off + 4 CRTC target-crtc + 4 SyncFence wait-fence + 4 SyncFence idle-fence + 4 CARD32 options + 4 unused + 8 CARD64 target-msc + 8 CARD64 divisor + 8 CARD64 remainder + 8n LISTofPresentNotify notifies +└─── + +┌─── + PresentNotifyMSC + 1 CARD8 major opcode + 1 2 Present opcode + 2 10 length + 4 Window window + 4 CARD32 serial + 4 unused + 8 CARD64 target-msc + 8 CARD64 divisor + 8 CARD64 remainder +└─── + +┌─── + PresentSelectInput + 1 CARD8 major opcode + 1 3 Present opcode + 2 4 length + 4 EventID event-id + 4 Window window + 4 SETofPRESENTEVENTMASK event-mask +└─── + +┌─── + PresentQueryCapabilities + 1 CARD8 major opcode + 1 4 Present opcode + 2 2 length + 4 CRTC or Window target + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 SETofPRESENTCAPABILITY capabilities +└─── + +┌─── + PresentPixmapSynced + 1 CARD8 major opcode + 1 5 Present opcode + 2 22+2n length + 4 Window window + 4 Pixmap pixmap + 4 CARD32 serial + 4 Region valid-area + 4 Region update-area + 2 INT16 x-off + 2 INT16 y-off + 4 CRTC target-crtc + 4 SYNCOBJ acquire-syncobj + 4 SYNCOBJ release-syncobj + 8 CARD64 acquire-point + 8 CARD64 release-point + 4 CARD32 options + 4 unused + 8 CARD64 target-msc + 8 CARD64 divisor + 8 CARD64 remainder + 8n LISTofPresentNotify notifies +└─── + +A.3 Protocol Events + +┌─── + PresentConfigureNotify + 1 35 XGE + 1 CARD8 Present extension opcode + 2 CARD16 sequence number + 4 2 length + 2 0 PresentConfigureNotify + 2 unused + 4 CARD32 event id + 4 Window window + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 INT16 off x + 2 INT16 off y + + 2 CARD16 pixmap width + 2 CARD16 pixmap height + 4 CARD32 pixmap flags +└─── + +┌─── + PresentCompleteNotify + 1 35 XGE + 1 CARD8 Present extension opcode + 2 CARD16 sequence number + 4 2 length + 2 1 PresentCompleteNotify + 1 CARD8 kind + 1 CARD8 mode + 4 CARD32 event id + 4 Window window + 4 CARD32 serial + 8 CARD64 ust + + 8 CARD64 msc +└─── + +┌─── + PresentIdleNotify + 1 35 XGE + 1 CARD8 Present extension opcode + 2 CARD16 sequence number + 4 0 length + 2 2 PresentIdleNotify + 2 unused + 4 CARD32 event id + 4 Window window + 4 CARD32 serial + 4 Pixmap pixmap + 4 SyncFence idle-fence +└─── + +A.3.1 Protocol Events proposed for later Present extension version + +┌─── + PresentRedirectNotify + 1 35 XGE + 1 CARD8 Present extension opcode + 2 CARD16 sequence number + 4 18+2n length + 2 3 PresentRedirectNotify + 1 BOOL update-window + 1 unused + 4 CARD32 event id + 4 Window event-window + 4 Window window + 4 Pixmap pixmap + 4 CARD32 serial + + 4 Region valid-area + 4 Region update-area + 8 Rectangle valid-rect + 8 Rectangle update-rect + 2 INT16 x-off + 2 INT16 y-off + 4 CRTC target-crtc + 4 SyncFence wait-fence + 4 SyncFence idle-fence + 4 CARD32 options + 4 unused + 8 CARD64 target-msc + 8 CARD64 divisor + 8 CARD64 remainder + 8n LISTofPRESENTNOTIFY notifies +└─── + +A.4 Protocol Errors + +The Present extension defines no errors. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/randrproto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/randrproto.txt new file mode 100644 index 0000000000000000000000000000000000000000..7156e929a5c22a29a51f3172f7e17a83f7940241 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/randrproto.txt @@ -0,0 +1,3435 @@ + The X Resize, Rotate and Reflect Extension + Version 1.6.0 + 2017-04-01 + + Jim Gettys + Jim.Gettys@hp.com + Cambridge Research Laboratory + HP Labs + Hewlett Packard Company + + Keith Packard + keithp@keithp.com + +1. Introduction + +The X Resize, Rotate and Reflect Extension, called RandR for short, +brings the ability to resize, rotate and reflect the root window of a +screen. It is based on the X Resize and Rotate Extension as specified +in the Proceedings of the 2001 Usenix Technical Conference [RANDR]. + +RandR as implemented and integrated into the X server differs in +one substantial fashion from the design discussed in that paper: that +is, RandR 1.0 does not implement the depth switching described in that +document, and the support described for that in the protocol in that +document and in the implementation has been removed from the +protocol described here, as it has been overtaken by events. + +These events include: + ► Modern toolkits (in this case, GTK+ 2.x) have progressed to the point + of implementing migration between screens of arbitrary depths + ► The continued advance of Moore's law has made limited amounts of VRAM + less of an issue, reducing the pressure to implement depth switching + on laptops or desktop systems + ► The continued decline of legacy toolkits whose design would have + required depth switching to support migration + ► The lack of depth switching implementation experience in the + intervening time, due to events beyond our control + +Additionally, the requirement to support depth switching might +complicate other re-engineering of the device independent part of the +X server that is currently being contemplated. + +Rather than further delaying RandR's widespread deployment for a feature +long wanted by the community (resizing of screens, particularly on laptops), +or the deployment of a protocol design that might be flawed due to lack of +implementation experience, we decided to remove depth switching from the +protocol. It may be implemented at a later time if resources and +interests permit as a revision to the protocol described here, which will +remain a stable base for applications. The protocol described here has been +implemented in the main X.org server, and more fully in the hw/kdrive +implementation in the distribution, which fully implements resizing, +rotation and reflection. + +1.2 Introduction to version 1.2 of the extension + +One of the significant limitations found in version 1.1 of the RandR +protocol was the inability to deal with the Xinerama model where multiple +monitors display portions of a common underlying screen. In this environment, +zero or more video outputs are associated with each CRT controller which +defines both a set of video timings and a 'viewport' within the larger +screen. This viewport is independent of the overall size of the screen, and +may be located anywhere within the screen. + +The effect is to decouple the reported size of the screen from the size +presented by each video output, and to permit multiple outputs to present +information for a single screen. + +To extend RandR for this model, we separate out the output, CRTC and screen +configuration information and permit them to be configured separately. For +compatibility with the 1.1 version of the protocol, we make the 1.1 requests +simultaneously affect both the screen and the (presumably sole) CRTC and +output. The set of available outputs are presented with UTF-8 encoded names +and may be connected to CRTCs as permitted by the underlying hardware. CRTC +configuration is now done with full mode information instead of just size +and refresh rate, and these modes have names. These names also use UTF-8 +encoding. New modes may also be added by the user. + +Additional requests and events are provided for this new functionality. + + ┌────────────────────────────────┬──────────┐ + ┏━━━━━━━┳───────────────┐ ╔════════╗ ╔════════╗ + ┃ 1 ┃ │ ║ A ║ ║ B ║ + ┃ ┏━━━╋━━━━━━━━━━━━━━━┫ ║ ║ ║ ║ + ┣━━━╋━━━┛ ┃ ╚════════╝ ╚════════╝ + │ ┃ 2 ┃─────────────────┐ + │ ┃ ┃ ╔═══════════════════╗ + │ ┃ ┃ ║ ║ + │ ┗━━━━━━━━━━━━━━━━━━━┫ ║ C ║ + └───────────────────────┘ ║ ║ + ┌──────┐ ┏━━━━┓ ╔══════╗ ║ ║ + │screen│ ┃CRTC┃ ║output║ ╚═══════════════════╝ + └──────┘ ┗━━━━┛ ╚══════╝ + +In this picture, the screen is covered (incompletely) by two CRTCs. CRTC1 +is connected to two outputs, A and B. CRTC2 is connected to output C. +Outputs A and B will present exactly the same region of the screen using +the same mode line. Output C will present a different (larger) region of +the screen using a different mode line. + +RandR provides information about each available CRTC and output; the +connection between CRTC and output is under application control, although +the hardware will probably impose restrictions on the possible +configurations. The protocol doesn't try to describe these restrictions, +instead it provides a mechanism to find out what combinations are supported. + +1.3 Introduction to version 1.3 of the extension + +Version 1.3 builds on the changes made with version 1.2 and adds some new +capabilities without fundamentally changing the extension again. The +following features are added in this version: + + • Projective Transforms. The implementation work for general rotation + support made it trivial to add full projective transformations. These + can be used to scale the screen up/down as well as perform projector + keystone correct or other effects. + + • Panning. It was removed with RandR 1.2 because the old semantics didn't + fit any longer. With RandR 1.3 panning can be specified per crtc. + +1.4 Introduction to version 1.4 of the extension + +Version 1.4 adds an optional Border property. + + • An optional Border property. This property allows a client to + specify that the viewport of the CRTC is smaller than the active + display region described its mode. This is useful, for example, + for compensating for the overscan behavior of certain + televisions. + +Version 1.4 adds a new object called a provider object. A provider object +represents a GPU or virtual device providing services to the X server. +Providers have a set of abilities and a set of possible roles. + +Provider objects are used to control multi-GPU systems. Provider roles can +be dynamically configured to provide support for: + + 1) Output slaving: plug in a USB device, but have its output rendered + using the main GPU. On some dual-GPU laptops, the second GPU isn't + connected to the LVDS panel, so we need to use the first GPU as an output + slave for the second GPU. + + 2) offload - For dual-GPU laptops, allow direct rendered applications to be run + on the second GPU and display on the first GPU. + + 3) GPU switching - Allow switching between two GPUs as the main screen + renderer. + + 4) multiple GPU rendering - This replaces Xinerama. + +1.5. Introduction to version 1.5 of the extension + +Version 1.5 adds an optional TILE property to outputs. + + • An optional TILE property. + This property is used to denote individual tiles in a tiled monitor + configuration, as exposed via DisplayID v1.3. + +Version 1.5 adds monitors + + • A 'Monitor' is a rectangular subset of the screen which represents + a coherent collection of pixels presented to the user. + + • Each Monitor is associated with a list of outputs (which may be + empty). + + • When clients define monitors, the associated outputs are removed from + existing Monitors. If removing the output causes the list for that + monitor to become empty, that monitor will be deleted. + + • For active CRTCs that have no output associated with any + client-defined Monitor, one server-defined monitor will + automatically be defined of the first Output associated with them. + + • When defining a monitor, setting the geometry to all zeros will + cause that monitor to dynamically track the bounding box of the + active outputs associated with them + +This new object separates the physical configuration of the hardware +from the logical subsets of the screen that applications should +consider as single viewable areas. + +1.5.1. Relationship between Monitors and Xinerama + +Xinerama's information now comes from the Monitors instead of directly +from the CRTCs. The Monitor marked as Primary will be listed first. + +1.5.2. Clarification of Output lifetimes + +With dynamic connectors being a possibility with the introduction of +DisplayPort multistream (MST), a lot of RandR clients can't handle the +XID BadMatch when a RandR output disappears. This is to clarify that +going forward the X server will not remove outputs dynamically, +just mark them as disconnected. + +1.6. Introduction to version 1.6 of the extension + +Version 1.6 adds resource leasing and non desktop output management. + + • A “Lease” is a collection of crtcs and outputs which are made + available to a client for direct access via kernel KMS and DRM + APIs. This is done by passing a suitable file descriptor back to + the client which has access to those resources. While leased, those + resources aren't used by the X server. + + • A “non-desktop” output is a device which should not normally be + considered as part of the desktop environment. Head-mounted + displays and the Apple "Touch Bar" are examples of such + devices. A desktop environment should be able to discover which + outputs are connected to such devices and, by default, not present + normal desktop applications on them. This is done by having + RRGetOutputInfo report such devices as Disconnected while reporting + all other information about the device correctly. + +1.99 Acknowledgments + +Our thanks to the contributors to the design found on the xpert mailing +list, in particular: + +Alan Hourihane for work on the early implementation +Andrew C. Aitchison for help with the XFree86 DDX implementation +Andy Ritger for early questions about how mergefb/Xinerama work with RandR +Carl Worth for editing the specification and Usenix paper +David Dawes for XFree86 DDX integration work +Thomas Winischhofer for the hardware-accelerated SiS rotation implementation +Matthew Tippett and Kevin Martin for splitting outputs and CRTCs to more +fully expose what video hardware can do +Dave Airlie for the 1.4.0 protocol changes and for working through the +implications of MST monitors and encouraging the introduction of the +'Monitor' concept. + + ❧❧❧❧❧❧❧❧❧❧❧ + +2. Screen change model + +Screens may change dynamically, either under control of this extension, or +due to external events. Examples include: monitors being swapped, pressing a +button to switch from internal display to an external monitor on a laptop, +or, eventually, the hotplug of a display card entirely on buses such as +Cardbus or Express Card which permit hot-swap (which will require other work +in addition to this extension). + +Since the screen configuration is dynamic and asynchronous to the client and +may change at any time RandR provides mechanisms to ensure that your clients +view is up to date with the configuration possibilities of the moment and +enforces applications that wish to control the configuration to prove that +their information is up to date before honoring requests to change the +screen configuration (by requiring a timestamp on the request). + +Interested applications are notified whenever the screen configuration +changes, providing the current size of the screen and subpixel order (see +the Render extension [RENDER]), to enable proper rendering of subpixel +decimated client text to continue, along with a time stamp of the +configuration change. A client must refresh its knowledge of the screen +configuration before attempting to change the configuration after a +notification, or the request will fail. + +To avoid multiplicative explosion between orientation, reflection and sizes, +the sizes are only those sizes in the normal (0) rotation. + +Rotation and reflection and how they interact can be confusing. In Randr, +the coordinate system is rotated in a counter-clockwise direction relative +to the normal orientation. Reflection is along the window system coordinate +system, not the physical screen X and Y axis, so that rotation and +reflection do not interact. The other way to consider reflection is to is +specified in the "normal" orientation, before rotation, if you find the +other way confusing. + +We expect that most clients and toolkits will be oblivious to changes to the +screen structure, as they generally use the values in the connections Display +structure directly. By toolkits updating the values on the fly, we believe +pop-up menus and other pop up windows will position themselves correctly in +the face of screen configuration changes (the issue is ensuring that pop-ups +are visible on the reconfigured screen). + + ❧❧❧❧❧❧❧❧❧❧❧ + +3. Data Types + +The subpixel order and transform data types are shared with the Render +extension, and are documented there. + +The only datatype defined in the original extension is the screen size, +defined in the normal (0 degree) orientation. Several more are added +in later revisions. + + ❧❧❧❧❧❧❧❧❧❧❧ + +4. Errors + +Errors are sent using core X error reports. + +Output + A value for an OUTPUT argument does not name a defined OUTPUT. +CRTC + A value for a CRTC argument does not name a defined CRTC. +Mode + A value for a MODE argument does not name a defined MODE. +Provider + A value for a PROVIDER argument does not name a defined PROVIDER. +Lease + A value for a LEASE argument does not name a defined LEASE + + ❧❧❧❧❧❧❧❧❧❧❧ + +5. Protocol Types + +RRCONFIGSTATUS { Success + InvalidConfigTime + InvalidTime + Failed } + + A value of type RRCONFIGSTATUS returned when manipulating the output + configuration or querying information from the server that has some + time-dependency. + + InvalidConfigTime indicates that the supplied configuration + timestamp does not match the current X server configuration + timestamp. Usually this means that the output configuration has + changed since the timestamp was received by the application. + + InvalidTime indicates that the supplied output reconfiguration time + is earlier than the most recent output reconfiguration request. + Generally this indicates that another application has reconfigured + the output using a later timestamp. + + Failed is returned whenever the operation is unsuccessful for some + other reason. This generally indicates that the requested output + configuration is unsupported by the hardware. The goal is to make + these limitations expressed by the protocol, but when that isn't + possible it is correct to return this error value. If, as a + implementer, you find this error code required, please submit the + hardware constraints that exist so that a future version of the + extension can correctly capture the configuration constraints in + your system. + +ROTATION { Rotate_0 + Rotate_90 + Rotate_180 + Rotate_270 + Reflect_X + Reflect_Y } + + These values are used both to indicate a set of allowed rotations + and reflections as well as to indicate a specific rotation and + reflection combination. + +RRSELECTMASK { RRScreenChangeNotifyMask + RRCrtcChangeNotifyMask (New in version 1.2) + RROutputChangeNotifyMask (New in version 1.2) + RROutputPropertyNotifyMask (New in version 1.2) + RRProviderChangeNotifyMask (New in version 1.4) + RRProviderPropertyNotifyMask (New in version 1.4) + RRResourceChangeNotifyMask (New in version 1.4) } + +SIZEID { CARD16 } + +MODE { XID or None } + +CRTC { XID } + +OUTPUT { XID } + +CONNECTION { Connected, Disconnected, UnknownConnection } + + This value provides an indication of whether an output is actually + connected to a monitor or other presentation device. + + +SCREENSIZE [ widthInPixels, heightInPixels: CARD16 + widthInMillimeters, heightInMillimeters: CARD16 ] + +MODEFLAG { HSyncPositive + HSyncNegative + VSyncPositive + VSyncNegative + Interlace + DoubleScan + CSync + CSyncPositive + CSyncNegative + HSkewPresent + BCast + PixelMultiplex + DoubleClock + ClockDivideBy2 } + +MODEINFO [ id: MODE + name: STRING + width, height: CARD16 + dotClock: CARD32 + hSyncStart, hSyncEnd, hTotal, hSkew: CARD16 + vSyncStart, vSyncEnd, vTotal: CARD16 + modeFlags: SETofMODEFLAG ] + +REFRESH [ rates: LISTofCARD16 ] + + ❧❧❧❧❧❧❧❧❧❧❧ + +5.1 Data Types defined by the Render extension + +These data types use the Render extension definitions; they are shown here +only for convenience: + +SUBPIXELORDER { SubPixelUnknown + SubPixelHorizontalRGB + SubPixelHorizontalBGR + SubPixelVerticalRGB + SubPixelVerticalBGR + SubPixelNone } + +FIXED 32-bit value (top 16 are integer portion, bottom 16 are fraction) + +TRANSFORM [ + p11, p12, p13: FIXED + p21, p22, p23: FIXED + p31, p32, p33: FIXED + ] + + ❧❧❧❧❧❧❧❧❧❧❧ + +5.5. Protocol Types added in version 1.4 of the extension + +PROVIDER { XID } + +PROVIDER_CAPS { SourceOutput, SinkOutput, SourceOffload, SinkOffload } + Capabilities for this provider: + SourceOutput: This device can source output buffers. + SinkOutput: This device can sink output buffers. + SourceOffload: This device can source offload buffers. + SinkOffload: This device can sink offload buffers. + + ❧❧❧❧❧❧❧❧❧❧❧ + +5.6. Protocol Types added in version 1.5 of the extension + +MONITORINFO { name: ATOM + primary: BOOL + automatic: BOOL + x: INT16 + y: INT16 + width: CARD16 + height: CARD16 + width-in-millimeters: CARD32 + height-in-millimeters: CARD32 + outputs: LISTofOUTPUT } + + ❧❧❧❧❧❧❧❧❧❧❧ + +5.7. Protocol Types added in version 1.6 of the extension + +LEASE { XID } + + ❧❧❧❧❧❧❧❧❧❧❧ + +6. Extension Initialization + +The name of this extension is "RANDR". + +┌─── + RRQueryVersion + client-major-version: CARD32 + client-minor-version: CARD32 + ▶ + major-version: CARD32 + minor-version: CARD32 +└─── + + The client sends the highest supported version to the server + and the server sends the highest version it supports, but no + higher than the requested version. Major versions changes can + introduce incompatibilities in existing functionality, minor + version changes introduce only backward compatible changes. + It is the clients responsibility to ensure that the server + supports a version which is compatible with its expectations. + + ❧❧❧❧❧❧❧❧❧❧❧ + +7. Extension Requests + +┌─── + RRSelectInput + window: WINDOW + enable: SETofRRSELECTMASK +└─── + Errors: Window, Value + + If 'enable' is RRScreenChangeNotifyMask, RRScreenChangeNotify events + will be sent when the screen configuration changes, either from + this protocol extension, or due to detected external screen + configuration changes. RRScreenChangeNotify may also be sent when + this request executes if the screen configuration has changed since + the client connected, to avoid race conditions. + + New for version 1.2: + + If 'enable' contains RRCrtcChangeNotifyMask, RRCrtcChangeNotify events + will be sent when the configuration for a CRTC associated with the + screen changes, either through this protocol extension or due to + detected external changes. RRCrtcChangeNotify may also be sent when + this request executes if the CRTC configuration has changed since + the client connected, to avoid race conditions. + + If 'enable' contains RROutputChangeNotifyMask, RROutputChangeNotify + events will be sent when the configuration for an output associated with + the screen changes, either through this protocol extension or due to + detected external changes. RROutputChangeNotify may also be sent when + this request executes if the output configuration has changed since the + client connected, to avoid race conditions. + + If 'enable' contains RROutputPropertyNotifyMask, + RROutputPropertyNotify events will be sent when properties change on + this output. + + New for version 1.4: + + If 'enable' contains RRProviderChangeNotifyMask, + RRProviderChangeNotify events will be sent whenever the role for a + provider object has changed. + + If 'enable' contains RRProviderPropertyNotifyMask, + RRProviderPropertyNotify events will be sent when properties change + on a provider object. + + If 'enable' contains RRResourceChangeNotifyMask, + RRResourceChangeNotify events will be sent whenever the set of + available RandR resources associated with the screen has changed. + +┌─── + RRSetScreenConfig + window: WINDOW + timestamp: TIMESTAMP + config-timestamp: TIMESTAMP + size-id: SIZEID + rotation: ROTATION + rate: CARD16 + ▶ + status: RRCONFIGSTATUS + new-timestamp: TIMESTAMP + config-timestamp: TIMESTAMP + root: WINDOW + subpixelOrder: SUBPIXELORDER +└─── + Errors: Value, Match + + If 'timestamp' is less than the time when the configuration was last + successfully set, the request is ignored and InvalidTime returned in + status. + + If 'config-timestamp' is not equal to when the server's screen + configurations last changed, the request is ignored and + InvalidConfigTime returned in status. This could occur if the + screen changed since you last made a RRGetScreenInfo request, + perhaps by a different piece of display hardware being installed. + Rather than allowing an incorrect call to be executed based on stale + data, the server will ignore the request. + + 'rate' contains the desired refresh rate. If it is zero, the server + selects an appropriate rate. + + This request may fail for other indeterminate reasons, in which case + 'status' will be set to Failed and no configuration change will be + made. + + This request sets the screen to the specified size, rate, rotation + and reflection. + + When this request succeeds, 'status' contains Success and the + requested changes to configuration will have been made. + + 'new-time-stamp' contains the time at which this request was + executed. + + 'config-timestamp' contains the time when the possible screen + configurations were last changed. + + 'root' contains the root window for the screen indicated by the + window. + + 'subpixelOrder' contains the resulting subpixel order of the screen + to allow correct subpixel rendering. + + Value errors are generated when 'rotation', 'rate' or 'size-id' + are invalid. + +┌─── + RRGetScreenInfo + window: WINDOW + ▶ + rotations: SETofROTATION + root: WINDOW + timestamp: TIMESTAMP + config-timestamp: TIMESTAMP + size-id: SIZEID + rotation: ROTATION + rate: CARD16 + sizes: LISTofSCREENSIZE + refresh: LISTofREFRESH +└─── + + Errors: Window + + RRGetScreenInfo returns information about the current and available + configurations for the screen associated with 'window'. + + 'rotations' contains the set of rotations and reflections supported + by the screen. + + 'root' is the root window of the screen. + + 'config-timestamp' indicates when the screen configuration + information last changed: requests to set the screen will fail + unless the timestamp indicates that the information the client + is using is up to date, to ensure clients can be well behaved + in the face of race conditions. + + 'timestamp' indicates when the configuration was last set. + + 'size-id' indicates which size is active. + + 'rate' is the current refresh rate. This is zero when the refresh + rate is unknown or on devices for which refresh is not relevant. + + 'sizes' is the list of possible frame buffer sizes (at the normal + orientation). Each size indicates both the linear physical size of + the screen and the pixel size. + + 'refresh' is the list of refresh rates for each size. Each element + of 'sizes' has a corresponding element in 'refresh'. An empty list + indicates no known rates, or a device for which refresh is not + relevant. + + The default size of the screen (the size that would become the + current size when the server resets) is the first size in the + list. + +7.1. Extension Requests added in version 1.2 of the extension + +As introduced above, version 1.2 of the extension splits the screen size +from the crtc and output configuration, permitting the subset of the screen +presented by multiple outputs to be configured. As a separate notion, the +size of the screen itself may be arbitrarily configured within a defined +range. As crtcs and outputs are added and removed from the system, the set +returned by the extension will change so that applications can detect +dynamic changes in the display environment. + +┌─── + RRGetScreenSizeRange + window: WINDOW + ▶ + CARD16 minWidth, minHeight + CARD16 maxWidth, maxHeight +└─── + Errors: Window + + Returns the range of possible screen sizes. The screen may be set to + any size within this range. + +┌─── + RRSetScreenSize + window: WINDOW + width: CARD16 + height: CARD16 + width-in-millimeters: CARD32 + height-in-millimeters: CARD32 +└─── + Errors: Window, Match, Value + + Sets the screen to the specified size. 'width' and 'height' must be + within the range allowed by GetScreenSizeRanges, otherwise a Value + error results. All active monitors must be configured to display a + subset of the specified size, else a Match error results. + + 'width-in-millimeters' and 'height-in-millimeters' can be set to + reflect the physical size of the screen reported both through this + extension and the core protocol. They must be non-zero, or Value + error results. + + If panning is enabled, the width and height of the panning and the + tracking areas are adapted to the new size and clamped afterwards. + Disabled panning axes remain disabled. + Panning borders are disabled if their requirements are no longer met + (see RRSetPanning). + +┌─── + RRGetScreenResources + window: WINDOW + ▶ + timestamp: TIMESTAMP + config-timestamp: TIMESTAMP + crtcs: LISTofCRTC + outputs: LISTofOUTPUT + modes: LISTofMODEINFO +└─── + Errors: Window + + RRGetScreenResources returns the list of outputs and crtcs connected + to the screen associated with 'window'. + + 'timestamp' indicates when the configuration was last set. + + 'config-timestamp' indicates when the configuration information last + changed. Requests to configure the output will fail unless the + timestamp indicates that the information the client is using is up + to date, to ensure clients can be well behaved in the face of race + conditions. + + 'crtcs' contains the list of CRTCs associated with the screen. + + 'outputs' contains the list of outputs associated with the screen. + + 'modes' contains the list of modes associated with the screen + + This request explicitly asks the server to ensure that the + configuration data is up-to-date wrt the hardware. If that requires + polling, this is when such polling would take place. If the + current configuration is all that's required, use + RRGetScreenResourcesCurrent instead. + +┌─── + RRGetOutputInfo + output: OUTPUT + config-timestamp: TIMESTAMP + ▶ + status: RRCONFIGSTATUS + timestamp: TIMESTAMP + crtc: CRTC + + name: STRING + connection: CONNECTION + subpixel-order: SUBPIXELORDER + widthInMillimeters, heightInMillimeters: CARD32 + crtcs: LISTofCRTC + clones: LISTofOUTPUT + modes: LISTofMODE + num-preferred: CARD16 +└─── + Errors: Output + + RRGetOutputInfo returns information about the current and available + configurations 'output'. + + If 'config-timestamp' does not match the current configuration + timestamp (as returned by RRGetScreenResources), 'status' is set to + InvalidConfigTime and the remaining reply data is empty. Otherwise, + 'status' is set to Success. + + 'timestamp' indicates when the configuration was last set. + + 'crtc' is the current source CRTC for video data, or Disabled if the + output is not connected to any CRTC. + + 'name' is a UTF-8 encoded string designed to be presented to the + user to indicate which output this is. E.g. "S-Video" or "DVI". + + 'connection' indicates whether the hardware was able to detect a + device connected to this output. If the hardware cannot determine + whether something is connected, it will set this to + UnknownConnection. + + 'subpixel-order' contains the resulting subpixel order of the + connected device to allow correct subpixel rendering. + + 'widthInMillimeters' and 'heightInMillimeters' report the physical + size of the displayed area. If unknown, or not really fixed (e.g., + for a projector), these values are both zero. + + 'crtcs' is the list of CRTCs that this output may be connected to. + Attempting to connect this output to a different CRTC results in a + Match error. + + 'clones' is the list of outputs which may be simultaneously + connected to the same CRTC along with this output. Attempting to + connect this output with an output not in the 'clones' list + results in a Match error. + + 'modes' is the list of modes supported by this output. Attempting to + connect this output to a CRTC not using one of these modes results + in a Match error. + + The first 'num-preferred' modes in 'modes' are preferred by the + monitor in some way; for fixed-pixel devices, this would generally + indicate which modes match the resolution of the output device. + + Changes in version 1.6 of the protocol: + + When a “non-desktop” device is connected, the 'connection' + field will report Disconnected but the remaining fields will + report information about the connected device. + +┌─── + RRListOutputProperties + output:OUTPUT + ▶ + atoms: LISTofATOM +└─── + Errors: Output + + This request returns the atoms of properties currently defined on + the output. + + Changes in version 1.6 of the protocol: + + When a “non-desktop” device is connected, the property list + will be correct for the device, even though RRGetOutputInfo + reports the device as disconnected. + +┌─── + RRQueryOutputProperty + output: OUTPUT + property: ATOM + ▶ + pending: BOOL + range: BOOL + immutable: BOOL + valid-values: LISTofINT32 +└─── + Errors: Name, Atom, Output + + If the specified property does not exist for the specified output, + then a Name error is returned. + + If 'pending' is TRUE, changes made to property values with + RRChangeOutputProperty will be saved in the pending property value + and be automatically copied to the current value on the next + RRSetCrtcConfig request involving the named output. If 'pending' is + FALSE, changes are copied immediately. + + If 'range' is TRUE, then the valid-values list will contain + precisely two values indicating the minimum and maximum allowed + values. If 'range' is FALSE, then the valid-values list will contain + the list of possible values; attempts to set other values will + result in a Value error. + + If 'immutable' is TRUE, then the property configuration cannot be + changed by clients. Immutable properties are interpreted by the X + server. + + Changes in version 1.6 of the protocol: + + When a “non-desktop” device is connected, the property information + will be correct for the device, even though RRGetOutputInfo + reports the device as disconnected. + +┌─── + RRConfigureOutputProperty + output: OUTPUT + property: ATOM + pending: BOOL + range: BOOL + valid-values: LISTofINT32 +└─── + Errors: Access, Name, Atom, Output + + If the specified property is 'immutable', an Access error is + returned. + + Otherwise, the configuration of the specified property is changed to + the values provided in this request. + + If the specified property does not exist for the specified output, + it is created with an empty value and None type. + +┌─── + RRChangeOutputProperty + output: OUTPUT + property, type: ATOM + format: {8, 16, 32} + mode: { Replace, Prepend, Append } + data: LISTofINT8 or LISTofINT16 or LISTofINT32 +└─── + Errors: Alloc, Atom, Match, Value, Output + + This request alters the value of the property for the specified + output. If the property is marked as a 'pending' property, only the + pending value of the property is changed. Otherwise, changes are + reflected in both the pending and current values of the property. + The type is uninterpreted by the server. The format specifies + whether the data should be viewed as a list of 8-bit, 16-bit, or + 32-bit quantities so that the server can correctly byte-swap as + necessary. + + If the mode is Replace, the previous property value is discarded. + If the mode is Prepend or Append, then the type and format must + match the existing property value (or a Match error results). If + the property is undefined, it is treated as defined with the correct + type and format with zero-length data. + + For Prepend, the data is tacked on to the beginning of the existing + data, and for Append, it is tacked on to the end of the existing data. + + This request generates a OutputPropertyNotify + + The lifetime of a property is not tied to the storing client. + Properties remain until explicitly deleted, until the output is + destroyed, or until server reset (see section 10). + + The maximum size of a property is server-dependent and may vary + dynamically. + +┌─── + RRDeleteOutputProperty + output: OUTPUT + property: ATOM +└─── + Errors: Atom, Output + + This request deletes the property from the specified window if the + property exists and generates a OutputPropertyNotify event unless + the property does not exist. + +┌─── + RRGetOutputProperty + output: OUTPUT + property: ATOM + type: ATOM or AnyPropertyType + long-offset, long-length: CARD32 + delete: BOOL + pending: BOOL + ▶ + type: ATOM or None + format: {0, 8, 16, 32} + bytes-after: CARD32 + value: LISTofINT8 or LISTofINT16 or LISTofINT32 +└─── + Errors: Atom, Value, Output + + If the specified property does not exist for the specified output, + then the return type is None, the format and bytes-after are zero, + and the value is empty. The delete argument is ignored in this + case. + + If the specified property exists but its type does not match the + specified type, then the return type is the actual type of the + property, the format is the actual format of the property (never + zero), the bytes-after is the length of the property in bytes (even + if the format is 16 or 32), and the value is empty. The delete + argument is ignored in this case. + + If the specified property exists and either AnyPropertyType is + specified or the specified type matches the actual type of the + property, then the return type is the actual type of the property, + the format is the actual format of the property (never zero), and + the bytes-after and value are as follows, given: + + N = actual length of the stored property in bytes + (even if the format is 16 or 32) + I = 4 × offset + T = N - I + L = MINIMUM(T, 4 × long-length) + A = N - (I + L) + + If 'pending' is true, and if the property holds a pending value, + then the value returned will be the pending value of the property + rather than the current value. The returned value starts at byte + index I in the property (indexing from 0), and its length in bytes + is L. However, it is a Value error if long-offset is given such + that L is negative. The value of bytes-after is A, giving the + number of trailing unread bytes in the stored property. If delete + is True and the bytes-after is zero, the property is also deleted + from the output, and a RROutputPropertyNotify event is generated. + + Changes in version 1.6 of the protocol: + + When a “non-desktop” device is connected, the property value + will be correct for the device, even though RRGetOutputInfo + reports the device as disconnected. + +┌─── + RRCreateMode + window: WINDOW + modeinfo: MODEINFO + ▶ + mode: MODE +└─── + Errors: Window, Name, Value + + 'modeinfo' provides a new mode for outputs on the screen + associated with 'window'. If the name of 'modeinfo' names an + existing mode, a Name error is returned. If some parameter of the + mode is not valid in some other way, a Value error is returned. + + The returned 'mode' provides the id for the mode. + +┌─── + RRDestroyMode + mode: MODE +└─── + Errors: Mode, Access + + The user-defined 'mode' is destroyed. 'mode' must name a mode + defined with RRCreateMode, else an Match error is returned. If + 'mode' is in use by some CRTC or Output, then an Access error is + returned. + +┌─── + RRAddOutputMode + output: OUTPUT + mode: MODE +└─── + Errors: Output, Mode, Match + + 'output' indicates which output is to be configured. + + 'mode' specifies which mode to add. If 'mode' is not valid for + 'output', then a Match error is generated. + + This request generates OutputChangeNotify events. + +┌─── + RRDeleteOutputMode + output: OUTPUT + mode: MODE +└─── + Errors: Output, Mode + + 'output' indicates which output is to be configured. + + 'mode' specifies which mode to delete. 'mode' must have been added + with RRAddOutputMode, else an Access error is returned. 'mode' must + not be active, else a Match error is returned. + + This request generates OutputChangeNotify events. + +┌─── + RRGetCrtcInfo + crtc: CRTC + config-timestamp: TIMESTAMP + ▶ + status: RRCONFIGSTATUS + timestamp: TIMESTAMP + x, y: INT16 + width, height: CARD16 + mode: MODE + rotation: ROTATION + outputs: LISTofOUTPUT + + rotations: SETofROTATION + possible-outputs: LISTofOUTPUT +└─── + + Errors: Window + + RRGetCrtcInfo returns information about the current and available + configurations for the specified crtc connected to the screen + associated with 'window'. + + If 'config-timestamp' does not match the current configuration + timestamp (as returned by RRGetScreenResources), 'status' is set to + InvalidConfigTime and the remaining reply data is empty. Otherwise, + 'status' is set to Success. + + 'timestamp' indicates when the configuration was last set. + + 'x' and 'y' indicate the position of this CRTC within the screen + region. They will be set to 0 when the CRTC is disabled. + + 'width' and 'height' indicate the size of the area within the screen + presented by this CRTC. This may be different than the size of the + mode due to rotation, the projective transform, and the Border property + described below. They will be set to 0 when the CRTC is disabled. + + 'mode' indicates which mode is active, or None indicating that the + CRTC has been disabled and is not displaying the screen contents. + + 'rotation' indicates the active rotation. It is set to Rotate_0 + when the CRTC is disabled. + + 'outputs' is the list of outputs currently connected to this CRTC + and is empty when the CRTC is disabled. + + 'rotations' contains the set of rotations and reflections supported + by the CRTC. + + 'possible-outputs' lists all of the outputs which may be connected + to this CRTC. + +┌─── + RRSetCrtcConfig + crtc: CRTC + timestamp: TIMESTAMP + config-timestamp: TIMESTAMP + x, y: INT16 + mode: MODE + rotation: ROTATION + outputs: LISTofOUTPUT + ▶ + status: RRCONFIGSTATUS + new-timestamp: TIMESTAMP +└─── + Errors: Value, Match + + If 'timestamp' is less than the time when the configuration was last + successfully set, the request is ignored and InvalidTime returned in + status. + + If 'config-timestamp' is not equal to when the monitor's + configuration last changed, the request is ignored and + InvalidConfigTime returned in status. This could occur if the + monitor changed since you last made a RRGetScreenInfo request, + perhaps by a different monitor being connected to the machine. + Rather than allowing an incorrect call to be executed based on stale + data, the server will ignore the request. + + 'x' and 'y' contain the desired location within the screen for this + monitor's content. 'x' and 'y' must be within the screen size, else + a Value error results. + + 'mode' is either the desired mode or None indicating the CRTC should + be disabled. If 'mode' is not one of these values, a Value + error results. 'mode' must be valid for all of the configured outputs, + else a Match error. + + 'rotation' contains the desired rotation along with which + reflections should be enabled. The rotation and reflection values + must be among those allowed for this monitor, else a Value error + results. + + 'outputs' contains the set of outputs that this CRTC should be + connected to. The set must be among the list of acceptable output + sets for this CRTC or a Match error results. + + If 'mode' is None, then 'outputs' must be empty, else a Match error + results. Conversely, if 'mode' is not None, then 'outputs' must not be + empty, else a Match error results. + + This request may fail for other indeterminate reasons, in which case + 'status' will be set to Failed and no configuration change will be + made. + + This request sets the CRTC to the specified position, mode, rotation + and reflection. The entire area of the CRTC must fit within the + screen size, else a Match error results. As an example, rotating the + screen so that a single CRTC fills the entire screen before and + after may necessitate disabling the CRTC, resizing the screen, + then re-enabling the CRTC at the new configuration to avoid an + invalid intermediate configuration. + + If panning is enabled, the width and height of the panning and the + tracking areas are clamped to the new mode size. + Disabled panning axes remain disabled. + Panning borders are disabled if their requirements are no longer met + (see RRSetPanning). + + When this request succeeds, 'status' contains Success and the + requested changes to configuration will have been made. + + 'new-time-stamp' contains the time at which this request was + executed. + +┌─── + RRGetCrtcGammaSize + crtc: CRTC + ▶ + size: CARD16 +└─── + Errors: Crtc + + This request returns the size of the gamma ramps used by 'crtc'. + +┌─── + RRGetCrtcGamma + crtc: CRTC + ▶ + red: LISTofCARD16 + green: LISTofCARD16 + blue: LISTofCARD16 +└─── + Errors: Crtc + + This request returns the currently set gamma ramps for 'crtc'. All + three lists will be the size returned by the RRGetCrtcGammaSize + request. + +┌─── + RRSetCrtcGamma + crtc: CRTC + red: LISTofCARD16 + green: LISTofCARD16 + blue: LISTofCARD16 +└─── + Errors: Crtc, Match + + This request sets the gamma ramps for 'crtc'. All three lists + must be the size returned by RRGetCrtcGammaSize else a Value error + results. + +7.2. Extension Requests added in version 1.3 of the extension + +┌─── + RRGetScreenResourcesCurrent + window: WINDOW + ▶ + timestamp: TIMESTAMP + config-timestamp: TIMESTAMP + crtcs: LISTofCRTC + outputs: LISTofOUTPUT + modes: LISTofMODEINFO +└─── + Errors: Window + + RRGetScreenResourcesCurrent returns the list of outputs and crtcs + connected to the screen associated with 'window'. + + 'timestamp' indicates when the configuration was last set. + + 'config-timestamp' indicates when the configuration information last + changed. Requests to configure the output will fail unless the + timestamp indicates that the information the client is using is up + to date, to ensure clients can be well behaved in the face of race + conditions. + + 'crtcs' contains the list of CRTCs associated with the screen. + + 'outputs' contains the list of outputs associated with the screen. + + 'modes' contains the list of modes associated with the screen. + + Unlike RRGetScreenResources, this merely returns the current + configuration, and does not poll for hardware changes. + +┌─── + RRSetCrtcTransform + crtc: CRTC + transform: TRANSFORM + filter: STRING8 + values: LISTofFIXED +└─── + Errors: Crtc, Match + + This request provides a mechanism that is more general than the + existing rotation and reflection values for describing the + transformation from frame buffer image to crtc presentation. + 'transform' is a full 2D projective transformation from screen + coordinate space to crtc coordinate space. This transformation is + applied before the rotation and reflection values to compute the + complete transform. + + 'filter' and 'values' specify a Render filter that may be used by the + server when transforming data from frame buffer to crtc. + + This request sets the transform to be used at the next + RRSetCrtcConfig request execution; it does not cause any change to + occur in the current configuration. + + When a non-identity transformation is in use, the rectangle returned + by RRGetCrtcInfo defines the bounding rectangle of the screen that is + projected to the crtc. It is this projected rectangle which must be + within the area of the screen when the mode is set. + +┌─── + RRGetCrtcTransform + crtc: CRTC + ▶ + pending-transform: TRANSFORM + pending-filter: STRING8 + pending-values: LISTofFIXED + current-transform: TRANSFORM + current-filter: STRING8 + current-values: LISTofFIXED +└─── + + This request returns the pending and current transforms for the + specified CRTC. The pending transform will be the same as the current + transform if no new pending transform has been set since the last call + to RRSetCrtcConfig. + +┌─── + RRGetPanning + crtc: CRTC + ▶ + status: RRCONFIGSTATUS + timestamp: TIMESTAMP + left, top, width, height: CARD16 + track_left, track_top, track_width, track_height: CARD16 + border_left, border_top, border_right, border_bottom: INT16 +└─── + + Errors: Crtc + + Version 1.3 adds panning support again. If multiple crtcs are active + the panning behavior can be defined per crtc individually. + RRGetPanning returns information about the currently set panning + configuration for the specified crtc. If the CRTC does not support + panning, all fields (except timestamp) will be 0. + + 'timestamp' indicates when the configuration was last set. + + All other entries are explained for RRSetPanning. + +┌─── + RRSetPanning + crtc: CRTC + timestamp: TIMESTAMP + left, top, width, height: CARD16 + track_left, track_top, track_width, track_height: CARD16 + border_left, border_top, border_right, border_bottom: INT16 + ▶ + status: RRCONFIGSTATUS + new-timestamp: TIMESTAMP +└─── + Errors: Crtc, Match + + This request sets the panning parameters. As soon as panning is + enabled, the CRTC position can change with every pointer move. + RRCrtcChangeNotify events are sent to the clients requesting those. + + If 'timestamp' is less than the time when the configuration was last + successfully set, the request is ignored and InvalidTime returned in + status. + + ┌──┳━━━━━━━━━━━━━━┳─────┬ ─ ─ ─ ─ ─ ┐ + │ ┃ CRTC ┃ │ + │ ┃ ┃ │ │ + │ ┃ X┃→ │ + │ ┃ ┃ │ │ framebuffer + │ ┗━━━━━━━━━━━━━━┛ │ + │ │ │ + │panning area │ + └───────────────────────┴ ─ ─ ─ ─ ─ ┘ + + 'left', 'top', 'width', and 'height' contain the total panning area + for this CRTC. 'width' has to be larger than or equal to the CRTC's + width or 0, and 'left'+'width' must be within the screen size, else a + Match error results. Equivalent restrictions for the height exist. + 'width' or 'height' set to 0 indicate that panning should be disabled + on the according axis. Setting 'width'/'height' to the CRTC's + width/height will disable panning on the X/Y axis as well, but + RRSetScreenSize will silently enable panning if the screen size is + increased. This does not happen if set to 0. + + ┌────────┳━━━━━━━━━━━━━━┳ ─ ─ ─ ─ ─ ┐ + │ ┃ CRTC ┃ + │ ┃ ┃ │ + │ ┃ ┃ + │ ┃ ┃ │ tracking area + │ ┗━━━━━━━━━━━━━━┫ X + │ ↓ │ ↓ │ + │panning area │ + └───────────────────────┴ ─ ─ ─ ─ ─ ┘ + + 'track_left', 'track_top', 'track_width', and 'track_height' contain + the pointer area for which the panning region is updated. For normal + use cases it should enclose the panning area minus borders, and is + typically set to either the panning area minus borders, or to the + total screen size. If set to the total screen size, the CRTC will pan + in the remaining axis even if the pointer is outside the panning area + on a different CRTC, as shown in the figure above. If the pointer is + outside the tracking area, the CRTC will not pan. Zero can be used as + an alias for the total screen size. + + ┌──┳━━━━━━━━━━━━━━┳────────────┐ + │ ┃ CRTC ┃ │ + │ ┃ ┃ │ + │ ┃ ┃→ │ + │ ┃ X←→┃ │ + │ ┃ border_right │ + │ ┗━━━━━━━━━━━━━━┛ │ + │ │ + │panning area │ + └──────────────────────────────┘ + + 'border_left', 'border_top', 'border_right', and 'border_bottom' + define the distances from the CRTC borders that will activate panning + if the pointer hits them. If the borders are 0, the screen will pan + when the pointer hits the CRTC borders (behavior of pre-RandR Xserver + panning). If the borders are positive, the screen will pan when the + pointer gets close to the CRTC borders, if they are negative, the + screen will only pan when the pointer is already way past the CRTC + borders. Negative values might confuse users and disable panning to + the very edges of the screen. Thus they are discouraged. + border_left + border_right has to be lower or equal than the CRTC's + width, else a Match error results. An equivalent restriction for the + height exists. + + Screen size changes update the panning and the tracking areas to the + new size. Both screen size changes and mode changes clamp these areas + to the current CRTC size. In these cases panning borders are disabled + if their requirements are no longer met. + + When this request succeeds, 'status' contains Success and the + requested changes to configuration will have been made. + + 'new-time-stamp' contains the time at which this request was + executed. + +┌─── + RRSetOutputPrimary + window: WINDOW + output: OUTPUT +└─── + Errors: Match, Output, Window + + RRSetOutputPrimary marks 'output' as the primary output for the + screen with the same root window as 'window'. This output's CRTC + will be sorted to the front of the list in Xinerama and RANDR + geometry requests for the benefit of older applications. The + default primary output is None, and None is a legal value to pass + to RRSetOutputPrimary. This request is expected to be used by + desktop environments to mark the screen that should hold the primary + menu bar or panel. + + As this changes the logical layout of the screen, ConfigureNotify + and RRScreenChangeNotify will be generated on the appropriate root + window when the primary output is changed by this call. This request + also generates RROutputChangeNotify events on the outputs that gained + and lost primary status. + + If an output is disconnected asynchronously (eg. due to recabling), + the primary status does not change, but RROutputChangeNotify events + will be generated if the hardware is capable of detecting this; + clients are expected to reconfigure if appropriate. + + If an output is deleted (eg. due to device hotplug), the server will + act as though None was passed to RRSetOutputPrimary, including + generating the appropriate events. + +┌─── + RRGetOutputPrimary + window: WINDOW + ▶ + output: OUTPUT +└─── + Errors: Window + + RRGetOutputPrimary returns the primary output for the screen. + + ❧❧❧❧❧❧❧❧❧❧❧ + +7.4 Extension Requests added in version 1.4 of the extension. + +┌─── + RRGetProviders + window : WINDOW + ▶ + timestamp: TIMESTAMP + providers: LISTofPROVIDER +└─── + Errors: Window + + RRGetProviders returns the list of providers connected to the screen + associated with 'window'. + + 'timestamp' indicates when the configuration was last set. + + 'providers' contains the list of PROVIDERs associated with the + screen. + +┌─── + RRGetProviderInfo + provider: PROVIDER + ▶ + capabilities: PROVIDER_CAPS + name: STRING + crtcs: LISTofCRTC + outputs: LISTofOUTPUT + associated_providers: LISTofPROVIDERS + associated_provider_capability: LISTofPROVIDER_CAPS +└─── + Errors: Provider + + RRGetProviderInfo return information about the specified provider. + The capabilities of the current provider are returned, along with + the list of providers currently associated with this provider and + the capability they are associated with. It also provides the list + of crtcs and outputs that this provider is responsible for. + + 'name' is a UTF-8 encoded string to be presented to the user to + indicate the device or driver supplied name. + +┌─── + RRSetProviderOffloadSink + provider: PROVIDER + sink_provider: PROVIDER + config-timestamp: TIMESTAMP +└─── + Errors: Provider + + RRSetOffloadSink sets the offload sink for this provider to the + specified provider. + +┌─── + RRSetProviderOutputSource + provider: PROVIDER + source_provider: PROVIDER + config-timestamp: TIMESTAMP +└─── + Errors: Provider + + RRSetOutputSource sets the output source for this provider to the + specified provider. + +┌─── + RRListProviderProperties + provider:PROVIDERS + ▶ + atoms: LISTofATOM +└─── + Errors: Provider + + This request returns the atoms of properties currently defined on + the provider. + +┌─── + RRQueryProviderProperty + provider: PROVIDER + property: ATOM + ▶ + pending: BOOL + range: BOOL + immutable: BOOL + valid-values: LISTofINT32 +└─── + Errors: Name, Atom, Provider + + If the specified property does not exist for the specified provider, + then a Name error is returned. + + If 'pending' is TRUE, changes made to property values with + RRChangeProviderProperty will be saved in the pending property value + and be automatically copied to the current value on the next + RRSetCrtcConfig request on a crtc attached to that provider. + If 'pending' is FALSE, changes are copied immediately. + + If 'range' is TRUE, then the valid-values list will contain + precisely two values indicating the minimum and maximum allowed + values. If 'range' is FALSE, then the valid-values list will contain + the list of possible values; attempts to set other values will + result in a Value error. + + If 'immutable' is TRUE, then the property configuration cannot be + changed by clients. Immutable properties are interpreted by the X + server. + +┌─── + RRConfigureProviderProperty + provider: PROVIDER + property: ATOM + pending: BOOL + range: BOOL + valid-values: LISTofINT32 +└─── + Errors: Access, Name, Atom, Provider + + If the specified property is 'immutable', an Access error is + returned. + + Otherwise, the configuration of the specified property is changed to + the values provided in this request. + + If the specified property does not exist for the specified provider, + it is created with an empty value and None type. + +┌─── + RRChangeProviderProperty + provider: PROVIDER + property, type: ATOM + format: {8, 16, 32} + mode: { Replace, Prepend, Append } + data: LISTofINT8 or LISTofINT16 or LISTofINT32 +└─── + Errors: Alloc, Atom, Match, Value, Provider + + This request alters the value of the property for the specified + provider. If the property is marked as a 'pending' property, only the + pending value of the property is changed. Otherwise, changes are + reflected in both the pending and current values of the property. + The type is uninterpreted by the server. The format specifies + whether the data should be viewed as a list of 8-bit, 16-bit, or + 32-bit quantities so that the server can correctly byte-swap as + necessary. + + If the mode is Replace, the previous property value is discarded. + If the mode is Prepend or Append, then the type and format must + match the existing property value (or a Match error results). If + the property is undefined, it is treated as defined with the correct + type and format with zero-length data. + + For Prepend, the data is tacked on to the beginning of the existing + data, and for Append, it is tacked on to the end of the existing data. + + This request generates a ProviderPropertyNotify + + The lifetime of a property is not tied to the storing client. + Properties remain until explicitly deleted, until the provider is + destroyed, or until server reset (see section 10). + + The maximum size of a property is server-dependent and may vary + dynamically. +┌─── + RRDeleteProviderProperty + provider: Provider + property: ATOM +└─── + Errors: Atom, Provider + + This request deletes the property from the specified provider if the + property exists and generates a ProviderPropertyNotify event unless + the property does not exist. + +┌─── + RRGetProviderProperty + provider: PROVIDER + property: ATOM + type: ATOM or AnyPropertyType + long-offset, long-length: CARD32 + delete: BOOL + pending: BOOL + ▶ + type: ATOM or None + format: {0, 8, 16, 32} + bytes-after: CARD32 + value: LISTofINT8 or LISTofINT16 or LISTofINT32 +└─── + Errors: Atom, Value, Provider + + If the specified property does not exist for the specified provider, + then the return type is None, the format and bytes-after are zero, + and the value is empty. The delete argument is ignored in this + case. + + If the specified property exists but its type does not match the + specified type, then the return type is the actual type of the + property, the format is the actual format of the property (never + zero), the bytes-after is the length of the property in bytes (even + if the format is 16 or 32), and the value is empty. The delete + argument is ignored in this case. + + If the specified property exists and either AnyPropertyType is + specified or the specified type matches the actual type of the + property, then the return type is the actual type of the property, + the format is the actual format of the property (never zero), and + the bytes-after and value are as follows, given: + + N = actual length of the stored property in bytes + (even if the format is 16 or 32) + I = 4 × offset + T = N - I + L = MINIMUM(T, 4 × long-length) + A = N - (I + L) + + If 'pending' is true, and if the property holds a pending value, + then the value returned will be the pending value of the property + rather than the current value. The returned value starts at byte + index I in the property (indexing from 0), and its length in bytes + is L. However, it is a Value error if long-offset is given such + that L is negative. The value of bytes-after is A, giving the + number of trailing unread bytes in the stored property. If delete + is True and the bytes-after is zero, the property is also deleted + from the provider, and a RRProviderPropertyNotify event is generated. + + + ❧❧❧❧❧❧❧❧❧❧❧ + +7.5. Extension Requests added in version 1.5 of the extension. + +┌─── + RRGetMonitors + window : WINDOW + get_active : BOOL + ▶ + timestamp: TIMESTAMP + monitors: LISTofMONITORINFO +└─── + Errors: Window + + Returns the list of Monitors for the screen containing + 'window'. If 'get_active' is set it returns only active + monitors (non-0x0 monitors). 'get_active' should always + be set by toolkits, and not by configuration clients. + + 'timestamp' indicates the server time when the list of + monitors last changed. + +┌─── + RRSetMonitor + window : WINDOW + info: MONITORINFO +└─── + Errors: Window, Output, Atom, Value + + Create a new monitor. Any existing Monitor of the same name is deleted. + + 'name' must be a valid atom or an Atom error results. + + 'name' must not match the name of any Output on the screen, or + a Value error results. + + If 'info.outputs' is non-empty, and if x, y, width, height are all + zero, then the Monitor geometry will be dynamically defined to + be the bounding box of the geometry of the active CRTCs + associated with them. + + If 'name' matches an existing Monitor on the screen, the + existing one will be deleted as if RRDeleteMonitor were called. + + If an 'info.output' contains only the automatically generated default + monitor, this is replaced by the new monitor. If the 'info.output' already + contains a user-defined monitor, the new monitor will be added. + This allows to have more than one monitor on an output (e.g. to split an + output into multiple virtual monitors). + + Only one monitor per screen may be primary. If 'info.primary' + is true, then the primary value will be set to false on all + other monitors on the screen. + + RRSetMonitor generates a ConfigureNotify event on the root + window of the screen. + +┌─── + RRDeleteMonitor + window : WINDOW + name: ATOM +└─── + Errors: Window, Atom, Value + + Deletes the named Monitor. + + 'name' must be a valid atom or an Atom error results. + + 'name' must match the name of a Monitor on the screen, or a + Value error results. + + If the last user-defined monitor is removed from an 'info.output', + the automatically generated default monitor will be restored. It is not + possible to delete the automatically generated default monitor. + + RRDeleteMonitor generates a ConfigureNotify event on the root + window of the screen. + + ❧❧❧❧❧❧❧❧❧❧❧ + +7.6. Extension Requests added in version 1.6 of the extension. + +┌─── + RRCreateLease + window : WINDOW + lid: LEASE + crtcs: LISTofCRTC + outputs: LISTofOUTPUT + ▶ + nfd: CARD8 + lease: FD +└─── + Errors: IdChoice, Window, Access, Value, CRTC, Output + + Creates a new Lease called 'lid' for the specified crtcs and + outputs from the screen defined by 'window'. Returns a KMS/DRM + file descriptor which can control the leased objects directly + through the kernel. While leased, all resources will appear to + be 'useless' to clients other than the leasing client as + follows: + + • Crtcs are reported as having no 'possible-outputs' and all + other values reported as if the crtc were disabled. + + • Outputs are reported as having no crtcs they can be + connected to, no clones they can share a crtc with, will + report a connection status of Disconnected, and will show + the current crtc as if it were disabled. + + The lease remains in effect until the file descriptor is + closed, even if the client holding the lease disconnects from + the X server. + + Returns an Access error if any of the named resources are + already leased to another client. + +┌─── + RRFreeLease + lid: LEASE + terminate: BOOL +└─── + Errors: Lease + + Frees the reference to the lease 'lid'. If 'terminate' is + true, then the lease is terminated and all leased resources + returned to the X server. If 'terminate' is false, then the + lease remains in effect, but the X server no longer has a name + for it. + + ❧❧❧❧❧❧❧❧❧❧❧ +8. Extension Events + +Clients MAY select for ConfigureNotify on the root window to be +informed of screen changes. This may be advantageous if all your +client needs to know is the size of the root window, as it avoids +round trips to set up the extension. + +RRScreenChangeNotify is sent if RRSelectInput has requested it +whenever properties of the screen change, which may be due to external +factors, such as re-cabling a monitor, etc. + +┌─── + RRScreenChangeNotify + + rotation: ROTATION; new rotation + sequenceNumber: CARD16 low 16 bits of request seq. number + timestamp: TIMESTAMP time screen was changed + configTimestamp: TIMESTAMP time config data was changed + root: WINDOW root window of screen + window: WINDOW window requesting notification + size-id: SIZEID index of new SCREENSIZE + subpixelOrder: SUBPIXELORDER order of subpixels + widthInPixels: CARD16 width in pixels of the new SCREENSIZE + heightInPixels: CARD16 height in pixels of the new SCREENSIZE + widthInMillimeters: CARD16 width in mm of the new SCREENSIZE + heightInMillimeters: CARD16 height in mm of the new SCREENSIZE +└─── + This event is generated whenever the screen configuration is changed + and sent to requesting clients. 'timestamp' indicates when the + screen configuration was changed. 'configTimestamp' says when the + last time the configuration was changed. 'root' is the root of the + screen the change occurred on, 'window' is window selecting for this + event. 'size-id' contains the index of the current size. + + This event is sent whenever the screen's configuration changes + or if a new screen configuration becomes available that was + not available in the past. In this case (config-timestamp in + the event not being equal to the config-timestamp returned in + the last call to RRGetScreenInfo), the client MUST call + RRGetScreenInfo to update its view of possible screen + configurations to have a correct view of possible screen + organizations. + + Clients which select screen change notification events may be + sent an event immediately if the screen configuration was + changed between when they connected to the X server and + selected for notification. This is to prevent a common race + that might occur on log-in, where many applications start up + just at the time when a display manager or log in script might + be changing the screen size or configuration. + + Note that the sizes in this event reflect the new SCREENSIZE and + thus will appear rotated by the 'rotation' parameter from the sizes + of the screen itself. In other words, when rotation is 90 or 270, + widthInPixels in this event will be the same as the height value + from a ConfigureNotify that reflects the same size change. This + will probably confuse developers. + +8.1 Events added in version 1.2 of the RandR extension + +┌─── + RROutputChangeNotify: + timestamp: TIMESTAMP time screen was reconfigured + config-timestamp: TIMESTAMP time available config data was changed + window: WINDOW window requesting notification + output: OUTPUT output affected by change + crtc: CRTC connected CRTC or None + mode: MODE mode in use on CRTC or None + connection: CONNECTION connection status +└─── + + This event is generated whenever the available output configurations + have changed and is sent to requesting clients. 'timestamp' + indicates when the crtc configuration was changed by a client. + 'config-timestamp' says when the last time the available + configurations changed. 'root' is the root of the screen the change + occurred on, 'window' is window selecting for this event. The + precise change can be detected by examining the new state of the + system. + + Changes in version 1.6 of the protocol: + + When a “non-desktop” device is connected, this event will be + delivered when the connection status of the output changes, + however the 'connection' value will be set to 'Disconnected'. + +┌─── + RROutputPropertyNotify: + window: WINDOW window requesting notification + output: OUTPUT output affected by change + atom: ATOM affected property + time: TIMESTAMP time property was changed + subpixel-order: SUBPIXELORDER order of subpixels + state: { NewValue, Deleted } new property state +└─── + + This event is reported to clients selecting RROutputPropertyChange + on the window and is generated with state NewValue when a property + of the window is changed using RRChangeOutputProperty even when + adding zero-length data and when replacing all or part of a property + with identical data. It is generated with state Deleted when a + property of the window is deleted using either + RRDeleteOutputProperty or RRGetOutputProperty. The timestamp + indicates the server time when the property was changed. + +┌─── + RRCrtcChangeNotify + timestamp: TIMESTAMP time monitor was changed + window: WINDOW window requesting notification + crtc: CRTC CRTC which changed + mode: MODE new mode + rotation: ROTATION; new rotation + x: INT16 x position of CRTC within screen + y: INT16 y position of CRTC within screen + width: CARD16 width of new configuration + height: CARD16 height of new configuration +└─── + This event is generated whenever the CRTC configuration is changed + and sent to requesting clients. 'timestamp' indicates when the + CRTC configuration was changed. 'window' is window selecting for this + event. 'mode' is the new mode, or None if the crtc is disabled. + 'x' and 'y' mark the location in the screen where this CRTC + is reading data. 'width' and 'height' indicate the size of the + CRTC viewport, which is the mode size adjusted by the optional + Border output property described below. 'x', 'y, 'width' and + 'height' are all zero when 'mode' is None. + + This event is sent whenever the monitor's configuration changes + or if a new monitor configuration becomes available that was + not available in the past. In this case, the client MUST call + RRGetCrtcInfo to update its view of possible monitor + configurations to have a correct view of possible monitor + organizations. + + Clients which select monitor change notification events may be + sent an event immediately if the monitor configuration was + changed between when they connected to the X server and + selected for notification. This is to prevent a common race + that might occur on log-in, where many applications start up + just at the time when a display manager or log in script might + be changing the monitor size or configuration. + +8.2 Events added in version 1.4 of the RandR extension + +┌─── + RRProviderChangeNotify: + timestamp: TIMESTAMP time screen was reconfigured + window: WINDOW window requesting notification + provider: PROVIDER provider affected by change +└─── + + This event is generated whenever the role for a provider has changed + and is sent to requesting clients. 'timestamp' indicates when the + provider configuration was changed by a client. 'window' is the + window selecting for this event. The precise change can be detected + by examining the new state of the system. + +┌─── + RRProviderPropertyNotify: + window: WINDOW window requesting notification + provider: PROVIDER provider affected by change + atom: ATOM affected property + time: TIMESTAMP time property was changed + state: { NewValue, Deleted } new property state +└─── + + This event is reported to clients selecting RRProviderPropertyChange + on the window and is generated with state NewValue when a property + of the window is changed using RRChangeProviderProperty even when + adding zero-length data and when replacing all or part of a property + with identical data. It is generated with state Deleted when a + property of the window is deleted using either + RRDeleteProviderProperty or RRGetProviderProperty. The timestamp + indicates the server time when the property was changed. + +┌─── + RRResourceChangeNotify: + window: WINDOW window requesting notification + time: TIMESTAMP time property was changed +└─── + + This event is reported to clients selecting RRResourceChange + on the window and is generated whenever the set of available + RandR resources associated with the screen has changed, either + created or destroyed. Querying the list of available resources + with RRGetScreenResources and RRGetProviders will return the new set. + +8.3 Events added in version 1.6 of the RandR extension + +┌─── + RRLeaseNotify: + timestamp : TIMESTAMP time screen was reconfigured + window : WINDOW window requesting notification + lease : LEASE lease + created : BOOL created/destroyed indicator +└─── + + This event is generated whenever a lease has been created or + destroyed and is sent to requesting clients. 'timestamp' + indicates when the change happened. 'window' is the window + selecting for this event. + + ❧❧❧❧❧❧❧❧❧❧❧ + +9. Properties + +Properties are used for output specific parameters, and for announcing +static or rarely changing data. Announced data is typically +immutable. Properties are also used for evaluating new parameters +before adding them to the RandR protocol. + +The following properties are hereby declared official, and drivers SHOULD +prefix driver specific properties with '_', unless they are planned to be +added to this specification. List values, that are not declared by the table +below, and will remain driver specific or are not planned to be added to this +specification, SHOULD be prefixed with "_" as well in order to avoid name +space or semantics clashes with future extensions of these values. + +Beginning with version 1.3 of the RandR extension, certain properties +are mandatory and MUST be provided by implementations. Earlier +versions of the RandR extension MAY provide these properties as well, +as long as the semantics are not altered. Clients SHOULD fall back +gracefully to lower version functionality, though, if the driver +doesn't handle a mandatory property correctly. + +Changes in version 1.6 of the protocol: + +When a “non-desktop” device is connected, the property information +will be correct for the device, even though RRGetOutputInfo +reports the device as disconnected. The “non-desktop” property will be +set to 1 for such devices and not present on other devices. + +9.1 Known properties + + "Backlight" aka RR_PROPERTY_BACKLIGHT + Type: INTEGER + Format: 32 + Num. items: 1 + Flags: - + Range/List: 0-x (driver specific) + + This property controls the brightness on laptop panels and equivalent + displays with a backlight controller. The driver specific maximum + value MUST turn the backlight to full brightness, 1 SHOULD turn the + backlight to minimum brightness, 0 SHOULD turn the backlight off. + + "CloneList" aka RR_PROPERTY_CLONE_LIST + Type: ATOM + Format: 32 + Num. items: 2*n + Flags: Immutable + Range/List: 0- + + Some combinations of outputs on some cards cannot be served + independently from each other, because they are wired up to the same + encoder outputs. + This property lists all output + signal format pairs that are + driven together with this output, and thus can only be programmed in + clone mode with the same CRTC. + This property MUST be symmetric, but may change with changing signal + format. I.e. if the property for DVI-1/VGA specifies VGA-1/VGA to be + cloned, VGA-1/VGA has to list DVI-1/VGA as well. + Outputs / format pairs listed in this property MUST be included in the + CompatibilityList. + + "CompatibilityList" aka RR_PROPERTY_COMPATIBILITY_LIST + Type: ATOM + Format: 32 + Num items: 2*n + Flags: Immutable + Range/List: 0- + + Some combinations of outputs on some cards cannot be served at all, + because the according encoder is only capable of driving one output at + a time. + This property lists all output + signal format pairs that can be + driven together with this output. NULL atoms specify any output / any + signal format, respectively. + This property MUST be symmetric, but may change with changing signal + format. I.e. if the property for DVI-1/TMDS specifies VGA-1/VGA to be + available, VGA-1/VGA has to list DVI-1/TMDS as well. + + "ConnectorNumber" aka RR_PROPERTY_CONNECTOR_NUMBER + Type: INTEGER + Format: 32 + Num items: 1 + Flags: Immutable, Static + Range/List: 0- + + Outputs that route their signal to the same connector MUST + have the same connector number. Outputs with the same + connector number MUST route their signal to the same + connector, except if it is 0, which indicates unknown + connectivity. 1 is called the primary connector, 2 the + secondary. 3 is typically a TV connector, but that is completely + driver / hardware dependent. + Outputs with the same connector number SHOULD have the same + connector type. Meaning and client behavior for mismatching + connector types is undefined at the moment. + + "ConnectorType" aka RR_PROPERTY_CONNECTOR_TYPE + Type: ATOM + Format: 32 + Num items: 1 + Flags: Immutable, Static + Range/List: unknown VGA DVI DVI‐I DVI‐A DVI‐D HDMI Panel + TV TV-Composite TV-SVideo TV-Component + TV-SCART TV-C4 DisplayPort + + Connector type, as far as known to the driver. + Values with dashes (TV‐Composite) describe more specific versions of + the base values (TV). The former SHOULD be used if the connector is + not capable of producing other signal formats. The later SHOULD be + used if the exact connector is unknown, or the connector is a + multi‐format connector that is not described otherwise. DVI, for + instance, SHOULD be handled like a DVI‐I connector, unless additional + information is available to the user agent. PANEL describes + laptop‐internal (normally LVDS) displays. TV, TV‐SCART, TV‐Component, + and TV‐C4 with signal format VGA are valid combinations and describe + RGB TV signals. + + "EDID" aka RR_PROPERTY_RANDR_EDID + Type: INTEGER + Format: 8 + Num items: n + Flags: Immutable + Range/List: - + + Raw EDID data from the device attached to the according + output. Should include main EDID data and all extension + blocks. Previously known as EdidData. + + “non-desktop” aka RR_PROPERTY_NON_DESKTOP + Type: INTEGER + Format: 32 + Num items: 1 + Flags Immutable + Range/List: 0-1 + + Indicates whether the device attached to this output should not + be considered part of the normal desktop. When set to 0 or not + present, the output should be presented as part of the + desktop. + + When set to 1, the output should not be presented as part of + the desktop. To not present an output as part of the desktop, + the normal desktop environment should not be shown on this + output, nor should desktop applications be positioned on it. + + When set to 1, RRGetOutputInfo will always report connection status + Disconnected, but RROutputChangeNotify events will still be + delivered when the connection status changes and all other + information about the output and connected device will be + reported correctly. + + "SignalFormat" aka RR_PROPERTY_SIGNAL_FORMAT + Type: ATOM + Format: 32 + Num items: 1 + Flags: - + Range/List: unknown VGA TMDS LVDS Composite Composite-PAL + Composite-NTSC Composite-SECAM SVideo + Component DisplayPort + + Signal format / physical protocol format that is used for the + specified output. valid-values lists all possible formats on this + output, which SHOULD be a subset of the list above and MUST be static. + Values with dashes (Composite-PAL) describe more specific versions of + the base values (Composite) and SHOULD be used if known to the driver. + A driver MAY change this property of an output if the underlying + hardware indicates a protocol change (e.g. TV formats). Clients are + allowed to change the signal format in order to select a different + signal format (e.g. Composite etc.) or physical protocol (e.g. VGA or + TMDS on DVI-I). + Laptop panels SHOULD not be detected with this property, but rather by + ConnectorType. + + "SignalProperties" aka RR_PROPERTY_SIGNAL_FORMAT + Type: ATOM + Format: 32 + Num items: n + Flags: - + Range/List: For Composite signals: + NTSC NTSC-M NTSC-J NTSC-N NTSC-4.43 NTSC-film + PAL PAL-B PAL-G PAL-H PAL-H PAL-I PAL-M PAL-D + PAL-N PAL-Nc PAL-L PAL-60 + SECAM SECAM-L SECAM-B SECAM-G SECAM-D SECAM-K + SECAM-H SECAM-K + For TMDS signals: + SingleLink DualLink + For DisplayPort signals: + Lane1 Lane2 Lane4 LowSpeed HiSpeed + + Properties of the signal format that is currently used for the + specified output. valid-values lists all possible properties on this + output, which SHOULD be a subset of the list above. It will change if + SignalFormat changes. Multiple properties are allowed. + Values with dashes (PAL-B) describe more specific versions of the base + values (PAL) and SHOULD be used if known to the driver. A driver MAY + change this property of an output if the underlying hardware indicates + a signal change (e.g. TV formats). Clients are allowed to change the + properties in order to select a different signal subformat. + + "Border" aka RR_PROPERTY_BORDER + Type: CARDINAL + Format: 16 + Num items: 0, 1, 2, or 4 + Flags: Immutable + Range/List: 0- + + This property is a list of integers specifying adjustments for the edges + of the displayed image. How this property is applied depends on the + number of elements in the list: + + 0 = No border is applied + 1 = A border of Border[0] is applied to all four sides of the image. + 2 = A border of Border[0] is applied to the left and right sides of + the image, and a border of Border[1] is applied to the top and + bottom. + 4 = The border dimensions are as follows: + Border[0]: left + Border[1]: top + Border[2]: right + Border[3]: bottom + + Note that how many configuration dimensions are actually supported is + specified by the BorderDimensions property described below. If more than + BorderDimensions values are specified, the extra values are ignored. + + These border dimensions shrink the region of pixels displayed by the + CRTC by the corresponding number of rows or columns, and is applied + after the CRTC transform. For example, a mode with a 1920x1080 active + region, border dimensions of [ 10, 20, 30, 40 ], and a ½x scaling + transform would display a rectangle of 940x510 pixels from the scanout + pixmap scaled to 1880x1020 raster pixels positioned at (10, 20) in + display raster space. + + Raster pixels in the border are black. + + This property is created with pending == TRUE, so changes are not + applied immediately and instead take effect at the next RRSetCrtcConfig. + + If multiple outputs with different border settings are bound to the same + CRTC when the configuration is changed, the behavior is undefined. + + If the length of the property is less than four when the CRTC is + configured, the missing values are assumed to be zero. If the length is + greater than four, the extra values are ignored. + + If the width of the mode is less than or equal to the sum of the left + and right borders, then the left and right border settings are ignored. + Likewise, if the height of the mode is less than or equal to the sum of + the top and bottom borders, the top and bottom borders are ignored. + + "BorderDimensions" aka RR_PROPERTY_BORDER_DIMENSIONS + Type: CARDINAL + Format: 8 + Num items: 1 + Flags: Immutable, Static + Range/List: 0, 1, 2, or 4 + + This property lists how many border adjustment parameters can actually + be used: + + 0 = no borders are supported + 1 = a single border value is applied to all four sides of the image + 2 = left/right and top/bottom borders can be specified independently + 4 = all four borders can be specified independently + + "GUID" aka RR_PROPERTY_GUID + Type: INTEGER + Format: 8 + Num items: 16 + Flags: Immutable + Range/List: - + + Some display devices, such as DisplayPort 1.2 devices, have globally + unique identifiers. When such an identifier is available, this property + contains its raw bytes. + + "TILE" aka RR_PROPERTY_RANDR_TILE + Type: INTEGER + Format: 32 + Num items: 8 + Flags: Immutable + Range/List: - + + Tile monitors have an array of values describing the tiling, + based on DisplayID v1.3 + + The 8 elements are: + 0: group id - The tile group identifier + 1: flags - flags for tile group + 0x1 = single monitor enclosure + 2: number of horizontal tiles in tile group + 3: number of vertical tiles in tile group + 4: horizontal tile location for this tile + 5: vertical tile location for this tile + 6: horizontal tile size for this tile + 7: vertical tile size for this tile + +9.2 Properties introduced with version 1.2 of the RandR extension + +Property Immutable Mandatory since +──────── ───────── ─────────────── +EDID yes n/a + +EDID is provided by the RandR frontend, thus not driver specific. + + +9.3 Properties introduced with version 1.3 of the RandR extension + +Property Immutable Mandatory since +──────── ───────── ─────────────── +CloneList yes not mandatory +CompatibilityList yes not mandatory +ConnectorNumber yes: static not mandatory +ConnectorType yes: static RandR 1.3 +SignalFormat no RandR 1.3 +SignalProperties no not mandatory + +9.4 Properties introduced with version 1.3.1 of the RandR extension + +Property Immutable Mandatory since +──────── ───────── ─────────────── +Backlight no not mandatory + +9.5 Properties introduced with version 1.4.0 of the RandR extension + +Property Immutable Mandatory since +──────── ───────── ─────────────── +Border yes not mandatory +BorderDimensions yes: static not mandatory + +9.6 Properties introduced with version 1.4.1 of the RandR extension + +Property Immutable Mandatory since +──────── ───────── ─────────────── +GUID yes not mandatory + +9.7 Properties introduced with version 1.5 of the RandR extension + +Property Immutable Mandatory since +──────── ───────── ─────────────── +TILE yes not mandatory + +9.8 Properties introduced with version 1.6 of the RandR extension + +Property Immutable Mandatory since +──────── ───────── ─────────────── +non-desktop yes not mandatory + + ❧❧❧❧❧❧❧❧❧❧❧ + +10. Extension Versioning + +The RandR extension was developed in parallel with the implementation +to ensure the feasibility of various portions of the design. As +portions of the extension are implemented, the version number of the +extension has changed to reflect the portions of the standard provided. +This document describes the version 1.4 of the specification, the +partial implementations have version numbers less than that. Here's a +list of what each version provided: + + 0.0: This prototype implemented resize and rotation in the + TinyX server Used approximately the protocol described in + the Usenix paper. Appeared in the TinyX server in + XFree86 4.2, but not in the XFree86 main server. + + 0.1: Added subpixel order, added an event for subpixel order. + This version was never checked in to XFree86 CVS. + + 1.0: Implements resize, rotation, and reflection. Implemented + both in the XFree86 main server (size change only at this + date), and fully (size change, rotation, and reflection) + in XFree86's TinyX server. + + 1.1: Added refresh rates + + 1.2: Separate screens from CRTCs and outputs, switch to full VESA + modes + + 1.3: Added cheap version of RRGetScreenResources. Added CRTC + transformations. Added panning. Added primary outputs. + Added standard properties. + + 1.4: Added provider objects for handling multi-GPU systems. + + 1.5: Added Monitors + + 1.6: Added Leases and non-desktop output information. + +Compatibility between 0.0 and 1.0 was *NOT* preserved, and 0.0 clients +will fail against 1.0 servers. The wire encoding op-codes were +changed for GetScreenInfo to ensure this failure in a relatively +graceful way. Version 1.1 servers and clients are cross compatible with +1.0. Version 1.1 is considered to be stable and we intend upward +compatibility from this point. Version 1.2 offers an extended model of the +system with multiple output support. Version 1.3 adds a cheap version of +GetScreenResources to avoid expensive DDC operations, CRTC transformations, +panning, and the primary output concept. Versions 1.2 through 1.6 are +backward-compatible with 1.1. + + ❧❧❧❧❧❧❧❧❧❧❧ + +11. Relationship with other extensions + +Two other extensions have a direct relationship with this extension. This +section attempts to explain how these three are supposed to work together. + +11.1 XFree86-VidModeExtension + +XFree86-VidModeExtension changes the configuration of a single monitor +attached to the screen without changing the configuration of the screen +itself. It provides the ability to specify new mode lines for the server to +use along with selecting among existing mode lines. As it uses screen +numbers instead of window identifiers, it can be used to affect multiple +monitors in a single-screen Xinerama configuration. However, the association +between screen numbers and root windows in a multi-Screen environment is not +defined by the extension. Version 2.0 of this extension added the ability to +adjust the DAC values in a TrueColor server to modify the brightness curves +of the display. + +All of the utility of this extension is subsumed by RandR version 1.2, RandR +should be used in preference to XFree86-VidModeExtension where both are +present. + +11.2 Xinerama + +Xinerama provides a mechanism for describing the relationship between the +overall screen display and monitors placed within that area. As such, it +provides the query functionality of RandR 1.2 without any of the +configuration functionality. Applications using Xinerama to discover +monitor geometry can continue to do so, with the caveat that they will not be +informed of changes when they occur. However, Xinerama configuration data +will be updated, so applications selecting for RandR notification and +re-querying the configuration with the Xinerama extension will get updated +information. It is probably better to view RandR as a superset of Xinerama +at this point and use it in preference to Xinerama where both are present. + + ❧❧❧❧❧❧❧❧❧❧❧ + +Appendix A. Protocol Encoding + +Syntactic Conventions + +This document uses the same syntactic conventions as the core X +protocol encoding document. + +A.1 Common Types + +┌─── + ROTATION + 0x0001 Rotate_0 + 0x0002 Rotate_90 + 0x0004 Rotate_180 + 0x0008 Rotate_270 + 0x0010 Reflect_X + 0x0020 Reflect_Y +└─── + Used to encode both sets of possible rotations and individual + selected rotations. + +┌─── + RRSELECTMASK + 0x0001 ScreenChangeNotifyMask + 0x0002 CrtcChangeNotifyMask Added in version 1.2 + 0x0004 OutputChangeNotifyMask Added in version 1.2 + 0x0008 OutputPropertyNotifyMask Added in version 1.2 + 0x0010 ProviderChangeNotifyMask Added in version 1.4 + 0x0020 ProviderPropertyNotifyMask Added in version 1.4 + 0x0040 ResourceChangeNotifyMask Added in version 1.4 + 0x0080 LeaseNotifyMask Added in version 1.6 + +└─── + Event select mask for RRSelectInput + +┌─── + RRCONFIGSTATUS + 0x0 Success + 0x1 InvalidConfigTime + 0x2 InvalidTime + 0x3 Failed +└─── + Return status for requests which depend on time. + +┌─── + MODEINFO (32) Added in version 1.2 + 4 CARD32 id + 2 CARD16 width in pixels + 2 CARD16 height in pixels + 4 CARD32 dot clock + 2 CARD16 h sync start + 2 CARD16 h sync end + 2 CARD16 h total + 2 CARD16 h skew + 2 CARD16 v sync start + 2 CARD16 v sync end + 2 CARD16 v total + 2 CARD16 name length + 4 SETofMODEFLAG mode flags +└─── + + An output mode specifies the complete CRTC timings for + a specific mode. The vertical and horizontal synchronization rates + can be computed given the dot clock and the h total/v total + values. If the dot clock is zero, then all of the timing + parameters and flags are not used, and must be zero as this + indicates that the timings are unknown or otherwise unused. + The name itself will be encoded separately in each usage. + +┌─── + MODEFLAG + 0x00000001 HSyncPositive + 0x00000002 HSyncNegative + 0x00000004 VSyncPositive + 0x00000008 VSyncNegative + 0x00000010 Interlace + 0x00000020 DoubleScan + 0x00000040 CSync + 0x00000080 CSyncPositive + 0x00000100 CSyncNegative + 0x00000200 HSkewPresent + 0x00000400 BCast + 0x00000800 PixelMultiplex + 0x00001000 DoubleClock + 0x00002000 ClockDivideBy2 +└─── +┌─── + CONNECTION + 0 Connected + 1 Disconnected + 2 UnknownConnection +└─── + +┌─── + PROVIDER_CAPS Added in version 1.4 + 0x00000001 SourceOutput + 0x00000002 SinkOutput + 0x00000004 SourceOffload + 0x00000008 SinkOffload +└─── + +A.1.1 Common Types added in version 1.5 of the protocol + +┌─── + MONITORINFO (16 + 4*n) + 4 ATOM name + 1 BOOL primary + 1 BOOL automatic + 2 CARD16 noutputs + 2 INT16 x + 2 INT16 y + 2 CARD16 width in pixels + 2 CARD16 height in pixels + 4 CARD32 width in millimeters + 4 CARD32 height in millimeters + 4*n OUTPUT outputs +└─── + +A.2 Protocol Requests + +Opcodes 1 and 3 were used in the 0.0 protocols, and will return +errors if used in version 1.0. + +┌─── + RRQueryVersion + + 1 CARD8 major opcode + 1 0 RandR opcode + 2 3 length + 4 CARD32 major version + 4 CARD32 minor version + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 1 CARD32 major version + 1 CARD32 minor version +└─── +┌─── + RRSetScreenConfig + + 1 CARD8 major opcode + 1 2 RandR opcode + 2 6 length + 4 WINDOW window on screen to be configured + 4 TIMESTAMP timestamp + 4 TIMESTAMP config timestamp + 2 SIZEID size index + 2 ROTATION rotation/reflection + 2 CARD16 refresh rate (1.1 only) + 2 CARD16 pad + ▶ + 1 1 Reply + 1 RRCONFIGSTATUS status + 2 CARD16 sequence number + 4 0 reply length + 4 TIMESTAMP new timestamp + 4 TIMESTAMP new configuration timestamp + 4 WINDOW root + 2 SUBPIXELORDER subpixel order defined in Render + 2 CARD16 pad4 + 4 CARD32 pad5 + 4 CARD32 pad6 +└─── +┌─── + RRSelectInput + + 1 CARD8 major opcode + 1 4 RandR opcode + 2 3 length + 4 WINDOW window + 2 SETofRRSELECTMASK enable + 2 CARD16 pad +└─── +┌─── + RRGetScreenInfo + + 1 CARD8 major opcode + 1 5 RandR opcode + 2 2 length + 4 WINDOW window + ▶ + 1 1 Reply + 1 CARD8 set of Rotations + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW root window + 4 TIMESTAMP timestamp + 4 TIMESTAMP config timestamp + 2 CARD16 number of SCREENSIZE following + 2 SIZEID current size index + 2 ROTATION current rotation and reflection + 2 CARD16 current rate (added in version 1.1) + 2 CARD16 length of rate info (number of CARD16s) + 2 CARD16 pad + + SCREENSIZE + 2 CARD16 width in pixels + 2 CARD16 height in pixels + 2 CARD16 width in millimeters + 2 CARD16 height in millimeters + + REFRESH + 2 CARD16 number of rates (n) + 2n CARD16 rates +└─── + +A.2.1 Protocol Requests added with version 1.2 + +┌─── + RRGetScreenSizeRange + 1 CARD8 major opcode + 1 6 RandR opcode + 2 2 length + 4 WINDOW window + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 minWidth + 2 CARD16 minHeight + 2 CARD16 maxWidth + 2 CARD16 maxHeight + 16 unused +└─── +┌─── + RRSetScreenSize + 1 CARD8 major opcode + 1 7 RandR opcode + 2 5 length + 4 WINDOW window + 2 CARD16 width + 2 CARD16 height + 4 CARD32 width in millimeters + 4 CARD32 height in millimeters +└─── +┌─── + RRGetScreenResources + 1 CARD8 major opcode + 1 8 RandR opcode + 2 2 length + 4 WINDOW window + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 c+o+8m+(b+p)/4 reply length + 4 TIMESTAMP timestamp + 4 TIMESTAMP config-timestamp + 2 c number of CRTCs + 2 o number of outputs + 2 m number of modeinfos + 2 b total bytes in mode names + 8 unused + 4c LISTofCRTC crtcs + 4o LISTofOUTPUT outputs + 32m LISTofMODEINFO modeinfos + b STRING8 mode names + p unused, p=pad(b) +└─── +┌─── + RRGetOutputInfo + 1 CARD8 major opcode + 1 9 RandR opcode + 2 3 length + 4 OUTPUT output + 4 TIMESTAMP config-timestamp + ▶ + 1 1 Reply + 1 RRCONFIGSTATUS status + 2 CARD16 sequence number + 4 1+c+m+(n+p)/4 reply length + 4 TIMESTAMP timestamp + 4 CRTC current connected crtc + 4 CARD32 width in millimeters + 4 CARD32 height in millimeters + 1 CONNECTION connection + 1 SUBPIXELORDER subpixel-order + 2 c number of CRTCs + 2 m number of modes + 2 p number of preferred modes + 2 o number of clones + 2 n length of name + 4c LISTofCRTC crtcs + 4m LISTofMODE modes + 4o LISTofOUTPUT clones + n STRING8 name + p unused, p=pad(n) +└─── +┌─── + RRListOutputProperties + 1 CARD8 major opcode + 1 10 RandR opcode + 2 2 length + 4 OUTPUT output + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 2 n number of ATOMs in atoms + 22 unused + 4n LISTofATOM atoms +└─── +┌─── + RRQueryOutputProperty + 1 CARD8 major opcode + 1 11 RandR opcode + 2 3 request length + 4 OUTPUT output + 4 ATOM property + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 1 BOOL pending + 1 BOOL range + 1 BOOL immutable + 21 unused + 4n LISTofINT32 valid values +└─── +┌─── + RRConfigureOutputProperty + 1 CARD8 major opcode + 1 12 RandR opcode + 2 4+n request length + 4 OUTPUT output + 4 ATOM property + 1 BOOL pending + 1 BOOL range + 2 unused + 4n LISTofINT32 valid values +└─── +┌─── + RRChangeOutputProperty + 1 CARD8 major opcode + 1 13 RandR opcode + 2 6+(n+p)/4 request length + 4 OUTPUT output + 4 ATOM property + 4 ATOM type + 1 CARD8 format + 1 mode + 0 Replace + 1 Prepend + 2 Append + 2 unused + 4 CARD32 length of data in format units + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) + n LISTofBYTE data + (n is a multiple of 2 for format = 16) + (n is a multiple of 4 for format = 32) + p unused, p=pad(n) +└─── +┌─── + RRDeleteOutputProperty + 1 CARD8 major opcode + 1 14 RandR opcode + 2 3 request length + 4 OUTPUT output + 4 ATOM property +└─── +┌─── + RRGetOutputProperty + 1 CARD8 major opcode + 1 15 RandR opcode + 2 7 request length + 4 OUTPUT output + 4 ATOM property + 4 ATOM type + 0 AnyPropertyType + 4 CARD32 long-offset + 4 CARD32 long-length + 1 BOOL delete + 1 BOOL pending + 2 unused + ▶ + 1 1 Reply + 1 CARD8 format + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 4 ATOM type + 0 None + 4 CARD32 bytes-after + 4 CARD32 length of value in format units + (= 0 for format = 0) + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) + 12 unused + n LISTofBYTE value + (n is zero for format = 0) + (n is a multiple of 2 for format = 16) + (n is a multiple of 4 for format = 32) + p unused, p=pad(n) +└─── +┌─── + RRCreateMode + 1 CARD8 major opcode + 1 16 RandR opcode + 2 10+(n+p)/4 length + 4 WINDOW window + 32 MODEINFO mode + n STRING8 mode name + p unused, p=pad(n) + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 MODE mode + 20 unused +└─── +┌─── + RRDestroyMode + 1 CARD8 major opcode + 1 17 RandR opcode + 2 2 length + 4 MODE mode +└─── +┌─── + RRAddOutputMode + 1 CARD8 major opcode + 1 18 RandR opcode + 2 3 length + 4 OUTPUT output + 4 MODE mode +└─── +┌─── + RRDeleteOutputMode + 1 CARD8 major opcode + 1 19 RandR opcode + 2 3 length + 4 OUTPUT output + 4 MODE mode +└─── +┌─── + RRGetCrtcInfo + 1 CARD8 major opcode + 1 20 RandR opcode + 2 3 length + 4 CRTC crtc + 4 TIMESTAMP config-timestamp + ▶ + 1 1 Reply + 1 RRCONFIGSTATUS status + 2 CARD16 sequence number + 4 o+p reply length + 4 TIMESTAMP timestamp + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 4 MODE mode + 2 ROTATION current rotation and reflection + 2 ROTATION set of possible rotations + 2 o number of outputs + 2 p number of possible outputs + 4o LISTofOUTPUT outputs + 4p LISTofOUTPUT possible outputs +└─── +┌─── + RRSetCrtcConfig + 1 CARD8 major opcode + 1 21 RandR opcode + 2 7+n length + 4 CRTC crtc + 4 TIMESTAMP timestamp + 4 TIMESTAMP config timestamp + 2 INT16 x + 2 INT16 y + 4 MODE mode + 2 ROTATION rotation/reflection + 2 unused + 4n LISTofOUTPUT outputs + ▶ + 1 1 Reply + 1 RRCONFIGSTATUS status + 2 CARD16 sequence number + 4 0 reply length + 4 TIMESTAMP new timestamp + 20 unused +└─── +┌─── + RRGetCrtcGammaSize + 1 CARD8 major opcode + 1 22 RandR opcode + 2 2 length + 4 CRTC crtc + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 size + 22 unused +└─── +┌─── + RRGetCrtcGamma + 1 CARD8 major opcode + 1 23 RandR opcode + 2 2 length + 4 CRTC crtc + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 (6n+p)/4 reply length + 2 n size + 20 unused + 2n LISTofCARD16 red + 2n LISTofCARD16 green + 2n LISTofCARD16 blue + p unused, p=pad(6n) +└─── +┌─── + RRSetCrtcGamma + 1 CARD8 major opcode + 1 24 RandR opcode + 2 3+(6n+p)/4 length + 4 CRTC crtc + 2 n size + 2 unused + 2n LISTofCARD16 red + 2n LISTofCARD16 green + 2n LISTofCARD16 blue + p unused, p=pad(6n) +└─── + +A.2.2 Protocol Requests added with version 1.3 + +┌─── + RRGetScreenResourcesCurrent + 1 CARD8 major opcode + 1 25 RandR opcode + 2 2 length + 4 WINDOW window + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 c+o+8m+(b+p)/4 reply length + 4 TIMESTAMP timestamp + 4 TIMESTAMP config-timestamp + 2 c number of CRTCs + 2 o number of outputs + 2 m number of modeinfos + 2 b total bytes in mode names + 8 unused + 4c LISTofCRTC crtcs + 4o LISTofOUTPUT outputs + 32m LISTofMODEINFO modeinfos + b STRING8 mode names + p unused, p=pad(b) +└─── + +┌─── + RRSetCrtcTransform + 1 CARD8 major opcode + 1 26 RandR opcode + 2 12+(n+p)/4+v length + 4 CRTC crtc + 36 TRANSFORM transform + 2 CARD16 filter length + 2 unused + n STRING8 filter name + p unused, p=pad(n) + 4v FIXED filter params +└─── + +┌─── + RRGetCrtcTransform + 1 CARD8 major opcode + 1 27 RandR opcode + 2 2 length + 4 CRTC crtc + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 16+(pn+pnp)/4+(cn+cnp)/4+pf+cf reply length + 36 TRANSFORM pending transform + 1 BOOL has transforms + 3 unused + 36 TRANSFORM current transform + 4 unused + 2 pn pending filter name length + 2 pf pending filter num params + 2 cn current filter name length + 2 cf current filter num params + pn STRING8 pending filter name + pnp unused, pnp=pad(pn) + 4*pf FIXED pending filter params + cn STRING8 current filter name + cnp unused, cnp=pad(cn) + 4*cf FIXED current filter params +└─── + +┌─── + RRGetPanning + 1 CARD8 major opcode + 1 28 RandR opcode + 2 2 length + 4 CRTC crtc + ▶ + 1 1 Reply + 1 RRCONFIGSTATUS status + 2 CARD16 sequence number + 4 1 reply length + 4 TIMESTAMP timestamp + 2 CARD16 left + 2 CARD16 top + 2 CARD16 width + 2 CARD16 height + 2 CARD16 track_left + 2 CARD16 track_top + 2 CARD16 track_width + 2 CARD16 track_height + 2 INT16 border_left + 2 INT16 border_top + 2 INT16 border_right + 2 INT16 border_bottom +└─── +┌─── + RRSetPanning + 1 CARD8 major opcode + 1 29 RandR opcode + 2 9 length + 4 CRTC crtc + 4 TIMESTAMP timestamp + 2 CARD16 left + 2 CARD16 top + 2 CARD16 width + 2 CARD16 height + 2 CARD16 track_left + 2 CARD16 track_top + 2 CARD16 track_width + 2 CARD16 track_height + 2 INT16 border_left + 2 INT16 border_top + 2 INT16 border_right + 2 INT16 border_bottom + ▶ + 1 1 Reply + 1 RRCONFIGSTATUS status + 2 CARD16 sequence number + 4 0 reply length + 4 TIMESTAMP new timestamp + 20 unused +└─── + +┌─── + RRSetOutputPrimary + 1 CARD8 major opcode + 1 30 RandR opcode + 2 3 length + 4 WINDOW window + 4 OUTPUT output +└─── + +┌─── + RRGetOutputPrimary + 1 CARD8 major opcode + 1 31 RandR opcode + 2 2 length + 4 WINDOW window + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 CARD32 length + 4 OUTPUT output + 4 CARD32 pad1 + 4 CARD32 pad2 + 4 CARD32 pad3 + 4 CARD32 pad4 +└─── + +A.2.3 Protocol Requests added with version 1.4 + +┌─── + RRGetProviders + 1 CARD8 major opcode + 1 32 RandR opcode + 2 2 length + 4 WINDOW window + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 p length + 4 TIMESTAMP timestamp + 2 p number of Providers + 18 unused + 4p LISTofPROVIDERS providers +└─── +┌─── + RRGetProviderInfo + 1 CARD8 major opcode + 1 33 RandR opcode + 2 3 length + 4 PROVIDER provider + 4 TIMESTAMP config-timestamp + ▶ + 1 1 Reply + 1 RRCONFIGSTATUS status + 2 CARD16 sequence number + 4 1+c+o+(a*2)+(n+p)/4 reply length + 4 TIMESTAMP timestamp + 4 CARD32 capabilities + 2 c number of crtcs + 2 o number of outputs + 2 a number of associated providers + 2 n length of name + 8 unused + 4c LISTofCRTC crtcs + 4o LISTofOUTPUT outputs + 4a LISTofPROVIDER associated providers + 4a CARD32 associated provider capability + n STRING8 name + p unused, p=pad(n) +└─── +┌─── + RRSetProviderOffloadSink + 1 CARD8 major opcode + 1 34 RandR opcode + 2 4 length + 4 PROVIDER provider + 4 PROVIDER offload sink provider + 4 TIMESTAMP timestamp +└─── +┌─── + RRSetProviderOutputSource + 1 CARD8 major opcode + 1 35 RandR opcode + 2 4 length + 4 PROVIDER provider + 4 PROVIDER output source provider + 4 TIMESTAMP timestamp +└─── +┌─── + RRListProviderProperties + 1 CARD8 major opcode + 1 36 RandR opcode + 2 2 length + 4 PROVIDER provider + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 2 n number of ATOMs in atoms + 22 unused + 4n LISTofATOM atoms +└─── +┌─── + RRQueryProviderProperty + 1 CARD8 major opcode + 1 37 RandR opcode + 2 3 request length + 4 PROVIDER provider + 4 ATOM property + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 1 BOOL pending + 1 BOOL range + 1 BOOL immutable + 21 unused + 4n LISTofINT32 valid values +└─── +┌─── + RRConfigureProviderProperty + 1 CARD8 major opcode + 1 38 RandR opcode + 2 4+n request length + 4 PROVIDER provider + 4 ATOM property + 1 BOOL pending + 1 BOOL range + 2 unused + 4n LISTofINT32 valid values +└─── +┌─── + RRChangeProviderProperty + 1 CARD8 major opcode + 1 39 RandR opcode + 2 6+(n+p)/4 request length + 4 PROVIDER provider + 4 ATOM property + 4 ATOM type + 1 CARD8 format + 1 mode + 0 Replace + 1 Prepend + 2 Append + 2 unused + 4 CARD32 length of data in format units + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) + n LISTofBYTE data + (n is a multiple of 2 for format = 16) + (n is a multiple of 4 for format = 32) + p unused, p=pad(n) +└─── +┌─── + RRDeleteProviderProperty + 1 CARD8 major opcode + 1 40 RandR opcode + 2 3 request length + 4 PROVIDER provider + 4 ATOM property +└─── +┌─── + RRGetProviderProperty + 1 CARD8 major opcode + 1 41 RandR opcode + 2 7 request length + 4 PROVIDER provider + 4 ATOM property + 4 ATOM type + 0 AnyPropertyType + 4 CARD32 long-offset + 4 CARD32 long-length + 1 BOOL delete + 1 BOOL pending + 2 unused + ▶ + 1 1 Reply + 1 CARD8 format + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 4 ATOM type + 0 None + 4 CARD32 bytes-after + 4 CARD32 length of value in format units + (= 0 for format = 0) + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) + 12 unused + n LISTofBYTE value + (n is zero for format = 0) + (n is a multiple of 2 for format = 16) + (n is a multiple of 4 for format = 32) + p unused, p=pad(n) +└─── + +A.2.4 Protocol Requests added with version 1.5 + +┌─── + RRGetMonitors + 1 CARD8 major opcode + 1 42 RandR opcode + 2 2 request length + 4 WINDOW window + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 6*n + o reply length + 4 TIMESTAMP timestamp + 4 n nmonitors + 4 o noutputs + 12 unused + n*24+o*4 LISTofMONITORINFO monitors +└─── +┌─── + RRSetMonitor + 1 CARD8 major opcode + 1 43 RandR opcode + 2 6 + o request length + 4 WINDOW window + 24+o MONITORINFO monitorinfo +└─── +┌─── + RRDeleteMonitor + 1 CARD8 major opcode + 1 44 RandR opcode + 2 3 request length + 4 WINDOW window + 4 ATOM name +└─── + +A.3 Protocol Events + +┌─── + RRScreenChangeNotify + 1 Base + 0 code + 1 ROTATION new rotation and reflection + 2 CARD16 sequence number + 4 TIMESTAMP timestamp + 4 TIMESTAMP configuration timestamp + 4 WINDOW root window + 4 WINDOW request window + 2 SIZEID size ID + 2 SUBPIXELORDER subpixel order defined in Render + 2 CARD16 width in pixels + 2 CARD16 height in pixels + 2 CARD16 width in millimeters + 2 CARD16 height in millimeters +└─── + +A.3.1 Protocol Events added with version 1.2 + +┌─── + RRCrtcChangeNotify + 1 Base + 1 code + 1 0 sub-code + 2 CARD16 sequence number + 4 TIMESTAMP timestamp + 4 WINDOW request window + 4 CRTC crtc affected + 4 MODE mode in use + 2 ROTATION new rotation and reflection + 2 unused + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height +└─── +┌─── + RROutputChangeNotify + 1 Base + 1 code + 1 1 sub-code + 2 CARD16 sequence number + 4 TIMESTAMP timestamp + 4 TIMESTAMP configuration timestamp + 4 WINDOW request window + 4 OUTPUT output affected + 4 CRTC crtc in use + 4 MODE mode in use + 2 ROTATION rotation in use + 1 CONNECTION connection status + 1 SUBPIXELORDER subpixel order +└─── +┌─── + RROutputPropertyNotify + 1 Base + 1 code + 1 2 sub-code + 2 CARD16 sequence number + 4 WINDOW window + 4 OUTPUT output + 4 ATOM atom + 4 TIMESTAMP time + 1 state + 0 NewValue + 1 Deleted + 11 unused +└─── + +A.3.2 Protocol Events added with version 1.4 +┌─── + RRProviderChangeNotify + 1 Base + 1 code + 1 3 sub-code + 2 CARD16 sequence number + 4 TIMESTAMP timestamp + 4 WINDOW request window + 4 PROVIDER provider affected + 16 unused +└─── +┌─── + RRProviderPropertyNotify + 1 Base + 1 code + 1 4 sub-code + 2 CARD16 sequence number + 4 WINDOW window + 4 PROVIDER provider + 4 ATOM atom + 4 TIMESTAMP time + 1 state + 0 NewValue + 1 Deleted + 11 unused +└─── +┌─── + RRResourceChangeNotify + 1 Base + 1 code + 1 5 sub-code + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW window + 20 unused +└─── +A.4 Protocol Errors + +┌─── + ERRORS + Base + 0 Output + Base + 1 Crtc + Base + 2 Mode + Base + 3 Provider +└─── + +Bibliography + +[RANDR] Gettys, Jim and Keith Packard, "The X Resize and Rotate + Extension - RandR", Proceedings of the 2001 USENIX Annual + Technical Conference, Boston, MA + +[RENDER] + Packard, Keith, "The X Rendering Extension", work in progress, + https://gitlab.freedesktop.org/xorg/proto/xorgproto/raw/master/renderproto.txt diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/renderproto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/renderproto.txt new file mode 100644 index 0000000000000000000000000000000000000000..b589c85b4d413406ebc01554899382acfa1e62a5 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/renderproto.txt @@ -0,0 +1,1214 @@ + The X Rendering Extension + Version 0.11 + 2009-07-15 + Keith Packard + keithp@keithp.com + +1. Introduction + +The X Rendering Extension (Render) introduces digital image composition as +the foundation of a new rendering model within the X Window System. +Rendering geometric figures is accomplished by client-side tessellation into +either triangles or trapezoids. Text is drawn by loading glyphs into the +server and rendering sets of them. + +2. Acknowledgments + +This extension was the work of many people, in particular: + + + Thomas Porter and Tom Duff for their formal description + of image compositing. + + + Rob Pike and Russ Cox who designed the Plan 9 window system from + which the compositing model was lifted. + + + Juliusz Chroboczek and Raph Levien whose proposal for client-side + glyph management eliminated font handling from the X server. + + + Jon Leech, Brad Grantham and Allen Akin for patiently explaining + how OpenGL works. + + + Carl Worth for providing the sample implementation of + trapezoid rendering and showing how broken the spec was + + + Sam Pottle and Jamey Sharp for helping demonstrate the correctness + of the trapezoid specification. + + + Owen Taylor for helping specify projective transformations + +3. Rendering Model + +Render provides a single rendering operation which can be used in a variety of +ways to generate images: + + dest = (source IN mask) OP dest + +Where 'IN' is the Porter/Duff operator of that name and 'OP' is any of the +list of compositing operators described below, among which can be found all +of the Porter/Duff binary operators. + +To use this operator several additional values are required: + + + The destination rectangle. This is a subset of the destination + within which the rendering is performed. + + + The source location. This identifies the coordinate in the + source aligned with the upper left corner of the + destination rectangle. + + + The mask location. This identifies the coordinate in the + mask aligned with the upper left corner of the + destination rectangle. + + + A clip list. This limits the rendering to the intersection of the + destination rectangle with this clip list. + + + The OP to use + + + Whether the source should be repeated to cover the destination + rectangle, extended with a constant pixel value or extended by + using the nearest available source pixel. + + + Whether the mask should be repeated to cover the destination + rectangle, extended with a constant pixel value or extended by + using the nearest available mask pixel. + + + Whether the mask has a single alpha value for all four channels or + whether each mask channel should affect the associated source/dest + channels. + + + Whether the source should be reshaped with a projective + transformation, and if so, what filter to apply while + resampling the data. + + + Whether the mask should be reshaped with a projective + transformation, and if so, what filter to apply while + resampling the data. + +These parameters are variously attached to the operands or included in each +rendering request. + +4. Data types + +The core protocol rendering system uses a pixel model and applies color only +in the final generation of the video signal. A compositing model operates +on colors, not pixel values so a new datatype is needed to interpret data as +color instead of just bits. + +The "PictFormat" object holds information needed to translate pixel values +into red, green, blue and alpha channels. The server has a list of picture +formats corresponding to the various visuals on the screen. There are two +classes of formats, Indexed and Direct. Indexed PictFormats hold a list of +pixel values and RGBA values while Direct PictFormats hold bit masks for each +of R, G, B and A. + +The "Picture" object contains a Drawable, a PictFormat and some +rendering state. More than one Picture can refer to the same Drawable. + +5. Errors + +Errors are sent using core X error reports. + +PictFormat + A value for a PICTFORMAT argument does not name a defined PICTFORMAT. + +Picture + A value for a PICTURE argument does not name a defined PICTURE. + +PictOp + A value for a PICTOP argument does not name a defined PICTOP. + +GlyphSet + A value for a GLYPHSET argument does not name a defined GLYPHSET. + +Glyph + A value for a GLYPH argument does not name a defined GLYPH in the + glyphset. + +6. Protocol Types + +PICTURE 32-bit value (top three bits guaranteed to be zero) +PICTFORMAT 32-bit value (top three bits guaranteed to be zero) +PICTTYPE { Indexed, Direct } +PICTOP { Clear, Src, Dst, Over, OverReverse, In, InReverse, + Out, OutReverse, Atop, AtopReverse, Xor, Add, Saturate, + DisjointClear, DisjointSrc, DisjointDst, DisjointOver, + DisjointOverReverse, DisjointIn, DisjointInReverse, + DisjointOut, DisjointOutReverse, DisjointAtop, + DisjointAtopReverse, DisjointXor, + ConjointClear, ConjointSrc, ConjointDst, ConjointOver, + ConjointOverReverse, ConjointIn, ConjointInReverse, + ConjointOut, ConjointOutReverse, ConjointAtop, + ConjointAtopReverse, ConjointXor, + Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, + ColorBurn, HardLight, SoftLight, Difference, Exclusion, + HSLHue, HSLSaturation, HSLColor, HSLLuminosity + } +SUBPIXEL { Unknown, HorizontalRGB, HorizontalBGR, + VerticalRGB, VerticalBGR, None + } +COLOR [ + red, green, blue, alpha: CARD16 + ] +CHANNELMASK [ + shift, mask: CARD16 + ] +DIRECTFORMAT [ + red, green, blue, alpha: CHANNELMASK + ] +INDEXVALUE [ + pixel: Pixel; + red, green, blue, alpha: CARD16 + ] +PICTFORMINFO [ + id: PICTFORMAT + type: PICTTYPE + depth: CARD8 + direct: DIRECTFORMAT + colormap: COLORMAP or None + ] + +PICTVISUAL [ + visual: VISUALID or None + format: PICTFORMAT + ] + +PICTDEPTH [ + depth: CARD8 + visuals: LISTofPICTVISUAL + ] + +PICTSCREEN LISTofPICTDEPTH + +FIXED 32-bit value (top 16 are integer portion, bottom 16 are fraction) +TRANSFORM [ + p11, p12, p13: FIXED + p21, p22, p23: FIXED + p31, p32, p33: FIXED + ] +POINTFIX [ + x, y: FIXED + ] +POLYEDGE { Sharp, Smooth } +POLYMODE { Precise, Imprecise } +REPEAT { None, Regular, Pad, Reflect } +COLORPOINT [ + point: POINTFIX + color: COLOR + ] +SPANFIX [ + left, right, y: FIXED + ] +COLORSPANFIX [ + left, right, y: FIXED + left_color: COLOR + right_color: COLOR +QUAD [ + p1, p2, p3, p4: POINTFIX + ] +TRIANGLE [ + p1, p2, p3: POINTFIX + ] +LINEFIX [ + p1, p2: POINTFIX + ] +TRAP [ + top, bottom: SPANFIX + ] +TRAPEZOID [ + top, bottom: FIXED + left, right: LINEFIX + ] +(TRAPEZOID is deprecated) +GLYPHSET 32-bit value (top three bits guaranteed to be zero) +GLYPH 32-bit value +GLYPHINFO [ + width, height: CARD16 + x, y: INT16 + off-x, off-y: INT16 + ] +PICTGLYPH [ + info: GLYPHINFO + x, y: INT16 + ] +GLYPHABLE GLYPHSET or FONTABLE +GLYPHELT8 [ + dx, dy: INT16 + glyphs: LISTofCARD8 + ] +GLYPHITEM8 GLYPHELT8 or GLYPHABLE +GLYPHELT16 [ + dx, dy: INT16 + glyphs: LISTofCARD16 + ] +GLYPHITEM16 GLYPHELT16 or GLYPHABLE +GLYPHELT32 [ + dx, dy: INT16 + glyphs: LISTofCARD32 + ] +GLYPHITEM32 GLYPHELT32 or GLYPHABLE + +ANIMCURSORELT [ + cursor: CURSOR + delay: CARD32 + ] +7. Standard PictFormats + +The server must support a Direct PictFormat with 8 bits each of red, green, +blue and alpha as well as a Direct PictFormat with 8 bits of red, green and +blue and 0 bits of alpha. The server must also support Direct PictFormats +with 1, 4 and 8 bits of alpha and 0 bits of r, g and b. + +Pixel component values lie in the close range [0,1]. These values are +encoded in a varying number of bits. Values are encoded in a straight +forward manner. For a component encoded in m bits, a binary encoding b +is equal to a component value of b/(2^m-1). + +A Direct PictFormat with zero bits of alpha component is declared to have +alpha == 1 everywhere. A Direct PictFormat with zero bits of red, green and +blue is declared to have red, green, blue == 0 everywhere. If any of red, +green or blue components are of zero size, all are of zero size. Direct +PictFormats never have colormaps and are therefore screen independent. + +Indexed PictFormats never have alpha channels and the direct component is all +zeros. Indexed PictFormats always have a colormap in which the specified +colors are allocated read-only and are therefore screen dependent. Drawing +to in Indexed Picture uses only pixel values listed by QueryPictIndexValues. +Reading from an Indexed Picture uses red, green and blue values from the +colormap and alpha values from those listed by QueryPictIndexValues. Pixel +values not present in QueryPictIndexValues are given alpha values of 1. + +8. Compositing Operators + +For each pixel, the four channels of the image are computed with: + + C = Ca * Fa + Cb * Fb + +where C, Ca, Cb are the values of the respective channels and Fa and Fb +come from the following table: + + PictOp Fa Fb + -------------------------------------------------- + Clear 0 0 + Src 1 0 + Dst 0 1 + Over 1 1-Aa + OverReverse 1-Ab 1 + In Ab 0 + InReverse 0 Aa + Out 1-Ab 0 + OutReverse 0 1-Aa + Atop Ab 1-Aa + AtopReverse 1-Ab Aa + Xor 1-Ab 1-Aa + Add 1 1 + Saturate min(1,(1-Ab)/Aa) 1 + DisjointClear 0 0 + DisjointSrc 1 0 + DisjointDst 0 1 + DisjointOver 1 min(1,(1-Aa)/Ab) + DisjointOverReverse min(1,(1-Ab)/Aa) 1 + DisjointIn max(1-(1-Ab)/Aa,0) 0 + DisjointInReverse 0 max(1-(1-Aa)/Ab,0) + DisjointOut min(1,(1-Ab)/Aa) 0 + DisjointOutReverse 0 min(1,(1-Aa)/Ab) + DisjointAtop max(1-(1-Ab)/Aa,0) min(1,(1-Aa)/Ab) + DisjointAtopReverse min(1,(1-Ab)/Aa) max(1-(1-Aa)/Ab,0) + DisjointXor min(1,(1-Ab)/Aa) min(1,(1-Aa)/Ab) + ConjointClear 0 0 + ConjointSrc 1 0 + ConjointDst 0 1 + ConjointOver 1 max(1-Aa/Ab,0) + ConjointOverReverse max(1-Ab/Aa,0) 1 + ConjointIn min(1,Ab/Aa) 0 + ConjointInReverse 0 min(Aa/Ab,1) + ConjointOut max(1-Ab/Aa,0) 0 + ConjointOutReverse 0 max(1-Aa/Ab,0) + ConjointAtop min(1,Ab/Aa) max(1-Aa/Ab,0) + ConjointAtopReverse max(1-Ab/Aa,0) min(1,Aa/Ab) + ConjointXor max(1-Ab/Aa,0) max(1-Aa/Ab,0) + +Saturate and DisjointOverReverse are the same. They match OpenGL +compositing with FUNC_ADD, SRC_ALPHA_SATURATE, ONE, except that Render uses +premultiplied alpha while Open GL uses non-premultiplied alpha. + +The result of any compositing operator is always limited to the range +[0,1] for each component. Components whose value would be greater than 1 +are set to 1. + +For operations involving division, when the divisor is zero, define the +quotient to be positive infinity. The result is always well defined +because the division is surrounded with a max or min operator which will +give a finite result. + +When the mask contains separate alpha values for each channel, the +alpha value resulting from the combination of that value with the source +alpha channel is used in the final image composition. + +9. Source and Mask Transformations + +When fetching pixels from the source or mask pictures, Render provides four +options for pixel values which fall outside the drawable (this includes +pixels within a window geometry obscured by other windows). + + + None. Missing values are replaced with transparent. + + + Pad. Replace missing pixels with the nearest available + pixel. Where multiple pixels are equidistant, select + those with smallest Y and then smallest X coordinates + + + Normal. Select the pixel which would appear were the + drawable tiled to enclose the missing coordinate. If + the tiling doesn't cover the coordinate, use the + selected Constant or Nearest mode. + + * Reflect. Select the pixel which would appear were the + drawable tiled to enclose the missing coordinate in such a + way that tiles in even numbered columns are reflected in the Y + axis, and tiles in even numbered rows are reflected in the X + axis. Tiles that in both an even numbered row and an even + numbered column are reflected in both axes. + +To construct the source and mask operands, the computed pixels values are +transformed through a homogeneous matrix, filtered and then used in the +fundamental rendering operator described above. Each screen provides a list +of supported filter names. There are a few required filters, and several +required filter alias which must map to one of the available filters. + +10. Polygon Rasterization + +Render provides only two kinds of polygons, trapezoids and triangles. To +improve efficiency, several different wire encodings exist for each. + +All trapezoids must be convex. Rendering of concave trapezoids is unspecified +except that the result must obey the clipping rules. + +Composite +Polygons are rasterized by implicit generating an alpha mask and using that +in the general compositing operator along with a supplied source image: + + tmp = Rasterize (polygon) + Composite (op, dst, src, tmp) + +When rasterized with Sharp edges, the mask is computed with a depth of 1 so +that all of the mask values are either 0 or 1. + +When rasterized with Smooth edges, the mask is generated by creating a square +around each pixel coordinate and computing the amount of that square covered +by the polygon. This ignores sampling theory but it provides a precise +definition which is close to the right answer. This value is truncated to +the alpha width in the fallback format before application of the compositing +operator. + +Rasterization +Alpha values are generated by point sampling the coverage of a square +surrounding the center of each pixel by the polygon. + +In Precise poly mode, the sample points are located in a regular grid. When +alpha depth 'e' is even, the regular grid is 2**(e/2) + 1 samples wide and +2**(e/2) -1 samples high. For odd alpha depth 'o', the sample grid is 2**o +- 1 samples wide and 1 sample high. Note that odd alpha depth usually +occurs only at depth 1, so this misshapen sample grid has no ill effects. +The sample grid is centered within the pixel and then each sample point is +rounded down to a point on the sub-pixel coordinate grid. + +In Imprecise mode, the location of the sample points is not specified, but +the implementation must conform to the following constraints: + + + Abutting edges must match precisely. When specifying two polygons + abutting along a common edge, if that edge is specified with the + same coordinates in each polygon then the sum of alpha values for + pixels inside the union of the two polygons must be precisely one. + + + Translationally invariant. The pixelization of the polygon must + be the same when either the polygon or the target drawable + are translated by any whole number of pixels in any direction. + + + Sharp edges are honored. When the polygon is rasterized with Sharp + edges, the implicit alpha mask will contain only 1 or 0 for + each pixel. + + + Order independent. Two identical polygons specified with vertices + in different orders must generate identical results. + +11. Image Filtering + +When computing pixels from source and mask images, a filter may be applied +to the data. This is usually used with a non-identity transformation +matrix, but filtering may be applied with an identity transformation. + +Each filter is given a unique name encoded as an ISO Latin-1 string. +Filters may be configured with a list of fixed point values; the number of +parameters and their interpretation is currently left to conventions passed +outside of the protocol. A set of standard filters are required to be +provided: + + Filter Name Description + + nearest Nearest neighbor filtering + bilinear Linear interpolation in two dimensions + +Additional names may be provided for any filter as aliases. A set of +standard alias names are required to be mapped to a provided filter so that +applications can use the alias names without checking for availability. + + Alias name Intended interpretation + + fast High performance, quality similar to Nearest + good Reasonable performance, quality similar to Bilinear + best Highest quality available, performance may not + be suitable for interactive use + +Aliases must map directly to a non-aliased filter name. + +There is also a set of standard filters which are not required but may be +provided. If they are provided, using the standard name, they must match +the definition specified here. + + Filter Name Description + + convolution MxN convolution filter. The values specified + in SetPictureFilter are M, N and then M * N + filter parameters. M and N must be integers + represented as fixed point numbers. + gaussian Gaussian blur. The value specified is a radius + in pixels (which can be fractional). A standard + Gaussian 2D convolution filter will be applied. + binomial Binomial blur. An approximation of a Gaussian + blur using binomial coefficients + +12. Glyph Rendering + +Glyphs are small alpha masks which can be stored in the X server and +rendered by referring to them by name. A set of glyphs can be rendered in a +single request. Glyphs are positioned by subtracting the x, y elements of +the GLYPHINFO from the requested rendering position. The next glyph +rendering position is set to the current rendering position plus the off-x +and off-y elements. + +Glyphs are stored in GlyphSets and are named within the GlyphSet with +client-specified 32-bit numbers. + +Glyphs can be stored in any PictFormat supported by the server. All glyphs +in a GlyphSet are stored in the same format. + +13. Extension Initialization + +The client must negotiate the version of the extension before executing +extension requests. Behavior of the server is undefined otherwise. + +QueryVersion + + client-major-version: CARD32 + client-minor-version: CARD32 + + -> + + major-version: CARD32 + minor-version: CARD32 + + The client sends the highest supported version to the server and + the server sends the highest version it supports, but no higher than + the requested version. Major versions changes can introduce + incompatibilities in existing functionality, minor version + changes introduce only backward compatible changes. It is + the clients responsibility to ensure that the server supports + a version which is compatible with its expectations. + +QueryPictFormats + + -> + + formats: LISTofPICTFORMINFO + screens: LISTofPICTSCREEN + ndepths: CARD32 + nvisuals: CARD32 + subpixels: LISTofSUBPIXEL + + Errors: + + + The server responds with a list of supported PictFormats and + a list of which PictFormat goes with each visual on each screen. + Every PictFormat must match a supported depth, but not every + PictFormat need have a matching visual. + + The total number of PICTDEPTH and PICTVISUAL objects is this reply + is given in 'ndepths' and 'nvisuals'. + + The relationship between the red, green and blue elements making + up each pixel indexed by screen is returned in subpixels. + This list is not present in servers advertising protocol + versions earlier than 0.6. This list may be shorter than + the number of screens, in which case the remaining screens + are given sub pixel order Unknown. + +QueryPictIndexValues + + format: PICTFORMAT + + -> + + values: LISTofINDEXVALUE + + Errors: + PictFormat, Match + + Returns the mapping from pixel values to RGBA values for the + specified Indexed PictFormat. If 'format' does not refer to + an Indexed PictFormat a Match error is generated. + +QueryFilters + + drawable: DRAWABLE + + -> + + filters: LISTofSTRING8 + aliases: LISTofCARD16 + + This request gets the names of available filters that can be used on the + given drawable. Filters are applied using a SetPictureFilter request. + + 'aliases' contains a value for each filter name which is the index into + 'filters' if this name is an alias. Non-aliased filter have this value + set to 0xFFFF. + +14. Extension Requests + +CreatePicture + + pid: PICTURE + drawable: DRAWABLE + format: PICTFORMAT + value-mask: BITMASK + value-list: LISTofVALUE + + Errors: + Alloc, Drawable, IDChoice, Match, Pixmap, Picture, + PictFormat, Value + + This request creates a Picture object associated with the specified + drawable and assigns the identifier pid to it. Pixel data in the + image are interpreted according to 'format'. It is a Match error + to specify a format with a different depth than the drawable. If + the drawable is a Window then the Red, Green and Blue masks must + match those in the visual for the window else a Match error is + generated. + + The value-mask and value-list specify attributes of the picture that + are to be explicitly initialized. The possible values are: + + repeat: REPEAT + alpha-map: PICTURE or None + alpha-x-origin: INT16 + alpha-y-origin: INT16 + clip-x-origin: INT16 + clip-y-origin: INT16 + clip-mask: PIXMAP or None + graphics-exposures: BOOL + subwindow-mode: { ClipByChildren, IncludeInferiors } + poly-edge: POLYEDGE + poly-mode: POLYMODE + dither: ATOM or None + component-alpha: BOOL + + When used as a source or mask operand, Repeat indicates how the + drawable contents should be extended in both directions. + + The alpha channel of alpha-map is used in place of any alpha channel + contained within the drawable for all rendering operations. The + alpha-mask origin is interpreted relative to the origin of drawable. + Rendering is additionally clipped by the geometry and clip mask of + alpha-map. Exposures to the window do not affect the contents of + alpha-map. Alpha-map must refer to a picture containing a Pixmap, + not a Window (or a Match error results). If the alpha-map picture + itself already has an alpha-map, the result is undefined. + + The clip-mask restricts reads and writes to drawable. Only pixels + where the clip-mask has bits set to 1 are read or written. Pixels + are not accessed outside the area covered by the clip-mask or where + the clip-mask has bits set to 0. The clip-mask affects all graphics + requests, including sources. The clip-mask origin is interpreted + relative to the origin of the picture. If a pixmap is specified as + the clip-mask, it must have depth 1 and have the same root as the + drawable (or a Match error results). If clip-mask is None, then + pixels are always drawn, regardless of the clip origin. The + clip-mask can also be set with the SetPictureClipRectangles request. + Transformations, filters and repeat modes do not affect the clip + mask. + + When a window is used as a destination, the subwindow_mode + determines what happens to pixels obscured by inferior + windows. For ClipByChildren the window is clipped by inferiors + and siblings. For IncludeInferior, the window is clipped by + siblings, but not by inferiors. + + When a window is used as source or mask, the subwindow_mode is + ignored. Pixels that are obscured by other windows, whether + siblings or inferiors, have undefined contents. + + The graphics-exposures flag is ignored. GraphicsExposure events are + never generated by this extension. + + Poly-edge and poly-mode control the rasterization of polygons as + described above. + + Dither is ignored. + + Component-alpha indicates whether each image component is intended as + a separate alpha value when the picture is used as a mask operand. + + The default component values are + + Component Default + ------------------------------- + repeat None + clip-x-origin 0 + clip-y-origin 0 + clip-mask None + subwindow-mode ClipByChildren + poly-edge Smooth + poly-mode Precise + component-alpha False + +ChangePicture + + pid: PICTURE + value-mask: BITMASK + value-list: LISTofVALUE + + Errors: + Picture, Alloc, Pixmap, PictOp, Value + + The value-mask and value-list specify which attributes are to be + changed. The values and restrictions are the same as for + CreatePicture. + +SetPictureClipRectangles + + picture: PICTURE + clip-x-origin: INT16 + clip-y-origin: INT16 + rectangles: LISTofRECTANGLE + + Errors: + Alloc, Picture + + This request changes clip-mask in picture to the specified list of + rectangles and sets the clip origin. Input and output will be + clipped to remain contained within the rectangles. The clip origin + is interpreted relative to the origin of picture after + transformations and repeats have been applied. The rectangle + coordinates are interpreted relative to the clip origin. + + The list of rectangles can be empty, which effectively disables + output. This is the opposite of passing None as the clip-mask in + CreatePicture and ChangePicture. + + Note that output is clipped to the union of all of the rectangles + and that no particular ordering among the rectangles is required. + +SetPictureTransform + + picture: PICTURE + transform: TRANSFORM + + Errors: + Alloc, Value, Picture + + This request changes the projective transformation used to + map coordinates when 'picture' is used as the source or + mask in any compositing operation. The transform + maps from destination pixel geometry back to the source pixel + geometry. + + The matrix must be invertable, else a Value error is generated. + +SetPictureFilter + + picture: PICTURE + filter: STRING8 + values: LISTofFIXED + + Errors: + Value, Match, Picture + + This request sets the current filter used when picture is a source + or mask operand. Filter must be one of the filters supported + for the screen associated with picture, else a Match error + is generated. If the filter accepts additional parameters, + they can be provided in values, incorrect values generate Value + errors, too many values generate Match errors. Too few values + cause the filter to assume default values for the missing + parameters. + + When created, Pictures are set to the Nearest filter. + +FreePicture + + pid: PICTURE + + Errors: + Picture + + This request deletes the association between the resource ID and the + picture. The picture storage will be freed when no other resource + references it. + +Composite + + op: PICTOP + src: PICTURE + mask: PICTURE or None + dst: PICTURE + src-x, src-y: INT16 + mask-x, mask-y: INT16 + dst-x, dst-y: INT16 + width, height: CARD16 + + This request combines the specified rectangle of the transformed + src and mask operands with the specified rectangle of dst using op + as the compositing operator. The coordinates are relative their + respective (transformed) drawable's origin. Rendering is clipped + to the geometry of the dst drawable and then to the dst clip-list. + + Pixels outside the geometry of src or mask needed for this + computation are substituted as described in the Source and Mask + Transformations section above. + + If src, mask and dst are not in the same format, and one of their + formats can hold all without loss of precision, they are converted + to that format. Alternatively, the server will convert each + operand to the fallback format. + + If mask is None, it is replaced by a constant alpha value of 1. + +FillRectangles + + op: PICTOP + dst: PICTURE + color: COLOR + rects: LISTofRECTANGLE + + This request combines color with the destination drawable in the + area specified by rects. Each rectangle is combined separately; + overlapping areas will be rendered multiple times. The effect is + equivalent to compositing with a repeating source picture filled with + the specified color. + +Trapezoids + + op: PICTOP + src: PICTURE + src-x, src-y: INT16 + dst: PICTURE + mask-format: PICTFORMAT or None + traps: LISTofTRAPEZOID + + This request rasterizes the list of trapezoids. + + For each trap, the area between the left and right edges is filled + from the top to the bottom. src-x and src-y register the pattern to + the floor of the top x and y coordinate of the left edge of the + first trapezoid, they are adjusted for subsequent trapezoids so that + the pattern remains globally aligned within the destination. + + When mask-format is not None, trapezoids are rendered in the + following way with the effective mask computed in mask-format: + + tmp = temporary alpha picture (in mask-format) + Combine (Zero, tmp, tmp, None) + for each trapezoid + Combine (Add, tmp, trapezoid, None) + Combine (op, dst, source, tmp) + + When mask-format is None, trapezoids are rendered in the order + specified directly to the destination: + + for each trapezoid + Combine (op, dst, source, trapezoid) + + (The Trapezoids request is deprecated) + +Triangles + + op: PICTOP + src: PICTURE + src-x, src-y: INT16 + dst: PICTURE + mask-format: PICTFORMAT or None + triangles: LISTofTRIANGLE + + This request rasterizes the list of triangles in the order they + occur in the list. + + When mask-format is not None, triangles are rendered in the + following way with the effective mask computed in mask-format: + + tmp = temporary alpha picture (in mask-format) + Combine (Zero, tmp, tmp, None) + for each triangle + Combine (Add, tmp, triangle, None) + Combine (op, dst, source, tmp) + + When mask-format is None, triangles are rendered in the order + specified directly to the destination: + + for each triangle + Combine (op, dst, source, triangle) + +TriStrip + + op: PICTOP + src: PICTURE + src-x, src-y: INT16 + dst: PICTURE + mask-format: PICTFORMAT or None + points: LISTofPOINTFIX + + Triangles are formed by initially using the first three points and + then by eliminating the first point and appending the next point in + the list. If fewer than three points are provided, this request does + nothing. + + When mask-format is not None, triangles are rendered in the + following way with the effective mask computed in mask-format: + + tmp = temporary alpha picture (in mask-format) + Combine (Zero, tmp, tmp, None) + for each triangle + Combine (Add, tmp, triangle, None) + Combine (op, dst, source, tmp) + + When mask-format is None, triangles are rendered in the order + specified directly to the destination: + + for each triangle + Combine (op, dst, source, triangle) + +TriFan + op: PICTOP + src: PICTURE + src-x, src-y: INT16 + dst: PICTURE + mask-format: PICTFORMAT or None + points: LISTofPOINTFIX + + Triangles are formed by initially using the first three points and + then by eliminating the second point and appending the next point + int the list. If fewer than three points are provided, this request + does nothing. + + When mask-format is not None, triangles are rendered in the + following way with the effective mask computed in mask-format: + + tmp = temporary alpha picture (in mask-format) + Combine (Zero, tmp, tmp, None) + for each triangle + Combine (Add, tmp, triangle, None) + Combine (op, dst, source, tmp) + + When mask-format is None, triangles are rendered in the order + specified directly to the destination: + + for each triangle + Combine (op, dst, source, triangle) + +CreateGlyphSet + + gsid: GLYPHSET + format: PICTFORMAT + + Errors: + Alloc, IDChoice, PictFormat, Match + + This request creates a container for glyphs. The glyphset and + all contained glyphs are destroyed when gsid and any other names + for the glyphset are freed. Format must be a Direct format, when + it contains RGB values, the glyphs are composited using + component-alpha True, otherwise they are composited using + component-alpha False. + +ReferenceGlyphSet + + gsid: GLYPHSET + existing: GLYPHSET + + Errors: + Alloc, IDChoice, GlyphSet + + This request creates an additional name for the existing glyphset. + The glyphset will not be freed until all references to it are + destroyed. + +FreeGlyphSet + + glyphset: GLYPHSET + + Errors: + GlyphSet + + This request frees the name for the glyphset. When all names have + been freed, the glyphset and all contained glyphs are freed. + +AddGlyphs + glyphset: GLYPHSET + glyphids: LISTofCARD32 + glyphs: LISTofGLYPHINFO + data: LISTofBYTE + + Errors: + GlyphSet, Alloc + + This request adds glyphs to glyphset. The image for the glyphs + are stored with each glyph in a separate Z-format image padded to a + 32-bit boundary. Existing glyphs with the same names are replaced. + +FreeGlyphs + + glyphset: GLYPHSET + glyphs: LISTofGLYPH + + Errors: + GlyphSet, Match + + This request removes glyphs from glyphset. Each glyph must exist + in glyphset (else a Match error results). + +CompositeGlyphs8 +CompositeGlyphs16 +CompositeGlyphs32 + + op: PICTOP + src: PICTURE + dst: PICTURE + mask-format: PICTFORMAT or None + glyphset: GLYPHABLE + src-x, src-y: INT16 + glyphcmds: LISTofGLYPHITEM8 CompositeGlyphs8 + glyphcmds: LISTofGLYPHITEM16 CompositeGlyphs16 + glyphcmds: LISTofGLYPHITEM32 CompositeGlyphs32 + + Errors: + Picture, PictOp, PictFormat, GlyphSet, Glyph + + The src-x and src-y coordinates are relative to the drawable's + origin and specify the baseline starting position (the initial glyph + origin). Each glyph item is processed in turn. A glyphset item + causes the glyphset to be used for subsequent glyphs. Switching + among glyphsets does not affect the next glyph origin. A glyph + element delta-x and delta-y specify additional changes in the + position along the x and y axes before the string is drawn; the + deltas are always added to the glyph origin. + + All contained GLYPHSETs are always transmitted most significant byte + first. + + If a GlyphSet error is generated for an item, the previous items may + have been drawn. + + When mask-format is not None, glyphs are rendered in the following + way with the effective mask computed in mask-format: + + tmp = temporary alpha picture + Combine (Zero, tmp, tmp, None) + for each glyph + Combine (Add, tmp, glyph, None) + Combine (op, dst, source, tmp) + + When mask-format is None, glyphs are rendered in the order specified + directly to the destination: + + for each glyph + Combine (op, dst, source, glyph) + +CreateCursor + + cid: CURSOR + source: PICTURE + x, y: CARD16 + + Errors: Alloc, IDChoice, Match, Picture + + This request creates a cursor and associates identifier cid with it. + The x and y coordinates define the hotspot relative to the source's + origin and must be a point within the source (or a Match error + results). The resulting picture will nominally be drawn to the + screen with PictOpOver. + + The components of the cursor may be transformed arbitrarily to meet + display limitations. In particular, if the display supports only + two colors cursors without translucency, the cursor will be + transformed so that areas less than .5 alpha will be transparent, + else opaque, and areas darker than 50% gray will be black else white. + + The source picture can be freed immediately if no further explicit + references to it are to be made. + + Subsequent drawing in the source has an undefined effect on the + cursor. The server might or might not make a copy of the picture. + +CreateAnimCursor + cid: CURSOR + cursors: LISTofANIMCURSORELT + + Errors: Alloc, IDChoice, Cursor + + This request creates a cursor and associates identifier cid with it. + When active, the cursor image on the screen will cycle through + 'cursors', showing each cursor in the element for the number of + milliseconds indicated by the 'delay' member of that element. + +AddTraps + picture: PICTURE + off-x, off-y: INT16 + trapezoids: LISTofTRAP + + Errors: Match + + Each trap is PictOpAdd'ed to 'picture'. 'off-x', 'off-y' + are added to each coordinate. + + 'picture' must be an alpha-only picture else a 'Match' error is + returned. + +CreateSolidFill + pid: PICTURE + color: COLOR + + Creates a Source picture that represents a solid fill with + the specified color. + +CreateLinearGradient + pid: PICTURE + p1, p2: POINTFIX + nstops: CARD32 + stops: LISTofFIXED + stop_colors: LISTofCOLOR + + Errors: Alloc, Value + + Creates a source picture representing a linear Gradient. The gradients + bounds are defined by the two end points p1 and p2. + + The gradient has nstops stop points between 0 and 1, each + having a stop color defined in stop_colors. + + The array of stops has to contain values between 0 and 1 (inclusive) and + has to be ordered in increasing size or a Value error is generated. If + p1 == p2 a Value error is generated. + + The colors are non premultiplied. + +CreateRadialGradient + pid: PICTURE + inner_center: POINTFIX + outer_center: POINTFIX + inner_radius: FIXED + outer_radius: FIXED + nstops: CARD32 + stops: LISTofFIXED + stop_colors: LISTofCOLOR + + Errors: Alloc, Value + + Creates a source picture representing a radial Gradient. The + gradients bounds are defined by a center point, a focal point and a + radius around the center. + + The gradient has nstops stop points between 0 and 1, each + having a stop color defined in stop_colors. + + The array of stops has to contain values between 0 and 1 (inclusive) and + has to be ordered in increasing size or a Value error is generated. The inner + circle has to be completely contained inside the outer one or a Value error is + generated. + + The colors are non premultiplied. + +CreateConicalGradient + pid: PICTURE + center: POINTFIX + angle: FIXED + nstops: CARD32 + stops: LISTofFIXED + stop_colors: LISTofCOLOR + + Errors: Alloc, Value + + Creates a source picture representing a conical Gradient. The + gradient is defined by a center point and an angle (in degrees). + + The gradient has nstops stop points between 0 and 1, each + having a stop color defined in stop_colors. + + The array of stops has to contain values between 0 and 1 (inclusive) and + has to be ordered in increasing size or a Value error is generated. + + The colors are non premultiplied. + + +15. Extension Versioning + +The Render extension was developed in parallel with the implementation to +ensure the feasibility of various portions of the design. As portions of +the extension are implemented, the version number of the extension has +changed to reflect the portions of the standard provided. This document +describes the intent for version 1.0 of the specification, the partial +implementations have version numbers less than that. Here's a list of +what each version before 1.0 implemented: + + 0.0: + No disjoint/conjoint operators + No component alpha + Composite + CreateGlyphSet + FreeGlyphSet + AddGlyphs + CompositeGlyphs + + 0.1: + Component alpha + FillRectangles + + 0.2: + Disjoint/Conjoint operators + + 0.3: + FreeGlyphs + + 0.4: + Trapezoids + Triangles + TriStrip + TriFan + + 0.5: + CreateCursor + + 0.6: + SetPictureTransform + QueryFilters + SetPictureFilter + subpixels member of QueryPictFormats + + 0.7: + QueryPictIndexValues + 0.8: + CreateAnimCursor + 0.9: + AddTrapezoids + + 0.10: + CreateSolidFill + CreateLinearGradient + CreateRadialGradient + CreateConicalGradient + + The repeat picture attribute now supports Pad and + Reflect, older versions only supported None and Normal. + + 0.11: + Blend mode operators + diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/resproto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/resproto.txt new file mode 100644 index 0000000000000000000000000000000000000000..8b322ff88c548c6e902be11c375857321a13f64a --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/resproto.txt @@ -0,0 +1,462 @@ + DRAFT FOR REVIEW + The X Resource Extension + Version 1.2 + Rami Ylimäki + rami.ylimaki@vincit.fi + + ❧❧❧❧❧❧❧❧❧❧❧ + +1. Introduction + +The protocol description of X Resource Extension version 1.1 has been +either lost or has never been written. This specification documents +version 1.0 based on reverse engineered library and server +code. Version 1.1 has been accidentally released from the version +control and while it doesn't have differences to version 1.0, this +version is labeled 1.2 in order to remove the risk of confusion. In +addition to the 1.0 description, this document introduces a new 1.2 +version of the extension. + +Version 1.2 is a minor release and therefore the changes are +compatible with the previous version. Main enhancements over version +1.0 are: + +- Client identification is now possible. For example, servers + supporting version 1.2 may report PID of local clients. + +- Size of any resource can be queried from the server. Servers may not + necessarily support size calculation for every resource. However, + clients have now at least the chance to let the server do resource + size estimation for them. + + ❧❧❧❧❧❧❧❧❧❧❧ + +2. Notations used in this document + +Notation for data types and requests follows the guidelines set in +sections 2-4 of X Window System Protocol standard. + + ❧❧❧❧❧❧❧❧❧❧❧ + +3. Interoperability between version 1.1 and 1.2 + +Version 1.2 only introduces two new requests. However, these requests +could be seen as generalized versions of existing requests. Even +though we aren't deprecating any old requests, libraries could +implement some old requests using the new ones. + +The new XResQueryClientIds request could be used instead of +XResQueryClients. + +The new XResQueryResourceBytes request could be used instead of +XResQueryClientPixmapBytes. + +Using the old requests is still acceptable because we don't want to +change the semantics of existing requests between version 1.1 and 1.2. + + ❧❧❧❧❧❧❧❧❧❧❧ + +4. Data types + +4.1 Types in version 1.0 + +CLIENTXIDRANGE [ resource_base: CARD32 + resource_mask: CARD32 ] + +This type is used for reply of XResQueryClients in version 1.1. It +represents the range of resource allocated for a client and can be +also used for client identification. + +resource_base + First resource ID reserved for a client. Used also to identify the + clients themselves. +resource_mask + Mask that can be used to identify a client from some resource + ID. Just zero the bits indicated by this mask from any resource ID + to identify the client that owns the resource. + +CLIENTXID [ client: XID ] + +This type identifies a single client by a resource owned by that +client or by the first resource ID allocated for the client +(resource_base of CLIENTXIDRANGE). Whenever a resource ID is used, it +is masked by resource_mask of CLIENTXIDRANGE to find out the client +that owns the resource. + +CLIENTRESOURCETYPECOUNT [ resource_type: ATOM + count: CARD32 ] + +This type is used for reply of XResQueryClientResources in version +1.1. It represents the number of certain type of resources that are +owned by some client. + +resource_type + Atom specifying the type of a resource. +count + Number of resources of the given type owned by a client. + +4.2 Types in version 1.2 + +4.2.1 Types used by XResQueryClientIds + +CLIENTIDMASK { ClientXid = 0x1, LocalClientPid = 0x2 } + +A bitmask specifying a client identification method. Currently only +the PID of local clients is supported in the form of +LocalClientPid. ClientXid is provided for backward compatibility with +version 1.0 so that the new 1.2 requests (XResQueryClientIds) can be +used in place of the older ones (XResQueryClients). + +CLIENTIDSPEC [ client: CLIENTXID or None + mask: SETofCLIENTIDMASK or None ] + +A data structure for selecting client IDs. + +client + ID of a resource allocated for some client. Only the part + identifying a client is actually used. The resource_base of + CLIENTXIDRANGE can be used if the client doesn't own any + resources. However, any resource ID is accepted because that makes + identifying the owners of existing resources easy. The null + resource None can be used to select all clients. +mask + Collection of identification methods that should be applied on the + client. The special value None can be used to apply all supported + identification methods. + +CLIENTIDVALUE [ spec: CLIENTIDSPEC + length: CARD32 + value: LISTofCARD32 ] + +A data structure specifying a single client ID. + +spec + A unique identifier for a specific ID of some client. Wildcards + such as None and bitmask unions aren't allowed. The data structure + must always identify a single client and single ID type. However, + the client doesn't have to be specified as the resource_base of + CLIENTXIDRANGE and can be any resource owned by the client. +length + Specifies the length of an ID in units of CARD32. The length + depends on the ID type. In version 1.2 the lengths are 0 for + ClientXid and 4 for LocalClientPid. The length of ClientXid is 0 + because that is already stored in the spec field. +value + Actual ID data. In version 1.2 this is missing for ClientXid and + consists of a single CARD32 for LocalClientPid. + +4.2.2 Types used by XResQueryResourceBytes + +To better understand how resources are related to each other, it's +useful to introduce the concepts of main resource and cross +reference. By main resource we just mean a normal resource that has a +valid XID. By cross reference we mean a resource that is used by some +other resource. + +The same resource may have both of these roles depending on the +context. For example, there could be an ordinary pixmap resource. When +we talk about this resource in isolation the term main resource is +used. We call the exact same resource a cross reference when we are +concentrating on some higher level resource, such as window or +graphics context, that is using the lower level resource. Cross +references may also be internal server resources that don't have a +valid XID. + +RESOURCEIDSPEC [ resource: XID or None + type: ATOM or None/AnyPropertyType ] + +A data structure for selecting or identifying resources. The +interpretation of fields changes depending on the context. The +differences in interpretation are described below. + +resource + An XID of a resource. The null resource None can be used to select + all resources matching some type if the data structure is used in + XResQueryResourceBytes request. The null resource None can be used + to mark private server resources if the data structure is used in + a cross reference of XResQueryResourceBytes reply. +type + An atom identifying the resource type. The null atom + None/AnyPropertyType can be used to select all resource types + matching some resource ID if the data structure is used in + XResQueryResourceBytes request. + +RESOURCESIZESPEC [ spec: RESOURCEIDSPEC + bytes: CARD32 + ref_count: CARD32 + use_count: CARD32 ] + +A data structure specifying the size of a single resource. + +spec + Uniquely identifies a single resource. Wildcards such as None and + AnyPropertyType aren't allowed for main resources. In cross + references, None is used to mark internal server resources. +bytes + Number of bytes allocated for the resource. The size of a resource + is never divided by a reference count. This is the number of bytes + released in server when there are no more references left to the + resource. +ref_count + Number of total users of the resource. Typically the reference + count is 1 but for pixmaps and other resources used from different + contexts the count may be larger. +use_count + Number of times the resource is used by some other resource. For + main resources this is typically 1, because a resource doesn't + usually use itself recursively. For cross references this is the + number of times the resource is used and is also 1 usually. + +RESOURCESIZEVALUE [ size: RESOURCESIZESPEC + num_cross_references: CARD32 + cross_references: LISTofRESOURCESIZESPEC ] + +A data structure specifying sizes of cross references to other +resources in addition to the main resource size. + +size + Size of a main resource. +num_cross_references + Number of cross references to other resources from the main + resource. Currently resources can only have pixmaps as cross + references but this can be extended to other types in the + future. For simple resources this field is therefore 0 and the + cross_references list is missing. +cross_references: + Size specifications for cross references. Note that cross + references may contain resources that don't have a valid XID. For + example, a DRI2 drawable might have a cross reference to a private + pixmap that is used internally in the server only. These private + cross references are contained in this list also. This makes it + possible to emulate XResGetClientPixmapBytes with + XResGetResourceBytes. + + ❧❧❧❧❧❧❧❧❧❧❧ + +5. Requests + +5.1 Requests in version 1.0 + +┌─── + XResQueryVersion + client_major: CARD8 + client_minor: CARD8 + ▶ + server_major: CARD16 + server_minor: CARD16 +└─── + +The client sends the highest supported version to the server and the +server sends the highest version it supports, but no higher than the +requested version. Major version changes can introduce +incompatibilities in existing functionality, minor version changes +introduce only backward compatible changes. It is the client's +responsibility to ensure that the server supports a version which is +compatible with its expectations. + +client_major + Major X Resource Extension version supported by client. +client_minor + Minor X Resource Extension version supported by client. +server_major + Highest version supported by server that is compatible with + client. +server_minor + Highest version supported by server that is compatible with + client. + +┌─── + XResQueryClients + ▶ + num_clients: CARD32 + clients: LISTofCLIENTXIDRANGE +└─── + +The request asks X server to return the list of all currently +connected clients. + +num_clients + Number of currently connected clients. +clients + List of XID ranges allocated for the connected clients. + +┌─── + XResQueryClientResources + client: CLIENTXID + ▶ + num_types: CARD32 + types: LISTofCLIENTRESOURCETYPECOUNT + + Errors: Value +└─── + +This request can be used to ask the number of resources owned by a +client. The server will return the counts of each type of resource. + +client + An XID in the resource range of a client. This identifies the + client and not some specific resource. +num_types + Number of different resource types owned by the client. +types + A list of counts for each resource type. + +A value error is generated if invalid resource or client XID is given +in the request. + +┌─── + XResQueryClientPixmapBytes + client: CLIENTXID + ▶ + bytes: CARD32 + bytes_overflow: CARD32 + + Errors: Value +└─── + +This request is used to get the pixmap usage of some client. The +returned number is a sum of memory usage of each pixmap that can be +attributed to the given client. Ideally the server goes through all +pixmaps and divides each pixmap size by the pixmap reference count to +get a pixmap reference size. The reference size is then added to the +returned sum if the client happens to be referencing that pixmap. In +practice some pixmap references may be missed, because it would be too +difficult to keep track of all pixmap references. However, the server +will check the most important client resources that are using pixmaps +and tries to estimate the pixmap usage as well as is possible. In +other words, the server need only make a best-effort attempt to +calculate resource source, so actual resource size may differ from +that reported in practice. + +client + Identifies a client by an ID in its resource ID range. +bytes: + Number of bytes attributed to pixmap references from the client + resources. +bytes_overflow: + Higher order word for the bytes field in case the sum of pixmap + reference sizes doesn't fit in CARD32. + +A value error is generated if invalid resource or client XID is given +in the request. + +5.2 Requests in version 1.2 + +┌─── + XResQueryClientIds + num_specs: CARD32 + client_specs: LISTofCLIENTIDSPEC + ▶ + num_ids: CARD32 + client_ids: LISTofCLIENTIDVALUE + + Errors: Value +└─── + +XResQueryClientIds can be used to identify a given set of clients with +some identification method. The request sends a list of specifiers +that select clients and identification methods to server. The server +then tries to identify the chosen clients using the identification +methods specified for each client. The server returns IDs for those +clients that were successfully identified. It's not an error condition +if some identification method couldn't be applied to a client. If the +server is unable to identify some clients, they simply aren't included +in the returned list. + +The request supports wildcards in the client specifications so that in +the most general case all IDs of all clients can be queried with a +single CLIENTIDSPEC. + +The CLIENTIDSPEC of request and CLIENTIDSPEC of CLIENTIDVALUE in reply +usually match each other. For example, if a request selected a client +by a resource ID owned by the client, then the client is identified by +the same resource ID in the reply. This has been done so that it would +be easy to identify an owner of some resource. + +However, the CLIENTIDSPEC of returned CLIENTIDVALUE never contains any +wildcards. If the request used a wildcard to specify all clients in a +single CLIENTIDSPEC, then the reply has expanded the wildcard and +returns separate CLIENTIDVALUE records for each client. In this case +wildcarded clients are identified by resource_base of CLIENTXIDRANGE. + +The LocalClientPid type of IDs are included in the reply list only if +the client executing the request asked for it and was also a local +client itself. It doesn't make sense for remote clients to ask PIDs of +local clients. + +num_specs + Number of client ID specifications. +client_specs + A list specifying identification methods for clients. Supports + multiple identification methods and clients in a single + specification. See CLIENTIDSPEC for details. +num_ids + Number of IDs that were successfully determined. Can be different + from num_specs or even zero if the server didn't support any + identification methods for the given clients. +client_ids + A list specifying ID information for successfully identified + clients. If wildcards were used in a single CLIENTIDSPEC of + client_specs, then multiple CLIENTIDVALUE records may be returned + for that CLIENTIDSPEC. See CLIENTIDVALUE for details. + +A Value error is returned if the request specifies an invalid client +XID or invalid identification method type. + +┌─── + XResQueryResourceBytes + client: CLIENTXID or None + num_specs: CARD32 + resource_specs: LISTofRESOURCEIDSPEC + ▶ + num_sizes: CARD32 + sizes: LISTofRESOURCESIZEVALUE + + Errors: Atom, Value +└─── + +XResQueryResourceBytes can be used to ask the sizes of resources from +X server. The request sends a list of specifiers that selects +resources for size calculation. The server tries to calculate the +sizes of chosen resources and returns an estimate for a resource only +if the size could be determined. It's not an error condition if a size +couldn't be calculated. In that case the resources simply aren't +included in the returned list. + +The request supports wildcards so that in the most general case sizes +of all resources of all clients can be queried with a single +RESOURCEIDSPEC. However, the reply has all wildcards expanded and +reports a size of a single resource in each RESOURCESIZEVALUE. + +client + An ID of a client can be given to limit the query to resources of + that client. Just like in CLIENTIDSPEC, any resource ID can be + given to identify a client and None can be used if the query + shouldn't be limited to a specific client. Note that in some cases + this field is redundant because resource_specs already fully + determines which resources are selected. If the client ID doesn't + match the owner of any resource in resource_specs, no sizes are + returned and no error is generated. +num_specs + Number of resource specifications. +resource_specs + A list of resource specifications. Each specification can either + uniquely identify a single resource or multiple resources if + wildcarding is used. See RESOURCEIDSPEC for details. +num_sizes + Number of resources whose size could be determined. Can be + different from num_specs or even zero if the server didn't support + size calculation for the given resources. +sizes + A list of resource sizes. Each resource size is linked to a unique + resource. Wildcards are never used in the returned size + records. For example, it's not possible to receive a single + RESOURCESIZEVALUE that would specify the size of all pixmaps if + the sizes of pixmap type resources were asked. Instead, a single + RESOURCESIZEVALUE would be returned for each pixmap in that case. + +An Atom error is returned if the request specifies an invalid resource +type. A Value error is returned if the request specifies an invalid +XID for a client or a resource. + + ❧❧❧❧❧❧❧❧❧❧❧ diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/xv-protocol-v2.txt b/miniconda3/envs/ladir/share/doc/xorgproto/xv-protocol-v2.txt new file mode 100644 index 0000000000000000000000000000000000000000..d863185b7bfb746a2fccb1f1152dbc95169ccefb --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/xv-protocol-v2.txt @@ -0,0 +1,654 @@ + + + + + + + + + + X Video Extension + Protocol Description + + Version 2 + + 25-JUL-91 + + David Carver + + Digital Equipment Corporation + Workstation Engineering/Project Athena + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Copyright 1991 by Digital Equipment Corporation, Maynard, Massachusetts, + and the Massachusetts Institute of Technology, Cambridge, Massachusetts. + + All Rights Reserved + + Permission to use, copy, modify, and distribute this software and its + documentation for any purpose and without fee is hereby granted, provided + that the above copyright notice appear in all copies and that both that + copyright notice and this permission notice appear in supporting + documentation, and that the names of Digital or MIT not be used in + advertising or publicity pertaining to distribution of the software + without specific, written prior permission. + + DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING + ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL + DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR + ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER + IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING + OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + Preface + ------- + + The following is an outline for an X video extension protocol. It + is preliminary and subject to change. My goal in writing this was + to fix some the shortcomings of existing overly simplistic + extensions while avoiding pitfalls in an overly complex extension. + + Your feedback is desired, and since the major design directions + have been stable for some time, feel free to hammer on the details + of the protocol. + + When you receive a revision of the document, refer to the changes + and issues sections to guide your review and analysis. + + + Acknowledgements + --------------- + + The following people have made major contributions to the design of + the Xv protocol: + + Branko Gerovac (DEC/Corporate Research) + Russ Sasnett (GTE/Project Athena) + Ralph Swick (DEC/Project Athena) + + Many ideas and approaches in Xv were the product of discussions + with several groups, including + + Project Athena's Visual Computing Group + The MIT X Consortium + The MIT Media Lab's Interactive Cinema Group + + + + Changes + ------- + + From version 1.3 to 2.0 + + -- Changed SetPortControl and GetPortControl to GetPortAttribute + and SetPortAttribute. + + -- Changed QueryBestSize + + -- Simplified SelectVideoNotify and SelectPortNotify requests. + + -- Changed the way SetPortControl and GetPortControl works. + + -- Added a QueryExtension request to return the version and + revision information of the extension. + + -- Changed the name of the QueryVideo request to QueryAdaptors; + Removed the list of encodings from QueryVideo and added a + QueryEncodings request. + + -- Added a PortNotify event that notifies interested clients that + a port control has been changed. + + -- Added SelectPortNotify request to select for PortNotify events. + + -- The XvInterruped reason has been replaced by two new reasons: + one for when video is preempted by another video request and + one for when video is terminated because of hard transmission + or reception errors. + + -- Changed the wording of the QueryBestSize request. Added issue + about whether or not returned sizes should maintain the + requested aspect ratio. + + + + Introduction + ------------ + + Video technology is moving very quickly. Standards for processing + high resolution video are currently a hot topic of discussion + internationally, and it will soon be possible to process video + entirely within the digital domain. The Xv extension, however, + does not attempt to address issues of digital video. Its purpose + is to provide a mechanism for support of current and near term + interactive video technology. + + It is somewhat ironic that Xv contains nothing particularly + innovative. It takes a minimalistic approach, and without a doubt + it could have been defined years ago, and with several revisions. + So, the life expectancy of Xv is not long. Nevertheless, it may + undergo further revision and experimentation that will help our + progress towards digital video systems. + + One premise of the Xv extension is that the X server is not alone. + A separate video server is often used to manage other aspects of + video processing, though the partition between what the X server + does and what a video server does is a matter of great debate. + + + Model + ----- + + This extension models video monitor capabilities in the X Window + System. Some advanced monitors support the simultaneous display + of multiple video signals (into separate windows), and that is + represented here through the ability to display video from + multiple video input adaptors into X drawables. + + Some monitors support multiple video encodings (mostly for + internationalization purposes) either through switches or + automatic detection, thus each video adaptor specifies the set of + encodings it supports. + + The requests to display video from an adaptor into a drawable are + modeled after the core PutImage request, though extended to + support scaling and source clipping. + + Video output is also supported and is symmetric with the video + input function, though fewer GC components are used. + + + Mechanism + --------- + + The Xv extension does the following: + + -- lists available video adaptors + -- identifies the number of ports each adaptor supports + -- describes what drawable formats each adaptor supports + -- describes what video encodings each adaptor supports + -- displays video from a port to a drawable + -- captures video from a drawable to a port + -- grabs and ungrabs ports + -- sets and gets port attributes + -- delivers event notification + + + + Adaptors + -------- + + A display may have multiple video input and output adaptors. An + adaptor may support multiple simultaneously active ports, and in + some cases the number of ports has no fixed limit. + + An input port receives encoded video data and converts it to a + stream of data used to update a drawable. An output port samples + data from a drawable and produces a stream of encoded video data. + + The ADAPTORINFO structure is used to describe a video adaptor. + + ADAPTORINFO: + [base-id: PORT + num-ports: CARD16 + type: SETofADAPTORTYPE + formats: LISTofFORMAT + name: STRING] + + ADAPTORTYPE: {Input, Output} + + FORMAT: + [depth: CARD8 + visual: VISUALID] + + The base-id field specifies the XID of the first port of the + adaptor. The `num-ports' field specifies how many ports the + adaptor supports. The ports of the adaptor have XIDs in the range + [base-id..base-id + num-ports - 1] + + The type attribute determines if the adaptor can process video + input, output, or input and output. The if the adaptor can + process input then Input is asserted, if the adaptor can process + output then Output is asserted. + + The drawable depths and visual types supported by the adaptor are + listed in `formats'. Note: that when video is being processed for + pixmaps the visual format is taken to be the visual of the first + pair that matches the depth of the pixmap. + + The name field contains an a vendor specific string that + identifies the adaptor. + + It should be noted that the existence of separate adaptors doesn't + necessarily imply that simultaneous operation is supported. + + + + Errors + ------ + + Port + + A Port error is returned if any request names a PORT that does not + exist. + + + Encoding + + An Encoding error is returned if any request names an ENCODINGID + that does not exist. + + + + + Query Requests + ------------------- + + QueryExtension + ==> + version: CARD16 + revision: CARD16 + + The QueryExtension request returns the extension version and + revision numbers. + + + QueryAdaptors + win: WINDOW + ==> + adaptors: LISTofADAPTORINFO + + The QueryAdaptors request returns the video adaptor information for + the screen of the specified window. + + Errors: {Window} + + + QueryEncodings + port: PORT + ==> + encodings: LISTofENCODINGINFO + + The QueryEncodings request returns the list of encodings supported + by the port adaptor. Use the SetPortAttribute request to set + which encoding a port is to process. The ENCODINGINFO record + describes an encoding: + + ENCODINGINFO: + [encoding: ENCODINGID + name: STRING + width, height: CARD16 + rate: FRACTION] + + The `encoding' field identifies an encoding supported by a port. + Its value is unique for a screen. Width and height specify the + size of the video image and rate specifies the rate at which + fields of image information are encoded. + + An encoding is identified by a string that names the encoding. + Encoding naming conventions need to be established (i.e., + something along the lines of font naming, but simpler) + + FRACTION + [numerator, denominator: INT32] + + The FRACTION structure is used to specify a fractional number. + + Errors: {Port} + + + + Put Video Requests + ------------------ + + PutVideo + port: PORT + drawable: DRAWABLE + gc: GCONTEXT + vid-x, vid-y: INT16 + vid-w, vid-h: CARD16 + drw-x, drw-y: INT16 + drw-w, drw-h: CARD16 + + The PutVideo request writes video into a drawable. The position + and size of the source rectangle is specified by vid-x, vid-y, + vid-w, and vid-h. The position and size of the destination + rectangle is specified by drw-x, drw-y, drw-w, drw-h. + + Video data is clipped to the bounds of the video encoding, scaled + to the requested drawable region size (or the closest size + supported), and clipped to the bounds of the drawable. + + If video is successfully initiated, a VideoNotify event with + detail Started is generated for the drawable. If the port is + already in use, its video is preempted, and if the new drawable is + different than the old, a VideoNotify event with detail Preempted + is generated for the old drawable. If the port is grabbed by + another client, this request is ignored, and a VideoNotify event + with detail Busy is generated for the drawable. If the port is + not receiving a valid video signal or if the video signal is + interrupted while video is active a VideoNotify event with detail + HardError is generated for the drawable. + + GC components: subwindow-mode, clip-x-origin, clip-y-origin, clip-mask. + + Errors: {Match, Value, GContext, Port, Alloc} + + + PutStill + port: PORT + drawable: DRAWABLE + gc: GCONTEXT + vid-x, vid-y: INT16 + vid-w, vid-h: CARD16 + drw-x, drw-y: INT16 + drw-w, drw-h: CARD16 + + The PutStill request writes a single frame of video into a + drawable. The position and size of the source rectangle is + specified by vid-x, vid-y, vid-w, and vid-h. The position and + size of the destination rectangle is specified by drw-x, drw-y, + drw-w, drw-h. + + Video data is clipped to the bounds of the video encoding, scaled + to the requested drawable region size (or the closest size + supported) and clipped to the bounds of the drawable. + + If the port is grabbed by another client, this request is ignored, + and a VideoNotify event with detail Busy is generated for the + drawable. If the port is not receiving a valid video signal a + VideoNotify event with detail HardError is generated for the + drawable. + + GC components: subwindow-mode, clip-x-origin, clip-y-origin, clip-mask. + + Errors: {Match, Value, GContext, Port, Alloc} + + + + Get Video Requests + ------------------ + + GetVideo + port: PORT + drawable: DRAWABLE + gc: GCONTEXT + vid-x, vid-y: INT16 + vid-w, vid-h: CARD16 + drw-x, drw-y: INT16 + drw-w, drw-h: CARD16 + + The GetVideo request outputs video from a drawable. The position + and size of the destination rectangle is specified by vid-x, + vid-y, vid-w, and vid-h. The position and size of the source + rectangle is specified by drw-x, drw-y, drw-w, and drw-h. + + Drawable data is clipped to the bounds of the drawable, scaled to + the requested video region size (or the closest size supported) + and clipped to the bounds of the video encoding. The contents of + any region not updated with drawable data is undefined. + + If video is successfully initiated, a VideoNotify event with + detail Started is generated for the drawable. If the port is + already in use, its video is preempted, and if the new drawable is + different than the old, a VideoNotify event with detail Preempted + is generated for the old drawable. If the port is grabbed by + another client, this request is ignored, and a VideoNotify event + with detail Busy is generated for the drawable. + + GC components: subwindow-mode, clip-x-origin, clip-y-origin, + clip-mask. + + Errors: {Match, Value, GContext, Port, Alloc} + + + GetStill + port: PORT + drawable: DRAWABLE + gc: GCONTEXT + vid-x, vid-y: INT16 + vid-w, vid-h: CARD16 + drw-x, drw-y: INT16 + drw-w, drw-h: CARD16 + + The GetStill request outputs video from a drawable. The position + and size of the destination rectangle is specified by vid-x, + vid-y, vid-w, and vid-h. The position and size of the source + rectangle is specified by drw-x, drw-y, drw-w, and drw-h. + + Drawable data is clipped to the bounds of the drawable, scaled to + the requested video region size (or the closest size supported) + and clipped to the bounds of the video encoding. The contents of + any region not updated with drawable data is undefined. + + If the still is successfully captured a VideoNotify event with + detail Still is generated for the drawable. If the port is + grabbed by another client, this request is ignored, and a + VideoNotify event with detail Busy is generated for the drawable. + + GC components: subwindow-mode, clip-x-origin, clip-y-origin, + clip-mask. + + Errors: {Match, Value, GContext, Port, Alloc} + + + + + Grab Requests + ------------- + + GrabPort + port: PORT + timestamp: {TIMESTAMP, CurrentTime} + ==> + status: {Success, AlreadyGrabbed, InvalidTime} + + The GrabPort request grabs a port. While a port is grabbed, only + video requests from the grabbing client are permitted. + + If timestamp specifies a time older than the current port time, a + status of InvalidTime is returned. If the port is already grabbed + by another client, a status of AlreadyGrabbed is returned. + Otherwise a status of Success is returned. The port time is + updated when the following requests are processed: GrabPort, + UngrabPort, PutVideo, PutStill, GetVideo, GetStill + + If the port is actively processing video for another client, the + video is preempted, and an VideoNotify event with detail Preempted + is generated for its drawable. + + Errors: {Port} + + + UngrabPort + port: PORT + timestamp: {TIMESTAMP, CurrentTime} + + The UngrabPort request ungrabs a port. If timestamp specifies a + time before the last connection request time of this port, the + request is ignored. + + Errors: {Port} + + + + Other Requests + -------------- + + StopVideo + port: PORT + drawable: DRAWABLE + + The StopVideo request stops active video for the specified port + and drawable. If the port isn't processing video, or if it is + processing video in a different drawable, the request is ignored. + When video is stopped a VideoNotify event with detail Stopped is + generated for the associated drawable. + + Errors: {Drawable, Port} + + + SelectVideoNotify + drawable: DRAWABLE + onoff: BOOL + + The SelectVideoNotify request enables or disables VideoNotify + event delivery to the requesting client. VideoNotify events are + generated when video starts and stops. + + Errors: {Drawable} + + + SelectPortNotify + port: PORT + onoff: BOOL + + The SelectPortNotify request enables or disables PortNotify event + delivery to the requesting client. PortNotify events are + generated when port attributes are changed using SetPortAttribute. + + Errors: {Port} + + + QueryBestSize + port: PORT + motion: BOOL + vid-w, vid-h: CARD16 + drw-w, drw-h: CARD16 + ==> + actual-width, actual-height: CARD16 + + The QueryBestSize request returns, for the given source size and + desired destination size, the closest destination size that the + port adaptor supports. The returned size will be equal + or smaller than the requested size if one is supported. If motion + is True then the requested size is intended for use with full + motion video. If motion is False, the requested size is intended + for use with stills only. + + The returned size is also chosen to maintain the requested aspect ratio + if possible. + + Errors: {Port} + + + + SetPortAttribute + port: PORT + attribute: ATOM + value: INT32 + + The SetPortAttribute request sets the value of a port attribute. + The port attribute is identified by the attribute atom. The + following strings are guaranteed to generate valid atoms using the + InternAtom request. + + String Type + ----------------------------------------------------------------- + + "XV_ENCODING" ENCODINGID + "XV_HUE" [-1000..1000] + "XV_SATURATION" [-1000..1000] + "XV_BRIGHTNESS" [-1000..1000] + "XV_CONTRAST" [-1000..1000] + + + If the given attribute doesn't match an attribute supported by the + port adaptor a Match error is generated. The supplied encoding + must be one of the encodings listed for the adaptor, otherwise an + Encoding error is generated. + + If the adaptor doesn't support the exact hue, saturation, + brightness, and contrast levels supplied, the closest levels + supported are assumed. The GetPortAttribute request can be used + to query the resulting levels. + + When a SetPortAttribute request is processed a PortNotify event is + generated for all clients that have requested port change + notification using SelectPortNotify. + + Errors: {Port, Match, Value} + + + GetPortAttribute + port: PORT + attribute: ATOM + ==> + value: INT32 + + + The GetPortAttribute request returns the current value of the + attribute identified by the given atom. If the given atom + doesn't match an attribute supported by the adaptor a Match + error is generated. + + Errors: {Port, Match} + + + + Events + ------ + + VideoNotify + drawable: DRAWABLE + port: PORT + reason: REASON + time: TIMESTAMP + + REASON: {Started, Still, Stopped, Busy, Preempted, HardError} + + A VideoNotify event is generated when video activity is started, + stopped, or unable to proceed in a drawable. + + A Started reason is generated when video starts in a drawable. + + A Stopped reason is generated when video is stopped in a + drawable upon request. + + A Busy reason is generated when a put or get request cannot + proceed because the port is grabbed by another client. + + A Preempted reason is generated when video is stopped by a + conflicting request. + + A HardError reason is generated when the video port cannot + initiate or continue processing a video request because of an + underlying transmission or reception error. + + + PortNotify + port: PORT + attribute: ATOM + value: INT32 + time: TIMESTAMP + + The PortNotify event is generated when a SetPortAttribute request + is processed. The event is delivered to all clients that have + performed a SelectPortNotify request for the port. The event + contains the atom identifying the attribute that changed, and the + new value of that attribute. diff --git a/miniconda3/envs/ladir/share/doc/xorgproto/xwaylandproto.txt b/miniconda3/envs/ladir/share/doc/xorgproto/xwaylandproto.txt new file mode 100644 index 0000000000000000000000000000000000000000..25fdf87437191dc3df33b4e121ee3355e86afbed --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xorgproto/xwaylandproto.txt @@ -0,0 +1,96 @@ + The XWAYLAND Extension + Version 1.0 + 2022-07-29 + +1. Introduction + +The XWAYLAND extension allows clients to reliably identify whether an X server +is Xwayland. It does not provide any functionality beyond the absolute minimum +to identify as extension. + +Only Xwayland initializes this extension. Thus, if the extension is present, +the X server is Xwayland. Clients should not need the protocol detailed in this +document, a QueryExtension or ListExtensions request is sufficient to check +whether the extension is present. + +The protocol detailed in this document is merely to future-proof this extension +in case actual functionality is added in the future. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ +2. Version History + +- 1.0, July 2022: QueryVersion request only + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +3. Events and Errors + +XWAYLAND defines no events or errrors + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +4. Extension initialization + +The name of this extension is "XWAYLAND" + +┌─── + XwlQueryVersion + client-major-version: CARD16 + client-minor-version: CARD16 + ▶ + major-version: CARD16 + minor-version: CARD16 +└─── + + The client sends the highest supported version to the server + and the server replies with the highest version it supports, + but no higher than the requested version. Major versions changes + can introduce incompatibilities in existing functionality, minor + version changes introduce only backward compatible changes. + It is the clients responsibility to ensure that the server + supports a version which is compatible with its expectations. + + Backwards compatible changes include addition of new + requests. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ + +Appendix A. Protocol Encoding + +Syntactic Conventions + +This document uses the same syntactic conventions as the core X +protocol encoding document. + +A.1 Common Types + +None. + +A.2 Protocol Requests + +┌─── + XwlQueryVersion + 1 CARD8 major opcode + 1 0 XWAYLAND opcode + 2 2 length + 2 CARD16 major version + 2 CARD16 minor version + ▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 major version + 2 CARD16 minor version + 20 unused +└─── + +A.3 Protocol Events + +The XWAYLAND extension defines no events. + +A.4 Protocol Errors + +The XWAYLAND extension defines no errors. + + ❄ ❄ ❄ ❄ ❄ ❄ ❄ diff --git a/miniconda3/envs/ladir/share/doc/xproto/encoding.xml b/miniconda3/envs/ladir/share/doc/xproto/encoding.xml new file mode 100644 index 0000000000000000000000000000000000000000..0c6ef028ec8ce36e2025e5890882af4cac0596bb --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xproto/encoding.xml @@ -0,0 +1,3268 @@ + +Protocol Encoding + + +Syntactic Conventions + + +All numbers are in decimal, +unless prefixed with #x, in which case they are in hexadecimal (base 16). + + + +The general syntax used to describe requests, replies, errors, events, and +compound types is: + + + + NameofThing + encode-form + ... + encode-form + + + +Each encode-form describes a single component. + + +For components described in the protocol as: + + + name: TYPE + + + +the encode-form is: + + + + N TYPE name + + + +N is the number of bytes occupied in the data stream, +and TYPE is the interpretation of those bytes. +For example, + + + + depth: CARD8 + + + +becomes: + + + + 1 CARD8 depth + + + +For components with a static numeric value the encode-form is: + + + + N value name + + + +The value is always interpreted as an N-byte unsigned integer. +For example, +the first two bytes of a +Window +error are always zero (indicating an +error in general) and three (indicating the +Window +error in particular): + + + + 1 0 Error + 1 3 code + + + +For components described in the protocol as: + + + +name: +{ Name1,..., +NameI} + + + +the encode-form is: + + + + N name + value1 Name1 + ... + valueI NameI + + + +The value is always interpreted as an N-byte unsigned integer. +Note that the size of N is sometimes larger than that strictly required +to encode the values. +For example: + + + +class: +{ InputOutput, +InputOnly, +CopyFromParent } + + + +becomes: + + + +2 class + 0 CopyFromParent + 1 InputOutput + 2 InputOnly + + + +For components described in the protocol as: + + + +NAME: TYPE or +Alternative1 ...or +AlternativeI + + + +the encode-form is: + + + +N TYPE NAME + value1 Alternative1 + ... + valueI AlternativeI + + + +The alternative values are guaranteed not to conflict with the encoding +of TYPE. +For example: + + + +destination: WINDOW or +PointerWindow +or +InputFocus + + + +becomes: + + + +4 WINDOW destination + 0 PointerWindow + 1 InputFocus + + + +For components described in the protocol as: + + + + value-mask: BITMASK + + + +the encode-form is: + + + +N BITMASK value-mask + mask1 mask-name1 + ... + maskI mask-nameI + + + +The individual bits in the mask are specified and named, +and N is 2 or 4. +The most-significant bit in a BITMASK is reserved for use in defining +chained (multiword) bitmasks, as extensions augment existing core requests. +The precise interpretation of this bit is not yet defined here, +although a probable mechanism is that a 1-bit indicates that another N bytes +of bitmask follows, with bits within the overall mask still interpreted +from least-significant to most-significant with an N-byte unit, +with N-byte units +interpreted in stream order, and with the overall mask being byte-swapped +in individual N-byte units. + + + +For LISTofVALUE encodings, the request is followed by a section of the form: + + + + VALUEs + encode-form + ... + encode-form + + + +listing an encode-form for each VALUE. +The NAME in each encode-form keys to the corresponding BITMASK bit. +The encoding of a VALUE always occupies four bytes, +but the number of bytes specified in the encoding-form indicates how +many of the least-significant bytes are actually used; +the remaining bytes are unused and their values do not matter. + + + +In various cases, the number of bytes occupied by a component will be +specified +by a lowercase single-letter variable name instead of a specific numeric +value, and often some other component will have its value specified as a +simple numeric expression involving these variables. +Components specified with such expressions are always interpreted +as unsigned integers. +The scope of such variables is always just the enclosing request, reply, +error, event, or compound type structure. +For example: + + + +2 3+n request length +4n LISTofPOINT points + + + +For unused bytes (the values of the bytes are undefined and do no matter), +the encode-form is: + + + + N unused + + + + +If the number of unused bytes is variable, the encode-form typically is: + + + + p unused, p=pad(E) + + + +where E is some expression, + +Padding +and pad(E) is the number of bytes needed to round E up to a multiple of four. + + + + + pad(E) = (4 - (E mod 4)) mod 4 + + + + +Common Types +Typesencoding + + + + LISTofFOO + + +In this document the LISTof notation strictly means some number of repetitions +of the FOO encoding; +the actual length of the list is encoded elsewhere. + + + + + SETofFOO + + +A set is always represented by a bitmask, with a 1-bit indicating presence in +the set. + + + + + + + + + + + +BITMASK: CARD32 + + + + +WINDOW: CARD32 + + + + +PIXMAP: CARD32 + + + + +CURSOR: CARD32 + + + + +FONT: CARD32 + + + + +GCONTEXT: CARD32 + + + + +COLORMAP: CARD32 + + + + +DRAWABLE: CARD32 + + + + +FONTABLE: CARD32 + + + + +ATOM: CARD32 + + + + +VISUALID: CARD32 + + + + +BYTE: 8-bit value + + + + +INT8: 8-bit signed integer + + + + +INT16: 16-bit signed integer + + + + +INT32: 32-bit signed integer + + + + +CARD8: 8-bit unsigned integer + + + + +CARD16: 16-bit unsigned integer + + + + +CARD32: 32-bit unsigned integer + + + + +TIMESTAMP: CARD32 + + + + + + + + +BITGRAVITY + 0 Forget + 1 NorthWest + 2 North + 3 NorthEast + 4 West + 5 Center + 6 East + 7 SouthWest + 8 South + 9 SouthEast + 10 Static + +WINGRAVITY + 0 Unmap + 1 NorthWest + 2 North + 3 NorthEast + 4 West + 5 Center + 6 East + 7 SouthWest + 8 South + 9 SouthEast + 10 Static + +BOOL + 0 False + 1 True + +SETofEVENT + #x00000001 KeyPress + #x00000002 KeyRelease + #x00000004 ButtonPress + #x00000008 ButtonRelease + #x00000010 EnterWindow + #x00000020 LeaveWindow + #x00000040 PointerMotion + #x00000080 PointerMotionHint + #x00000100 Button1Motion + #x00000200 Button2Motion + #x00000400 Button3Motion + #x00000800 Button4Motion + #x00001000 Button5Motion + #x00002000 ButtonMotion + #x00004000 KeymapState + #x00008000 Exposure + #x00010000 VisibilityChange + #x00020000 StructureNotify + #x00040000 ResizeRedirect + #x00080000 SubstructureNotify + #x00100000 SubstructureRedirect + #x00200000 FocusChange + #x00400000 PropertyChange + #x00800000 ColormapChange + #x01000000 OwnerGrabButton + #xFE000000 unused but must be zero + +SETofPOINTEREVENT + encodings are the same as for SETofEVENT, except with + #xFFFF8003 unused but must be zero + +SETofDEVICEEVENT + encodings are the same as for SETofEVENT, except with + #xFFFFC0B0 unused but must be zero + +KEYSYM: CARD32 +KEYCODE: CARD8 +BUTTON: CARD8 + +SETofKEYBUTMASK + #x0001 Shift + #x0002 Lock + #x0004 Control + #x0008 Mod1 + #x0010 Mod2 + #x0020 Mod3 + #x0040 Mod4 + #x0080 Mod5 + #x0100 Button1 + #x0200 Button2 + #x0400 Button3 + #x0800 Button4 + #x1000 Button5 + #xE000 unused but must be zero + +SETofKEYMASK + encodings are the same as for SETofKEYBUTMASK, except with + #xFF00 unused but must be zero +STRING8: LISTofCARD8 +STRING16: LISTofCHAR2B + +CHAR2B + 1 CARD8 byte1 + 1 CARD8 byte2 + +POINT + 2 INT16 x + 2 INT16 y + +RECTANGLE + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + +ARC + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 INT16 angle1 + 2 INT16 angle2 + +HOST + 1 family + 0 Internet + 1 DECnet + 2 Chaos + 5 ServerInterpreted + 6 InternetV6 + 1 unused + 2 n length of address + n LISTofBYTE address + p unused, p=pad(n) + +STR + 1 n length of name in bytes + n STRING8 name + + + + + +Errors +Error reportencoding + + +Request + 1 0 Error + 1 1 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Value + 1 0 Error + 1 2 code + 2 CARD16 sequence number + 4 <32-bits> bad value + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Window + 1 0 Error + 1 3 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Pixmap + 1 0 Error + 1 4 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Atom + 1 0 Error + 1 5 code + 2 CARD16 sequence number + 4 CARD32 bad atom id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Cursor + 1 0 Error + 1 6 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Font + 1 0 Error + 1 7 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Match + 1 0 Error + 1 8 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Drawable + 1 0 Error + 1 9 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Access + 1 0 Error + 1 10 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Alloc + 1 0 Error + 1 11 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Colormap + 1 0 Error + 1 12 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +GContext + 1 0 Error + 1 13 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +IDChoice + 1 0 Error + 1 14 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Name + 1 0 Error + 1 15 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Length + 1 0 Error + 1 16 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +Implementation + 1 0 Error + 1 17 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + + + + +Keyboards + + +KEYCODE values are always greater than 7 (and less than 256). + + + +KEYSYM values with the bit #x10000000 set are reserved as vendor-specific. + + + +The names and encodings of the standard KEYSYM values are contained in +Appendix A, Keysym Encoding. + + + + +Pointers + + +BUTTON values are numbered starting with one. + + + + +Predefined Atoms +Atompredefined + + +PRIMARY 1 WM_NORMAL_HINTS 40 +SECONDARY 2 WM_SIZE_HINTS 41 +ARC 3 WM_ZOOM_HINTS 42 +ATOM 4 MIN_SPACE 43 +BITMAP 5 NORM_SPACE 44 +CARDINAL 6 MAX_SPACE 45 +COLORMAP 7 END_SPACE 46 +CURSOR 8 SUPERSCRIPT_X 47 +CUT_BUFFER0 9 SUPERSCRIPT_Y 48 +CUT_BUFFER1 10 SUBSCRIPT_X 49 +CUT_BUFFER2 11 SUBSCRIPT_Y 50 +CUT_BUFFER3 12 UNDERLINE_POSITION 51 +CUT_BUFFER4 13 UNDERLINE_THICKNESS 52 +CUT_BUFFER5 14 STRIKEOUT_ASCENT 53 +CUT_BUFFER6 15 STRIKEOUT_DESCENT 54 +CUT_BUFFER7 16 ITALIC_ANGLE 55 +DRAWABLE 17 X_HEIGHT 56 +FONT 18 QUAD_WIDTH 57 +INTEGER 19 WEIGHT 58 +PIXMAP 20 POINT_SIZE 59 +POINT 21 RESOLUTION 60 +RECTANGLE 22 COPYRIGHT 61 +RESOURCE_MANAGER 23 NOTICE 62 +RGB_COLOR_MAP 24 FONT_NAME 63 +RGB_BEST_MAP 25 FAMILY_NAME 64 +RGB_BLUE_MAP 26 FULL_NAME 65 +RGB_DEFAULT_MAP 27 CAP_HEIGHT 66 +RGB_GRAY_MAP 28 WM_CLASS 67 +RGB_GREEN_MAP 29 WM_TRANSIENT_FOR 68 +RGB_RED_MAP 30 +STRING 31 +VISUALID 32 +WINDOW 33 +WM_COMMAND 34 +WM_HINTS 35 +WM_CLIENT_MACHINE 36 +WM_ICON_NAME 37 +WM_ICON_SIZE 38 +WM_NAME 39 + + + + +Connection Setup + + +For TCP connections, +displays on a given host are numbered starting from 0, +and the server for display N listens and accepts connections on port 6000 + N. +For DECnet connections, +displays on a given host are numbered starting from 0, +and the server for display N listens and accepts connections on the object +name obtained by concatenating "X$X" with the decimal representation of N, +for example, X$X0 and X$X1. + + + +Information sent by the client at connection setup: + + + + 1 byte-order + #x42 MSB first + #x6C LSB first + 1 unused + 2 CARD16 protocol-major-version + 2 CARD16 protocol-minor-version + 2 n length of authorization-protocol-name + 2 d length of authorization-protocol-data + 2 unused + n STRING8 authorization-protocol-name + p unused, p=pad(n) + d STRING8 authorization-protocol-data + q unused, q=pad(d) + + + +Except where explicitly noted in the protocol, +all 16-bit and 32-bit quantities sent by the client must be transmitted +with the specified byte order, +and all 16-bit and 32-bit quantities returned by the server will be transmitted +with this byte order. + + + +Information received by the client if the connection is refused: + + + + 1 0 Failed + 1 n length of reason in bytes + 2 CARD16 protocol-major-version + 2 CARD16 protocol-minor-version + 2 (n+p)/4 length in 4-byte units of "additional data" + n STRING8 reason + p unused, p=pad(n) + + + +Information received by the client if further authentication is required: + + + + 1 2 Authenticate + 5 unused + 2 (n+p)/4 length in 4-byte units of "additional data" + n STRING8 reason + p unused, p=pad(n) + + + +Information received by the client if the connection is accepted: + + + + 1 1 Success + 1 unused + 2 CARD16 protocol-major-version + 2 CARD16 protocol-minor-version + 2 8+2n+(v+p+m)/4 length in 4-byte units of + "additional data" + 4 CARD32 release-number + 4 CARD32 resource-id-base + 4 CARD32 resource-id-mask + 4 CARD32 motion-buffer-size + 2 v length of vendor + 2 CARD16 maximum-request-length + 1 CARD8 number of SCREENs in roots + 1 n number for FORMATs in + pixmap-formats + 1 image-byte-order + 0 LSBFirst + 1 MSBFirst + 1 bitmap-format-bit-order + 0 LeastSignificant + 1 MostSignificant + 1 CARD8 bitmap-format-scanline-unit + 1 CARD8 bitmap-format-scanline-pad + 1 KEYCODE min-keycode + 1 KEYCODE max-keycode + 4 unused + v STRING8 vendor + p unused, p=pad(v) + 8n LISTofFORMAT pixmap-formats + m LISTofSCREEN roots (m is always a multiple of 4) + + + +FORMAT + 1 CARD8 depth + 1 CARD8 bits-per-pixel + 1 CARD8 scanline-pad + 5 unused + + + +SCREEN + 4 WINDOW root + 4 COLORMAP default-colormap + 4 CARD32 white-pixel + 4 CARD32 black-pixel + 4 SETofEVENT current-input-masks + 2 CARD16 width-in-pixels + 2 CARD16 height-in-pixels + 2 CARD16 width-in-millimeters + 2 CARD16 height-in-millimeters + 2 CARD16 min-installed-maps + 2 CARD16 max-installed-maps + 4 VISUALID root-visual + 1 backing-stores + 0 Never + 1 WhenMapped + 2 Always + 1 BOOL save-unders + 1 CARD8 root-depth + 1 CARD8 number of DEPTHs in allowed-depths + n LISTofDEPTH allowed-depths (n is always a + multiple of 4) + + + +DEPTH + 1 CARD8 depth + 1 unused + 2 n number of VISUALTYPES in visuals + 4 unused + 24n LISTofVISUALTYPE visuals + + + +VISUALTYPE + 4 VISUALID visual-id + 1 class + 0 StaticGray + 1 GrayScale + 2 StaticColor + 3 PseudoColor + 4 TrueColor + 5 DirectColor + 1 CARD8 bits-per-rgb-value + 2 CARD16 colormap-entries + 4 CARD32 red-mask + 4 CARD32 green-mask + 4 CARD32 blue-mask + 4 unused + + + + +Requests +Requestencoding + + +CreateWindow + 1 1 opcode + 1 CARD8 depth + 2 8+n request length + 4 WINDOW wid + 4 WINDOW parent + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 2 class + 0 CopyFromParent + 1 InputOutput + 2 InputOnly + 4 VISUALID visual + 0 CopyFromParent + 4 BITMASK value-mask (has n bits set to 1) + #x00000001 background-pixmap + #x00000002 background-pixel + #x00000004 border-pixmap + #x00000008 border-pixel + #x00000010 bit-gravity + #x00000020 win-gravity + #x00000040 backing-store + #x00000080 backing-planes + #x00000100 backing-pixel + #x00000200 override-redirect + #x00000400 save-under + #x00000800 event-mask + #x00001000 do-not-propagate-mask + #x00002000 colormap + #x00004000 cursor + 4n LISTofVALUE value-list + + VALUEs + 4 PIXMAP background-pixmap + 0 None + 1 ParentRelative + 4 CARD32 background-pixel + 4 PIXMAP border-pixmap + 0 CopyFromParent + 4 CARD32 border-pixel + 1 BITGRAVITY bit-gravity + 1 WINGRAVITY win-gravity + 1 backing-store + 0 NotUseful + 1 WhenMapped + 2 Always + 4 CARD32 backing-planes + 4 CARD32 backing-pixel + 1 BOOL override-redirect + 1 BOOL save-under + 4 SETofEVENT event-mask + 4 SETofDEVICEEVENT do-not-propagate-mask + 4 COLORMAP colormap + 0 CopyFromParent + 4 CURSOR cursor + 0 None + +ChangeWindowAttributes + 1 2 opcode + 1 unused + 2 3+n request length + 4 WINDOW window + 4 BITMASK value-mask (has n bits set to 1) + encodings are the same as for CreateWindow + 4n LISTofVALUE value-list + encodings are the same as for CreateWindow + +GetWindowAttributes + 1 3 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 backing-store + 0 NotUseful + 1 WhenMapped + 2 Always + 2 CARD16 sequence number + 4 3 reply length + 4 VISUALID visual + 2 class + 1 InputOutput + 2 InputOnly + 1 BITGRAVITY bit-gravity + 1 WINGRAVITY win-gravity + 4 CARD32 backing-planes + 4 CARD32 backing-pixel + 1 BOOL save-under + 1 BOOL map-is-installed + 1 map-state + 0 Unmapped + 1 Unviewable + 2 Viewable + 1 BOOL override-redirect + 4 COLORMAP colormap + 0 None + 4 SETofEVENT all-event-masks + 4 SETofEVENT your-event-mask + 2 SETofDEVICEEVENT do-not-propagate-mask + 2 unused + +DestroyWindow + 1 4 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +DestroySubwindows + 1 5 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +ChangeSaveSet + 1 6 opcode + 1 mode + 0 Insert + 1 Delete + 2 2 request length + 4 WINDOW window + +ReparentWindow + 1 7 opcode + 1 unused + 2 4 request length + 4 WINDOW window + 4 WINDOW parent + 2 INT16 x + 2 INT16 y + +MapWindow + 1 8 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +MapSubwindows + 1 9 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +UnmapWindow + 1 10 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +UnmapSubwindows + 1 11 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +ConfigureWindow + 1 12 opcode + 1 unused + 2 3+n request length + 4 WINDOW window + 2 BITMASK value-mask (has n bits set to 1) + #x0001 x + #x0002 y + #x0004 width + #x0008 height + #x0010 border-width + #x0020 sibling + #x0040 stack-mode + 2 unused + 4n LISTofVALUE value-list + + VALUEs + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 4 WINDOW sibling + 1 stack-mode + 0 Above + 1 Below + 2 TopIf + 3 BottomIf + 4 Opposite + +CirculateWindow + 1 13 opcode + 1 direction + 0 RaiseLowest + 1 LowerHighest + 2 2 request length + 4 WINDOW window + +GetGeometry + 1 14 opcode + 1 unused + 2 2 request length + 4 DRAWABLE drawable + +▶ + 1 1 Reply + 1 CARD8 depth + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW root + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 10 unused + +QueryTree + 1 15 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 4 WINDOW root + 4 WINDOW parent + 0 None + 2 n number of WINDOWs in children + 14 unused + 4n LISTofWINDOW children + +InternAtom + 1 16 opcode + 1 BOOL only-if-exists + 2 2+(n+p)/4 request length + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 ATOM atom + 0 None + 20 unused + +GetAtomName + 1 17 opcode + 1 unused + 2 2 request length + 4 ATOM atom + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 2 n length of name + 22 unused + n STRING8 name + p unused, p=pad(n) + +ChangeProperty + 1 18 opcode + 1 mode + 0 Replace + 1 Prepend + 2 Append + 2 6+(n+p)/4 request length + 4 WINDOW window + 4 ATOM property + 4 ATOM type + 1 CARD8 format + 3 unused + 4 CARD32 length of data in format units + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) + n LISTofBYTE data + (n is a multiple of 2 for format = 16) + (n is a multiple of 4 for format = 32) + p unused, p=pad(n) + + +DeleteProperty + 1 19 opcode + 1 unused + 2 3 request length + 4 WINDOW window + 4 ATOM property + +GetProperty + 1 20 opcode + 1 BOOL delete + 2 6 request length + 4 WINDOW window + 4 ATOM property + 4 ATOM type + 0 AnyPropertyType + 4 CARD32 long-offset + 4 CARD32 long-length + +▶ + 1 1 Reply + 1 CARD8 format + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 4 ATOM type + 0 None + 4 CARD32 bytes-after + 4 CARD32 length of value in format units + (= 0 for format = 0) + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) + 12 unused + n LISTofBYTE value + (n is zero for format = 0) + (n is a multiple of 2 for format = 16) + (n is a multiple of 4 for format = 32) + p unused, p=pad(n) + +ListProperties + 1 21 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 2 n number of ATOMs in atoms + 22 unused + 4n LISTofATOM atoms + +SetSelectionOwner + 1 22 opcode + 1 unused + 2 4 request length + 4 WINDOW owner + 0 None + 4 ATOM selection + 4 TIMESTAMP time + 0 CurrentTime + +GetSelectionOwner + 1 23 opcode + 1 unused + 2 2 request length + 4 ATOM selection + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW owner + 0 None + 20 unused + +ConvertSelection + 1 24 opcode + 1 unused + 2 6 request length + 4 WINDOW requestor + 4 ATOM selection + 4 ATOM target + 4 ATOM property + 0 None + 4 TIMESTAMP time + 0 CurrentTime + +SendEvent + 1 25 opcode + 1 BOOL propagate + 2 11 requestlength + 4 WINDOW destination + 0 PointerWindow + 1 InputFocus + 4 SETofEVENT event-mask + 32 event + standard event format (see the Events section) + +GrabPointer + 1 26 opcode + 1 BOOL owner-events + 2 6 request length + 4 WINDOW grab-window + 2 SETofPOINTEREVENT event-mask + 1 pointer-mode + 0 Synchronous + 1 Asynchronous + 1 keyboard-mode + 0 Synchronous + 1 Asynchronous + 4 WINDOW confine-to + 0 None + 4 CURSOR cursor + 0 None + 4 TIMESTAMP time + 0 CurrentTime + +▶ + 1 1 Reply + 1 status + 0 Success + 1 AlreadyGrabbed + 2 InvalidTime + 3 NotViewable + 4 Frozen + 2 CARD16 sequence number + 4 0 reply length + 24 unused + +UngrabPointer + 1 27 opcode + 1 unused + 2 2 request length + 4 TIMESTAMP time + 0 CurrentTime + +GrabButton + 1 28 opcode + 1 BOOL owner-events + 2 6 request length + 4 WINDOW grab-window + 2 SETofPOINTEREVENT event-mask + 1 pointer-mode + 0 Synchronous + 1 Asynchronous + 1 keyboard-mode + 0 Synchronous + 1 Asynchronous + 4 WINDOW confine-to + 0 None + 4 CURSOR cursor + 0 None + 1 BUTTON button + 0 AnyButton + 1 unused + 2 SETofKEYMASK modifiers + #x8000 AnyModifier + +UngrabButton + 1 29 opcode + 1 BUTTON button + 0 AnyButton + 2 3 request length + 4 WINDOW grab-window + 2 SETofKEYMASK modifiers + #x8000 AnyModifier + 2 unused + +ChangeActivePointerGrab + 1 30 opcode + 1 unused + 2 4 request length + 4 CURSOR cursor + 0 None + 4 TIMESTAMP time + 0 CurrentTime + 2 SETofPOINTEREVENT event-mask + 2 unused + +GrabKeyboard + 1 31 opcode + 1 BOOL owner-events + 2 4 request length + 4 WINDOW grab-window + 4 TIMESTAMP time + 0 CurrentTime + 1 pointer-mode + 0 Synchronous + 1 Asynchronous + 1 keyboard-mode + 0 Synchronous + 1 Asynchronous + 2 unused + +▶ + 1 1 Reply + 1 status + 0 Success + 1 AlreadyGrabbed + 2 InvalidTime + 3 NotViewable + 4 Frozen + 2 CARD16 sequence number + 4 0 reply length + 24 unused + +UngrabKeyboard + 1 32 opcode + 1 unused + 2 2 request length + 4 TIMESTAMP time + 0 CurrentTime + +GrabKey + 1 33 opcode + 1 BOOL owner-events + 2 4 request length + 4 WINDOW grab-window + 2 SETofKEYMASK modifiers + #x8000 AnyModifier + 1 KEYCODE key + 0 AnyKey + 1 pointer-mode + 0 Synchronous + 1 Asynchronous + 1 keyboard-mode + 0 Synchronous + 1 Asynchronous + 3 unused + +UngrabKey + 1 34 opcode + 1 KEYCODE key + 0 AnyKey + 2 3 request length + 4 WINDOW grab-window + 2 SETofKEYMASK modifiers + #x8000 AnyModifier + 2 unused + +AllowEvents + 1 35 opcode + 1 mode + 0 AsyncPointer + 1 SyncPointer + 2 ReplayPointer + 3 AsyncKeyboard + 4 SyncKeyboard + 5 ReplayKeyboard + 6 AsyncBoth + 7 SyncBoth + 2 2 request length + 4 TIMESTAMP time + 0 CurrentTime + +GrabServer + 1 36 opcode + 1 unused + 2 1 request length + +UngrabServer + 1 37 opcode + 1 unused + 2 1 request length + +QueryPointer + 1 38 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 BOOL same-screen + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW root + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 win-x + 2 INT16 win-y + 2 SETofKEYBUTMASK mask + 6 unused + +GetMotionEvents + 1 39 opcode + 1 unused + 2 4 request length + 4 WINDOW window + 4 TIMESTAMP start + 0 CurrentTime + 4 TIMESTAMP stop + 0 CurrentTime + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 2n reply length + 4 n number of TIMECOORDs in events + 20 unused + 8n LISTofTIMECOORD events + + TIMECOORD + 4 TIMESTAMP time + 2 INT16 x + 2 INT16 y + +TranslateCoordinates + 1 40 opcode + 1 unused + 2 4 request length + 4 WINDOW src-window + 4 WINDOW dst-window + 2 INT16 src-x + 2 INT16 src-y +▶ + 1 1 Reply + 1 BOOL same-screen + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW child + 0 None + 2 INT16 dst-x + 2 INT16 dst-y + 16 unused + +WarpPointer + 1 41 opcode + 1 unused + 2 6 request length + 4 WINDOW src-window + 0 None + 4 WINDOW dst-window + 0 None + 2 INT16 src-x + 2 INT16 src-y + 2 CARD16 src-width + 2 CARD16 src-height + 2 INT16 dst-x + 2 INT16 dst-y + +SetInputFocus + 1 42 opcode + 1 revert-to + 0 None + 1 PointerRoot + 2 Parent + 2 3 request length + 4 WINDOW focus + 0 None + 1 PointerRoot + 4 TIMESTAMP time + 0 CurrentTime + +GetInputFocus + 1 43 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 revert-to + 0 None + 1 PointerRoot + 2 Parent + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW focus + 0 None + 1 PointerRoot + 20 unused + +QueryKeymap + 1 44 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 2 reply length + 32 LISTofCARD8 keys + +OpenFont + 1 45 opcode + 1 unused + 2 3+(n+p)/4 request length + 4 FONT fid + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +CloseFont + 1 46 opcode + 1 unused + 2 2 request length + 4 FONT font + +QueryFont + 1 47 opcode + 1 unused + 2 2 request length + 4 FONTABLE font + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 7+2n+3m reply length + 12 CHARINFO min-bounds + 4 unused + 12 CHARINFO max-bounds + 4 unused + 2 CARD16 min-char-or-byte2 + 2 CARD16 max-char-or-byte2 + 2 CARD16 default-char + 2 n number of FONTPROPs in properties + 1 draw-direction + 0 LeftToRight + 1 RightToLeft + 1 CARD8 min-byte1 + 1 CARD8 max-byte1 + 1 BOOL all-chars-exist + 2 INT16 font-ascent + 2 INT16 font-descent + 4 m number of CHARINFOs in char-infos + 8n LISTofFONTPROP properties + 12m LISTofCHARINFO char-infos + + FONTPROP + 4 ATOM name + 4 <32-bits> value + + CHARINFO + 2 INT16 left-side-bearing + 2 INT16 right-side-bearing + 2 INT16 character-width + 2 INT16 ascent + 2 INT16 descent + 2 CARD16 attributes + +QueryTextExtents + 1 48 opcode + 1 BOOL odd length, True if p = 2 + 2 2+(2n+p)/4 request length + 4 FONTABLE font + 2n STRING16 string + p unused, p=pad(2n) + +▶ + 1 1 Reply + 1 draw-direction + 0 LeftToRight + 1 RightToLeft + 2 CARD16 sequence number + 4 0 reply length + 2 INT16 font-ascent + 2 INT16 font-descent + 2 INT16 overall-ascent + 2 INT16 overall-descent + 4 INT32 overall-width + 4 INT32 overall-left + 4 INT32 overall-right + 4 unused + +ListFonts + 1 49 opcode + 1 unused + 2 2+(n+p)/4 request length + 2 CARD16 max-names + 2 n length of pattern + n STRING8 pattern + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 2 CARD16 number of STRs in names + 22 unused + n LISTofSTR names + p unused, p=pad(n) + +ListFontsWithInfo + 1 50 opcode + 1 unused + 2 2+(n+p)/4 request length + 2 CARD16 max-names + 2 n length of pattern + n STRING8 pattern + p unused, p=pad(n) + +▶ (except for last in series) + 1 1 Reply + 1 n length of name in bytes + 2 CARD16 sequence number + 4 7+2m+(n+p)/4 reply length + 12 CHARINFO min-bounds + 4 unused + 12 CHARINFO max-bounds + 4 unused + 2 CARD16 min-char-or-byte2 + 2 CARD16 max-char-or-byte2 + 2 CARD16 default-char + 2 m number of FONTPROPs in properties + 1 draw-direction + 0 LeftToRight + 1 RightToLeft + 1 CARD8 min-byte1 + 1 CARD8 max-byte1 + 1 BOOL all-chars-exist + 2 INT16 font-ascent + 2 INT16 font-descent + 4 CARD32 replies-hint + 8m LISTofFONTPROP properties + n STRING8 name + p unused, p=pad(n) + + FONTPROP + encodings are the same as for QueryFont + + CHARINFO + encodings are the same as for QueryFont + +▶ (last in series) + 1 1 Reply + 1 0 last-reply indicator + 2 CARD16 sequence number + 4 7 reply length + 52 unused + +SetFontPath + 1 51 opcode + 1 unused + 2 2+(n+p)/4 request length + 2 CARD16 number of STRs in path + 2 unused + n LISTofSTR path + p unused, p=pad(n) + +GetFontPath + 1 52 opcode + 1 unused + 2 1 request list + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 2 CARD16 number of STRs in path + 22 unused + n LISTofSTR path + p unused, p=pad(n) + +CreatePixmap + 1 53 opcode + 1 CARD8 depth + 2 4 request length + 4 PIXMAP pid + 4 DRAWABLE drawable + 2 CARD16 width + 2 CARD16 height + +FreePixmap + 1 54 opcode + 1 unused + 2 2 request length + 4 PIXMAP pixmap + +CreateGC + 1 55 opcode + 1 unused + 2 4+n request length + 4 GCONTEXT cid + 4 DRAWABLE drawable + 4 BITMASK value-mask (has n bits set to 1) + #x00000001 function + #x00000002 plane-mask + #x00000004 foreground + #x00000008 background + #x00000010 line-width + #x00000020 line-style + #x00000040 cap-style + #x00000080 join-style + #x00000100 fill-style + #x00000200 fill-rule + #x00000400 tile + #x00000800 stipple + #x00001000 tile-stipple-x-origin + #x00002000 tile-stipple-y-origin + #x00004000 font + #x00008000 subwindow-mode + #x00010000 graphics-exposures + #x00020000 clip-x-origin + #x00040000 clip-y-origin + #x00080000 clip-mask + #x00100000 dash-offset + #x00200000 dashes + #x00400000 arc-mode + 4n LISTofVALUE value-list + + VALUEs + 1 function + 0 Clear + 1 And + 2 AndReverse + 3 Copy + 4 AndInverted + 5 NoOp + 6 Xor + 7 Or + 8 Nor + 9 Equiv + 10 Invert + 11 OrReverse + 12 CopyInverted + 13 OrInverted + 14 Nand + 15 Set + 4 CARD32 plane-mask + 4 CARD32 foreground + 4 CARD32 background + 2 CARD16 line-width + 1 line-style + 0 Solid + 1 OnOffDash + 2 DoubleDash + 1 cap-style + 0 NotLast + 1 Butt + 2 Round + 3 Projecting + 1 join-style + 0 Miter + 1 Round + 2 Bevel + 1 fill-style + 0 Solid + 1 Tiled + 2 Stippled + 3 OpaqueStippled + 1 fill-rule + 0 EvenOdd + 1 Winding + 4 PIXMAP tile + 4 PIXMAP stipple + 2 INT16 tile-stipple-x-origin + 2 INT16 tile-stipple-y-origin + 4 FONT font + 1 subwindow-mode + 0 ClipByChildren + 1 IncludeInferiors + 1 BOOL graphics-exposures + 2 INT16 clip-x-origin + 2 INT16 clip-y-origin + 4 PIXMAP clip-mask + 0 None + 2 CARD16 dash-offset + 1 CARD8 dashes + 1 arc-mode + 0 Chord + 1 PieSlice + +ChangeGC + 1 56 opcode + 1 unused + 2 3+n request length + 4 GCONTEXT gc + 4 BITMASK value-mask (has n bits set to 1) + encodings are the same as for CreateGC + 4n LISTofVALUE value-list + encodings are the same as for CreateGC + +CopyGC + 1 57 opcode + 1 unused + 2 4 request length + 4 GCONTEXT src-gc + 4 GCONTEXT dst-gc + 4 BITMASK value-mask + encodings are the same as for CreateGC + +SetDashes + 1 58 opcode + 1 unused + 2 3+(n+p)/4 request length + 4 GCONTEXT gc + 2 CARD16 dash-offset + 2 n length of dashes + n LISTofCARD8 dashes + p unused, p=pad(n) + +SetClipRectangles + 1 59 opcode + 1 ordering + 0 UnSorted + 1 YSorted + 2 YXSorted + 3 YXBanded + 2 3+2n request length + 4 GCONTEXT gc + 2 INT16 clip-x-origin + 2 INT16 clip-y-origin + 8n LISTofRECTANGLE rectangles + +FreeGC + 1 60 opcode + 1 unused + 2 2 request length + 4 GCONTEXT gc + +ClearArea + 1 61 opcode + 1 BOOL exposures + 2 4 request length + 4 WINDOW window + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + +CopyArea + 1 62 opcode + 1 unused + 2 7 request length + 4 DRAWABLE src-drawable + 4 DRAWABLE dst-drawable + 4 GCONTEXT gc + 2 INT16 src-x + 2 INT16 src-y + 2 INT16 dst-x + 2 INT16 dst-y + 2 CARD16 width + 2 CARD16 height + +CopyPlane + 1 63 opcode + 1 unused + 2 8 request length + 4 DRAWABLE src-drawable + 4 DRAWABLE dst-drawable + 4 GCONTEXT gc + 2 INT16 src-x + 2 INT16 src-y + 2 INT16 dst-x + 2 INT16 dst-y + 2 CARD16 width + 2 CARD16 height + 4 CARD32 bit-plane + +PolyPoint + 1 64 opcode + 1 coordinate-mode + 0 Origin + 1 Previous + 2 3+n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 4n LISTofPOINT points + +PolyLine + 1 65 opcode + 1 coordinate-mode + 0 Origin + 1 Previous + 2 3+n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 4n LISTofPOINT points + +PolySegment + 1 66 opcode + 1 unused + 2 3+2n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 8n LISTofSEGMENT segments + + SEGMENT + 2 INT16 x1 + 2 INT16 y1 + 2 INT16 x2 + 2 INT16 y2 + +PolyRectangle + 1 67 opcode + 1 unused + 2 3+2n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 8n LISTofRECTANGLE rectangles + +PolyArc + 1 68 opcode + 1 unused + 2 3+3n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 12n LISTofARC arcs + +FillPoly + 1 69 opcode + 1 unused + 2 4+n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 1 shape + 0 Complex + 1 Nonconvex + 2 Convex + 1 coordinate-mode + 0 Origin + 1 Previous + 2 unused + 4n LISTofPOINT points + +PolyFillRectangle + 1 70 opcode + 1 unused + 2 3+2n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 8n LISTofRECTANGLE rectangles + +PolyFillArc + 1 71 opcode + 1 unused + 2 3+3n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 12n LISTofARC arcs + +PutImage + 1 72 opcode + 1 format + 0 Bitmap + 1 XYPixmap + 2 ZPixmap + 2 6+(n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 CARD16 width + 2 CARD16 height + 2 INT16 dst-x + 2 INT16 dst-y + 1 CARD8 left-pad + 1 CARD8 depth + 2 unused + n LISTofBYTE data + p unused, p=pad(n) + +GetImage + 1 73 opcode + 1 format + 1 XYPixmap + 2 ZPixmap + 2 5 request length + 4 DRAWABLE drawable + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 4 CARD32 plane-mask + +▶ + 1 1 Reply + 1 CARD8 depth + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 4 VISUALID visual + 0 None + 20 unused + n LISTofBYTE data + p unused, p=pad(n) + +PolyText8 + 1 74 opcode + 1 unused + 2 4+(n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 INT16 x + 2 INT16 y + n LISTofTEXTITEM8 items + p unused, p=pad(n) (p is always 0 + or 1) + + TEXTITEM8 + 1 m length of string (cannot be 255) + 1 INT8 delta + m STRING8 string + or + 1 255 font-shift indicator + 1 font byte 3 (most-significant) + 1 font byte 2 + 1 font byte 1 + 1 font byte 0 (least-significant) + +PolyText16 + 1 75 opcode + 1 unused + 2 4+(n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 INT16 x + 2 INT16 y + n LISTofTEXTITEM16 items + p unused, p=pad(n) (p must be 0 or + 1) + + TEXTITEM16 + 1 m number of CHAR2Bs in string + (cannot be 255) + 1 INT8 delta + 2m STRING16 string + or + 1 255 font-shift indicator + 1 font byte 3 (most-significant) + 1 font byte 2 + 1 font byte 1 + 1 font byte 0 (least-significant) + +ImageText8 + 1 76 opcode + 1 n length of string + 2 4+(n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 INT16 x + 2 INT16 y + n STRING8 string + p unused, p=pad(n) + +ImageText16 + 1 77 opcode + 1 n number of CHAR2Bs in string + 2 4+(2n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 INT16 x + 2 INT16 y + 2n STRING16 string + p unused, p=pad(2n) + +CreateColormap + 1 78 opcode + 1 alloc + 0 None + 1 All + 2 4 request length + 4 COLORMAP mid + 4 WINDOW window + 4 VISUALID visual + +FreeColormap + 1 79 opcode + 1 unused + 2 2 request length + 4 COLORMAP cmap + +CopyColormapAndFree + 1 80 opcode + 1 unused + 2 3 request length + 4 COLORMAP mid + 4 COLORMAP src-cmap + +InstallColormap + 1 81 opcode + 1 unused + 2 2 request length + 4 COLORMAP cmap + +UninstallColormap + 1 82 opcode + 1 unused + 2 2 request length + 4 COLORMAP cmap + +ListInstalledColormaps + 1 83 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 2 n number of COLORMAPs in cmaps + 22 unused + 4n LISTofCOLORMAP cmaps + +AllocColor + 1 84 opcode + 1 unused + 2 4 request length + 4 COLORMAP cmap + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 2 unused + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 2 unused + 4 CARD32 pixel + 12 unused + +AllocNamedColor + 1 85 opcode + 1 unused + 2 3+(n+p)/4 request length + 4 COLORMAP cmap + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 pixel + 2 CARD16 exact-red + 2 CARD16 exact-green + 2 CARD16 exact-blue + 2 CARD16 visual-red + 2 CARD16 visual-green + 2 CARD16 visual-blue + 8 unused + +AllocColorCells + 1 86 opcode + 1 BOOL contiguous + 2 3 request length + 4 COLORMAP cmap + 2 CARD16 colors + 2 CARD16 planes + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n+m reply length + 2 n number of CARD32s in pixels + 2 m number of CARD32s in masks + 20 unused + 4n LISTofCARD32 pixels + 4m LISTofCARD32 masks + +AllocColorPlanes + 1 87 opcode + 1 BOOL contiguous + 2 4 request length + 4 COLORMAP cmap + 2 CARD16 colors + 2 CARD16 reds + 2 CARD16 greens + 2 CARD16 blues + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 2 n number of CARD32s in pixels + 2 unused + 4 CARD32 red-mask + 4 CARD32 green-mask + 4 CARD32 blue-mask + 8 unused + 4n LISTofCARD32 pixels + +FreeColors + 1 88 opcode + 1 unused + 2 3+n request length + 4 COLORMAP cmap + 4 CARD32 plane-mask + 4n LISTofCARD32 pixels + +StoreColors + 1 89 opcode + 1 unused + 2 2+3n request length + 4 COLORMAP cmap + 12n LISTofCOLORITEM items + + COLORITEM + 4 CARD32 pixel + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 1 do-red, do-green, do-blue + #x01 do-red (1 is True, 0 is False) + #x02 do-green (1 is True, 0 is False) + #x04 do-blue (1 is True, 0 is False) + #xF8 unused + 1 unused + +StoreNamedColor + 1 90 opcode + 1 do-red, do-green, do-blue + #x01 do-red (1 is True, 0 is False) + #x02 do-green (1 is True, 0 is False) + #x04 do-blue (1 is True, 0 is False) + #xF8 unused + 2 4+(n+p)/4 request length + 4 COLORMAP cmap + 4 CARD32 pixel + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +QueryColors + 1 91 opcode + 1 unused + 2 2+n request length + 4 COLORMAP cmap + 4n LISTofCARD32 pixels + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 2n reply length + 2 n number of RGBs in colors + 22 unused + 8n LISTofRGB colors + + RGB + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 2 unused + +LookupColor + 1 92 opcode + 1 unused + 2 3+(n+p)/4 request length + 4 COLORMAP cmap + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 exact-red + 2 CARD16 exact-green + 2 CARD16 exact-blue + 2 CARD16 visual-red + 2 CARD16 visual-green + 2 CARD16 visual-blue + 12 unused + +CreateCursor + 1 93 opcode + 1 unused + 2 8 request length + 4 CURSOR cid + 4 PIXMAP source + 4 PIXMAP mask + 0 None + 2 CARD16 fore-red + 2 CARD16 fore-green + 2 CARD16 fore-blue + 2 CARD16 back-red + 2 CARD16 back-green + 2 CARD16 back-blue + 2 CARD16 x + 2 CARD16 y + +CreateGlyphCursor + 1 94 opcode + 1 unused + 2 8 request length + 4 CURSOR cid + 4 FONT source-font + 4 FONT mask-font + 0 None + 2 CARD16 source-char + 2 CARD16 mask-char + 2 CARD16 fore-red + 2 CARD16 fore-green + 2 CARD16 fore-blue + 2 CARD16 back-red + 2 CARD16 back-green + 2 CARD16 back-blue + +FreeCursor + 1 95 opcode + 1 unused + 2 2 request length + 4 CURSOR cursor + +RecolorCursor + 1 96 opcode + 1 unused + 2 5 request length + 4 CURSOR cursor + 2 CARD16 fore-red + 2 CARD16 fore-green + 2 CARD16 fore-blue + 2 CARD16 back-red + 2 CARD16 back-green + 2 CARD16 back-blue + +QueryBestSize + 1 97 opcode + 1 class + 0 Cursor + 1 Tile + 2 Stipple + 2 3 request length + 4 DRAWABLE drawable + 2 CARD16 width + 2 CARD16 height + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 width + 2 CARD16 height + 20 unused + +QueryExtension + 1 98 opcode + 1 unused + 2 2+(n+p)/4 request length + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 1 BOOL present + 1 CARD8 major-opcode + 1 CARD8 first-event + 1 CARD8 first-error + 20 unused + +ListExtensions + 1 99 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 CARD8 number of STRs in names + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 24 unused + n LISTofSTR names + p unused, p=pad(n) + +ChangeKeyboardMapping + 1 100 opcode + 1 n keycode-count + 2 2+nm request length + 1 KEYCODE first-keycode + 1 m keysyms-per-keycode + 2 unused + 4nm LISTofKEYSYM keysyms + +GetKeyboardMapping + 1 101 opcode + 1 unused + 2 2 request length + 1 KEYCODE first-keycode + 1 m count + 2 unused + +▶ + 1 1 Reply + 1 n keysyms-per-keycode + 2 CARD16 sequence number + 4 nm reply length (m = count field + from the request) + 24 unused + 4nm LISTofKEYSYM keysyms + +ChangeKeyboardControl + 1 102 opcode + 1 unused + 2 2+n request length + 4 BITMASK value-mask (has n bits set to 1) + #x0001 key-click-percent + #x0002 bell-percent + #x0004 bell-pitch + #x0008 bell-duration + #x0010 led + #x0020 led-mode + #x0040 key + #x0080 auto-repeat-mode + 4n LISTofVALUE value-list + + VALUEs + 1 INT8 key-click-percent + 1 INT8 bell-percent + 2 INT16 bell-pitch + 2 INT16 bell-duration + 1 CARD8 led + 1 led-mode + 0 Off + 1 On + 1 KEYCODE key + 1 auto-repeat-mode + 0 Off + 1 On + 2 Default + +GetKeyboardControl + 1 103 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 global-auto-repeat + 0 Off + 1 On + 2 CARD16 sequence number + 4 5 reply length + 4 CARD32 led-mask + 1 CARD8 key-click-percent + 1 CARD8 bell-percent + 2 CARD16 bell-pitch + 2 CARD16 bell-duration + 2 unused + 32 LISTofCARD8 auto-repeats + +Bell + 1 104 opcode + 1 INT8 percent + 2 1 request length + +ChangePointerControl + 1 105 opcode + 1 unused + 2 3 request length + 2 INT16 acceleration-numerator + 2 INT16 acceleration-denominator + 2 INT16 threshold + 1 BOOL do-acceleration + 1 BOOL do-threshold + +GetPointerControl + 1 106 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 acceleration-numerator + 2 CARD16 acceleration-denominator + 2 CARD16 threshold + 18 unused + +SetScreenSaver + 1 107 opcode + 1 unused + 2 3 request length + 2 INT16 timeout + 2 INT16 interval + 1 prefer-blanking + 0 No + 1 Yes + 2 Default + 1 allow-exposures + 0 No + 1 Yes + 2 Default + 2 unused + +GetScreenSaver + 1 108 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 timeout + 2 CARD16 interval + 1 prefer-blanking + 0 No + 1 Yes + 1 allow-exposures + 0 No + 1 Yes + 18 unused + +ChangeHosts + 1 109 opcode + 1 mode + 0 Insert + 1 Delete + 2 2+(n+p)/4 request length + 1 family + 0 Internet + 1 DECnet + 2 Chaos + 1 unused + 2 n length of address + n LISTofCARD8 address + p unused, p=pad(n) + +ListHosts + 1 110 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 mode + 0 Disabled + 1 Enabled + 2 CARD16 sequence number + 4 n/4 reply length + 2 CARD16 number of HOSTs in hosts + 22 unused + n LISTofHOST hosts (n always a multiple of 4) + +SetAccessControl + 1 111 opcode + 1 mode + 0 Disable + 1 Enable + 2 1 request length + +SetCloseDownMode + 1 112 opcode + 1 mode + 0 Destroy + 1 RetainPermanent + 2 RetainTemporary + 2 1 request length + +KillClient + 1 113 opcode + 1 unused + 2 2 request length + 4 CARD32 resource + 0 AllTemporary + +RotateProperties + 1 114 opcode + 1 unused + 2 3+n request length + 4 WINDOW window + 2 n number of properties + 2 INT16 delta + 4n LISTofATOM properties + +ForceScreenSaver + 1 115 opcode + 1 mode + 0 Reset + 1 Activate + 2 1 request length + +SetPointerMapping + 1 116 opcode + 1 n length of map + 2 1+(n+p)/4 request length + n LISTofCARD8 map + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 status + 0 Success + 1 Busy + 2 CARD16 sequence number + 4 0 reply length + 24 unused + +GetPointerMapping + 1 117 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 n length of map + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 24 unused + n LISTofCARD8 map + p unused, p=pad(n) + +SetModifierMapping + 1 118 opcode + 1 n keycodes-per-modifier + 2 1+2n request length + 8n LISTofKEYCODE keycodes + +▶ + 1 1 Reply + 1 status + 0 Success + 1 Busy + 2 Failed + 2 CARD16 sequence number + 4 0 reply length + 24 unused + +GetModifierMapping + 1 119 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 n keycodes-per-modifier + 2 CARD16 sequence number + 4 2n reply length + 24 unused + 8n LISTofKEYCODE keycodes + +NoOperation + 1 127 opcode + 1 unused + 2 1+n request length + 4n unused + + + + +Events +Eventencoding + + +KeyPress + 1 2 code + 1 KEYCODE detail + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +KeyRelease + 1 3 code + 1 KEYCODE detail + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +ButtonPress + 1 4 code + 1 BUTTON detail + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +ButtonRelease + 1 5 code + 1 BUTTON detail + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +MotionNotify + 1 6 code + 1 detail + 0 Normal + 1 Hint + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +EnterNotify + 1 7 code + 1 detail + 0 Ancestor + 1 Virtual + 2 Inferior + 3 Nonlinear + 4 NonlinearVirtual + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 mode + 0 Normal + 1 Grab + 2 Ungrab + 1 same-screen, focus + #x01 focus (1 is True, 0 is False) + #x02 same-screen (1 is True, 0 is False) + #xFC unused + +LeaveNotify + 1 8 code + 1 detail + 0 Ancestor + 1 Virtual + 2 Inferior + 3 Nonlinear + 4 NonlinearVirtual + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 mode + 0 Normal + 1 Grab + 2 Ungrab + 1 same-screen, focus + #x01 focus (1 is True, 0 is False) + #x02 same-screen (1 is True, 0 is False) + #xFC unused + +FocusIn + 1 9 code + 1 detail + 0 Ancestor + 1 Virtual + 2 Inferior + 3 Nonlinear + 4 NonlinearVirtual + 5 Pointer + 6 PointerRoot + 7 None + 2 CARD16 sequence number + 4 WINDOW event + 1 mode + 0 Normal + 1 Grab + 2 Ungrab + 3 WhileGrabbed + 23 unused + +FocusOut + 1 10 code + 1 detail + 0 Ancestor + 1 Virtual + 2 Inferior + 3 Nonlinear + 4 NonlinearVirtual + 5 Pointer + 6 PointerRoot + 7 None + 2 CARD16 sequence number + 4 WINDOW event + 1 mode + 0 Normal + 1 Grab + 2 Ungrab + 3 WhileGrabbed + 23 unused + +KeymapNotify + 1 11 code + 31 LISTofCARD8 keys (byte for keycodes 0-7 is + omitted) + +Expose + 1 12 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 2 CARD16 x + 2 CARD16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 count + 14 unused + +GraphicsExposure + 1 13 code + 1 unused + 2 CARD16 sequence number + 4 DRAWABLE drawable + 2 CARD16 x + 2 CARD16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 minor-opcode + 2 CARD16 count + 1 CARD8 major-opcode + 11 unused + +NoExposure + 1 14 code + 1 unused + 2 CARD16 sequence number + 4 DRAWABLE drawable + 2 CARD16 minor-opcode + 1 CARD8 major-opcode + 21 unused + +VisibilityNotify + 1 15 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 1 state + 0 Unobscured + 1 PartiallyObscured + 2 FullyObscured + 23 unused + +CreateNotify + 1 16 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW parent + 4 WINDOW window + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 1 BOOL override-redirect + 9 unused + +DestroyNotify + 1 17 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 20 unused + +UnmapNotify + 1 18 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 1 BOOL from-configure + 19 unused + +MapNotify + 1 19 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 1 BOOL override-redirect + 19 unused + +MapRequest + 1 20 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW parent + 4 WINDOW window + 20 unused + +ReparentNotify + 1 21 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 4 WINDOW parent + 2 INT16 x + 2 INT16 y + 1 BOOL override-redirect + 11 unused + +ConfigureNotify + 1 22 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 4 WINDOW above-sibling + 0 None + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 1 BOOL override-redirect + 5 unused + +ConfigureRequest + 1 23 code + 1 stack-mode + 0 Above + 1 Below + 2 TopIf + 3 BottomIf + 4 Opposite + 2 CARD16 sequence number + 4 WINDOW parent + 4 WINDOW window + 4 WINDOW sibling + 0 None + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 2 BITMASK value-mask + #x0001 x + #x0002 y + #x0004 width + #x0008 height + #x0010 border-width + #x0020 sibling + #x0040 stack-mode + 4 unused + +GravityNotify + 1 24 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 2 INT16 x + 2 INT16 y + 16 unused + +ResizeRequest + 1 25 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 2 CARD16 width + 2 CARD16 height + 20 unused + +CirculateNotify + 1 26 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 4 WINDOW unused + 1 place + 0 Top + 1 Bottom + 15 unused + +CirculateRequest + 1 27 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW parent + 4 WINDOW window + 4 unused + 1 place + 0 Top + 1 Bottom + 15 unused + +PropertyNotify + 1 28 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 4 ATOM atom + 4 TIMESTAMP time + 1 state + 0 NewValue + 1 Deleted + 15 unused + +SelectionClear + 1 29 code + 1 unused + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW owner + 4 ATOM selection + 16 unused + +SelectionRequest + 1 30 code + 1 unused + 2 CARD16 sequence number + 4 TIMESTAMP time + 0 CurrentTime + 4 WINDOW owner + 4 WINDOW requestor + 4 ATOM selection + 4 ATOM target + 4 ATOM property + 0 None + 4 unused + +SelectionNotify + 1 31 code + 1 unused + 2 CARD16 sequence number + 4 TIMESTAMP time + 0 CurrentTime + 4 WINDOW requestor + 4 ATOM selection + 4 ATOM target + 4 ATOM property + 0 None + 8 unused + +ColormapNotify + 1 32 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 4 COLORMAP colormap + 0 None + 1 BOOL new + 1 state + 0 Uninstalled + 1 Installed + 18 unused + +ClientMessage + 1 33 code + 1 CARD8 format + 2 CARD16 sequence number + 4 WINDOW window + 4 ATOM type + 20 data + +MappingNotify + 1 34 code + 1 unused + 2 CARD16 sequence number + 1 request + 0 Modifier + 1 Keyboard + 2 Pointer + 1 KEYCODE first-keycode + 1 CARD8 count + 25 unused + + + + diff --git a/miniconda3/envs/ladir/share/doc/xproto/glossary.xml b/miniconda3/envs/ladir/share/doc/xproto/glossary.xml new file mode 100644 index 0000000000000000000000000000000000000000..eefd327f79c157776d505d0b28bf3092ed8948f6 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xproto/glossary.xml @@ -0,0 +1,1320 @@ + +Glossary + + + + Access control list + Access control list + + +X maintains a list of hosts from which client programs can be run. +By default, +only programs on the local host and hosts specified in an initial list read +by the server can use the display. +Clients on the local host can change this access control list. +Some server implementations can also implement other authorization mechanisms +in addition to or in place of this mechanism. +The action of this mechanism can be conditional based on the authorization +protocol name and data received by the server at connection setup. + + + + + + Active grab + Active grab + + +A grab is active when the pointer or keyboard is actually owned by +the single grabbing client. + + + + + + Ancestors + Ancestors + + +If W is an inferior of A, then A is an ancestor of W. + + + + + + Atom + Atom + + +An atom is a unique ID corresponding to a string name. +Atoms are used to identify properties, types, and selections. + + + + + + Background + Background + + +An +InputOutput +window can have a background, which is defined as a pixmap. +When regions of the window have their contents lost or invalidated, +the server will automatically tile those regions with the background. + + + + + + Backing store + Backing store + + +When a server maintains the contents of a window, +the pixels saved off screen are known as a backing store. + + + + + + Bit gravity + Bitgravity + + +When a window is resized, +the contents of the window are not necessarily discarded. +It is possible to request that the server relocate the previous contents +to some region of the window (though no guarantees are made). +This attraction of window contents for some location of +a window is known as bit gravity. + + + + + + Bit plane + Bitplane + + +When a pixmap or window is thought of as a stack of bitmaps, +each bitmap is called a bit plane or plane. + + + + + + Bitmap + Bitmap + + +A bitmap is a pixmap of depth one. + + + + + + Border + Border + + +An +InputOutput +window can have a border of equal thickness on all four sides of the window. +A pixmap defines the contents of the border, +and the server automatically maintains the contents of the border. +Exposure events are never generated for border regions. + + + + + + Button grabbing + Buttongrabbing + + +Buttons on the pointer may be passively grabbed by a client. +When the button is pressed, +the pointer is then actively grabbed by the client. + + + + + + Byte order + Byte order + + +For image (pixmap/bitmap) data, +the server defines the byte order, +and clients with different native byte ordering must swap bytes as necessary. +For all other parts of the protocol, +the client defines the byte order, +and the server swaps bytes as necessary. + + + + + + Children + Children + Windowchildren + + +The children of a window are its first-level subwindows. + + + + + + Client + Client + + +An application program connects to the window system server by some +interprocess communication path, such as a TCP connection or a +shared memory buffer. +This program is referred to as a client of the window system server. +More precisely, +the client is the communication path itself; +a program with multiple paths open to the server is viewed as +multiple clients by the protocol. +Resource lifetimes are controlled by connection lifetimes, +not by program lifetimes. + + + + + + Clipping region + Clipping region + + +In a graphics context, +a bitmap or list of rectangles can be specified +to restrict output to a particular region of the window. +The image defined by the bitmap or rectangles is called a clipping region. + + + + + + Colormap + Colormap + + +A colormap consists of a set of entries defining color values. +The colormap associated with a window is used to display the contents of +the window; each pixel value indexes the colormap to produce RGB values +that drive the guns of a monitor. +Depending on hardware limitations, +one or more colormaps may be installed at one time, +so that windows associated with those maps display with correct colors. + + + + + + Connection + Connection + + +The interprocess communication path between the server and client +program is known as a connection. +A client program typically (but not necessarily) has one +connection to the server over which requests and events are sent. + + + + + + Containment + Containment + + +A window contains the pointer if the window is viewable and the +hotspot of the cursor is +within a visible region of the window or a +visible region of one of its inferiors. +The border of the window is included as part of the window for containment. +The pointer is in a window if the window contains the pointer +but no inferior contains the pointer. + + + + + + Coordinate system + Coordinate system + + +The coordinate system has the X axis horizontal and the Y axis vertical, +with the origin [0, 0] at the upper left. +Coordinates are integral, +in terms of pixels, +and coincide with pixel centers. +Each window and pixmap has its own coordinate system. +For a window, +the origin is inside the border at the inside upper left. + + + + + + Cursor + Cursor + + +A cursor is the visible shape of the pointer on a screen. +It consists of a hotspot, +a source bitmap, a shape bitmap, and a pair of colors. +The cursor defined for a window controls the visible appearance +when the pointer is in that window. + + + + + + Depth + Depth + + +The depth of a window or pixmap is the number of bits per pixel that it has. +The depth of a graphics context is the depth of the drawables it can be +used in conjunction with for graphics output. + + + + + + Device + Device + + +Keyboards, mice, tablets, track-balls, button boxes, and so on are all +collectively known as input devices. +The core protocol only deals with two devices, +the keyboard and the pointer. + + + + + + DirectColor + DirectColor + + +DirectColor +is a class of colormap in which a pixel value is decomposed into three +separate subfields for indexing. +The first subfield indexes an array to produce red intensity values. +The second subfield indexes a second array to produce blue intensity values. +The third subfield indexes a third array to produce green intensity values. +The RGB values can be changed dynamically. + + + + + + Display + Display + + +A server, together with its screens and input devices, is called a display. + + + + + + Drawable + Drawable + + +Both windows and pixmaps can be used as sources and destinations in +graphics operations. +These windows and pixmaps are collectively known as drawables. +However, an +InputOnly +window cannot be used as a source or destination in a graphics operation. + + + + + + Event + Event + + +Clients are informed of information asynchronously by means of events. +These events can be generated either asynchronously from devices +or as side effects of client requests. +Events are grouped into types. +The server never sends events to a client unless the +client has specifically asked to be informed of that type of event. +However, other clients can force events to be sent to other clients. +Events are typically reported relative to a window. + + + + + + Event mask + Eventmask + + +Events are requested relative to a window. +The set of event types that a client requests relative to a window +is described by using an event mask. + + + + + + Event synchronization + Eventsynchronization + + +There are certain race conditions possible when demultiplexing device +events to clients (in particular deciding where pointer and keyboard +events should be sent when in the middle of window management +operations). +The event synchronization mechanism allows synchronous processing +of device events. + + + + + + Event propagation + Eventpropagation + + +Device-related events propagate from the source window to ancestor +windows until some client has expressed interest in handling that type +of event or until the event is discarded explicitly. + + + + + + Event source + Eventsource + + +The window the pointer is in is the source of a device-related +event. + + + + + + Exposure event + EventExposure + + +Servers do not guarantee to preserve the contents of windows when +windows are obscured or reconfigured. +Exposure events are sent to clients to inform them when contents +of regions of windows have been lost. + + + + + + Extension + Extension + + +Named extensions to the core protocol can be defined to extend the +system. +Extension to output requests, resources, and event types are +all possible and are expected. + + + + + + Focus window + Focus window + + +The focus window is another term for the input focus. + + + + + + Font + Font + + +A font is a matrix of glyphs (typically characters). +The protocol does no translation or interpretation of character sets. +The client simply indicates values used to index the glyph array. +A font contains additional metric information to determine interglyph +and interline spacing. + + + + + + GC, GContext + GCGraphics context + GContextGraphics context + + +GC and gcontext are abbreviations for graphics context. + + + + + + Glyph + Glyph + + +A glyph is an image, typically of a character, in a font. + + + + + + Grab + GrabActive grabPassive grab + + +Keyboard keys, the keyboard, pointer buttons, the pointer, and the +server can be grabbed for exclusive use by a client. +In general, +these facilities are not intended to be used by normal applications +but are intended for various input and window managers to implement +various styles of user interfaces. + + + + + + Graphics context + Graphics context + + +Various information for graphics output is stored in a graphics context +such as foreground pixel, background pixel, line width, +clipping region, +and so on. +A graphics context can only be used with drawables that have the same root +and the same depth as the graphics context. + + + + + + Gravity + Gravity + + +See bit gravity +and window gravity. + + + + + + GrayScale + GrayScale + + +GrayScale +can be viewed as a degenerate case of +PseudoColor, +in which the red, green, and blue values in any given colormap entry are equal, +thus producing shades of gray. +The gray values can be changed dynamically. + + + + + + Hotspot + Hotspot + + +A cursor has an associated hotspot that defines the point in the +cursor corresponding to the coordinates reported for the pointer. + + + + + + Identifier + Identifier + + +An identifier is a unique value associated with a resource that clients use +to name that resource. +The identifier can be used over any connection. + + + + + + Inferiors + Inferiors + + +The inferiors of a window are all of the subwindows nested below it: +the children, the children's children, and so on. + + + + + + Input focus + Input focus + + +The input focus is normally a window defining the scope for +processing of keyboard input. +If a generated keyboard event would normally be reported to this window +or one of its inferiors, +the event is reported normally. +Otherwise, the event is reported with respect to +the focus window. +The input focus also can be set such that all +keyboard events are discarded and such that the focus +window is dynamically taken to be the root window of whatever screen +the pointer is on at each keyboard event. + + + + + + Input manager + Input manager + + +Control over keyboard input is typically provided by an input manager client. + + + + + + InputOnly window + WindowInputOnly + + +An +InputOnly +window is a window that cannot be used for graphics requests. +InputOnly +windows are invisible and can be used to control such things +as cursors, input event generation, and grabbing. +InputOnly +windows cannot have +InputOutput +windows as inferiors. + + + + + + InputOutput window + WindowInputOutput + + +An +InputOutput +window is the normal kind of opaque window, used for both input and output. +InputOutput +windows can have both +InputOutput +and +InputOnly +windows as inferiors. + + + + + + Key grabbing + Keygrabbing + + +Keys on the keyboard can be passively grabbed by a client. +When the key is pressed, +the keyboard is then actively grabbed by the client. + + + + + + Keyboard grabbing + Keyboardgrabbing + + +A client can actively grab control of the keyboard, and key events +will be sent to that client rather than the client the events would +normally have been sent to. + + + + + + Keysym + Keysym + + +An encoding of a symbol on a keycap on a keyboard. + + + + + + Mapped + Mapped window + + +A window is said to be mapped if a map call has been performed on it. +Unmapped windows and their inferiors are never viewable or visible. + + + + + + Modifier keys + Modifier keys + KeymodifierModifier keys + + +Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock, +ShiftLock, and similar keys are called modifier keys. + + + + + + Monochrome + Monochrome + + +Monochrome is a special case of +StaticGray +in which there are only two colormap entries. + + + + + + Obscure + Obscure + + +A window is obscured if some other window obscures it. +Window A obscures window B if both are viewable +InputOutput +windows, A is higher in the global stacking order, +and the rectangle defined by the outside edges of A intersects +the rectangle defined by the outside edges of B. +Note the distinction between obscure and occludes. +Also note that window borders are included in the calculation +and that a window can be obscured and yet still have visible regions. + + + + + + Occlude + Occlude + + +A window is occluded if some other window occludes it. +Window A occludes window B if both are mapped, A is higher in the global +stacking order, and the rectangle defined by the outside edges of A +intersects the rectangle defined by the outside edges of B. +Note the distinction between occludes and obscures. +Also note that window borders are included in the calculation. + + + + + + Padding + Padding + + +Some padding bytes are inserted in the data stream to maintain +alignment of the protocol requests on natural boundaries. +This increases ease of portability to some machine architectures. + + + + + + Parent window + Windowparent + + +If C is a child of P, +then P is the parent of C. + + + + + + Passive grab + Passive grab + + +Grabbing a key or button is a passive grab. +The grab activates when the key or button is actually pressed. + + + + + + Pixel value + Pixel value + + +A pixel is an N-bit value, where N is the number of bit planes used +in a particular window or pixmap (that is, +N is the depth of the window or pixmap). +For a window, +a pixel value indexes a colormap to derive an actual color to be displayed. + + + + + + Pixmap + Pixmap + + +A pixmap is a three-dimensional array of bits. +A pixmap is normally thought of as a two-dimensional array of pixels, +where each pixel can be a value from 0 to (2^N)-1 +and where N is the depth (z axis) of the pixmap. +A pixmap can also be thought of as a stack of N bitmaps. + + + + + + Plane + Plane + + +When a pixmap or window is thought of as a stack of bitmaps, +each bitmap is called a plane or bit plane. + + + + + + Plane mask + Planemask + + +Graphics operations can be restricted to only affect a subset of bit +planes of a destination. +A plane mask is a bit mask describing which planes are to be modified. +The plane mask is stored in a graphics context. + + + + + + Pointer + Pointer + + +The pointer is the pointing device attached to the cursor +and tracked on the screens. + + + + + + Pointer grabbing + Pointergrabbing + + +A client can actively grab control of the pointer. +Then button and motion events will be sent to that client +rather than the client the events would normally have been sent to. + + + + + + Pointing device + Pointing device + + +A pointing device is typically a mouse, tablet, or some other +device with effective dimensional motion. +There is only one visible cursor defined by the core protocol, +and it tracks whatever pointing device is attached as the pointer. + + + + + + Property + Property + + +Windows may have associated properties, +which consist of a name, a type, a data format, and some data. +The protocol places no interpretation on properties. +They are intended as a general-purpose naming mechanism for clients. +For example, clients might use properties to share information such as resize +hints, program names, and icon formats with a window manager. + + + + + + Property list + Property list + + +The property list of a window is the list of properties that have +been defined for the window. + + + + + + PseudoColor + PseudoColor + + +PseudoColor +is a class of colormap in which a pixel value indexes the colormap to +produce independent red, green, and blue values; +that is, the colormap is viewed as an array of triples (RGB values). +The RGB values can be changed dynamically. + + + + + + Redirecting control + Redirecting control + + +Window managers (or client programs) may want to enforce window layout +policy in various ways. +When a client attempts to change the size or position of a window, +the operation may be redirected to a specified client +rather than the operation actually being performed. + + + + + + Reply + Reply + + +Information requested by a client program is sent back to the client +with a reply. +Both events and replies are multiplexed on the same connection. +Most requests do not generate replies, +although some requests generate multiple replies. + + + + + + Request + Request + + +A command to the server is called a request. +It is a single block of data sent over a connection. + + + + + + Resource + Resource + + +Windows, pixmaps, cursors, fonts, graphics contexts, and colormaps are +known as resources. +They all have unique identifiers associated with them for naming purposes. +The lifetime of a resource usually is bounded by the lifetime of the connection +over which the resource was created. + + + + + + RGB values + RGB values + + +Red, green, and blue (RGB) intensity values are used to define color. +These values are always represented as 16-bit unsigned numbers, +with 0 being the minimum intensity and 65535 being the maximum intensity. +The server scales the values to match the display hardware. + + + + + + Root + Root + + +The root of a pixmap, colormap, or graphics context is the same as the root of +whatever drawable was used when the pixmap, colormap, or graphics context was +created. +The root of a window is the root window under which the window was created. + + + + + + Root window + Windowroot + + +Each screen has a root window covering it. +It cannot be reconfigured or unmapped, +but it otherwise acts as a full-fledged window. +A root window has no parent. + + + + + + Save set + Save set + + +The save set of a client is a list of other clients' windows that, +if they are inferiors of one of the client's windows at connection close, +should not be destroyed and that should be remapped if currently unmapped. +Save sets are typically used by window managers to avoid +lost windows if the manager terminates abnormally. + + + + + + Scanline + Scanline + + +A scanline is a list of pixel or bit values viewed as a horizontal +row (all values having the same y coordinate) of an image, with the +values ordered by increasing x coordinate. + + + + + + Scanline order + Scanline order + + +An image represented in scanline order contains scanlines ordered by +increasing y coordinate. + + + + + + Screen + Screen + + +A server can provide several independent screens, +which typically have physically independent monitors. +This would be the expected configuration when there is only a single keyboard +and pointer shared among the screens. + + + + + + Selection + Selection + + +A selection can be thought of as an indirect property with dynamic +type; that is, rather than having the property stored in the server, +it is maintained by some client (the owner). +A selection is global in nature and is thought of as belonging to the user +(although maintained by clients), rather than as being private to a particular +window subhierarchy or a particular set of clients. +When a client asks for the contents of a selection, +it specifies a selection target type. +This target type can be used to control the transmitted representation of the +contents. +For example, +if the selection is the last thing the user clicked on +and that is currently an image, then the target type might specify +whether the contents of the image should be sent in XY format or Z format. +The target type can also be used to control the class of contents transmitted; +for example, asking for the looks (fonts, line +spacing, indentation, and so on) of a paragraph selection rather than the +text of the paragraph. +The target type can also be used for other purposes. +The protocol does not constrain the semantics. + + + + + + Server + Server + + +The server provides the basic windowing mechanism. +It handles connections from clients, +multiplexes graphics requests onto the screens, +and demultiplexes input back to the appropriate clients. + + + + + + Server grabbing + Servergrabbing + + +The server can be grabbed by a single client for exclusive use. +This prevents processing of any requests from other client connections until +the grab is completed. +This is typically only a transient state for +such things as rubber-banding, pop-up menus, or to execute requests +indivisibly. + + + + + + Sibling + Sibling + + +Children of the same parent window are known as sibling windows. + + + + + + Stacking order + Stacking order + + +Sibling windows may stack on top of each other. +Windows above other windows both obscure and occlude those lower windows. +This is similar to paper on a desk. +The relationship between sibling windows is known as the stacking order. + + + + + + StaticColor + StaticColor + + +StaticColor +can be viewed as a degenerate case of +PseudoColor +in which the RGB values are predefined and read-only. + + + + + + StaticGray + StaticGray + + +StaticGray +can be viewed as a degenerate case of +GrayScale +in which the gray values are predefined and read-only. +The values are typically linear or near-linear increasing ramps. + + + + + + Stipple + Stipple + + +A stipple pattern is a bitmap that is used to tile a region that will serve +as an additional clip mask for a fill operation with the foreground +color. + + + + + + String Equivalence + String Equivalence + + +Two ISO Latin-1 STRING8 values are considered equal if they are the same +length and if corresponding bytes are either equal or are equivalent as +follows: decimal values 65 to 90 inclusive (characters A to Z) are +pairwise equivalent to decimal values 97 to 122 inclusive +(characters a to z), decimal values 192 to 214 inclusive +(characters A grave to O diaeresis) are pairwise equivalent to decimal +values 224 to 246 inclusive (characters a grave to o diaeresis), +and decimal values 216 to 222 inclusive (characters O oblique to THORN) +are pairwise equivalent to decimal values 246 to 254 inclusive +(characters o oblique to thorn). + + + + + + Tile + Tile + + +A pixmap can be replicated in two dimensions to tile a region. +The pixmap itself is also known as a tile. + + + + + + Timestamp + Timestamp + CurrentTime + + +A timestamp is a time value, expressed in milliseconds. +It typically is the time since the last +server reset. +Timestamp values wrap around (after about 49.7 days). +The server, given its current time is represented by timestamp T, +always interprets timestamps from clients by treating half of the +timestamp space as being earlier in time than T and half of the +timestamp space as being later in time than T. +One timestamp value (named +CurrentTime) +is never generated by the server. +This value is reserved for use in requests to represent the current +server time. + + + + + + TrueColor + TrueColor + + +TrueColor +can be viewed as a degenerate case of +DirectColor +in which the subfields in the pixel value directly encode +the corresponding RGB values; that is, the colormap has predefined +read-only RGB values. +The values are typically linear or near-linear increasing ramps. + + + + + + Type + Type + + +A type is an arbitrary atom used to identify the interpretation of +property data. +Types are completely uninterpreted by the server +and are solely for the benefit of clients. + + + + + + Viewable + Viewable + + +A window is viewable if it and all of its ancestors are mapped. +This does not imply that any portion of the window is actually visible. +Graphics requests can be performed on a window when it is not viewable, +but output will not be retained unless the server is maintaining +backing store. + + + + + + Visible + Visible + + +A region of a window is visible if someone looking at the screen can +actually see it; +that is, the window is viewable and the region is not occluded by any +other window. + + + + + + Window gravity + Windowgravity + + +When windows are resized, +subwindows may be repositioned automatically relative to some position +in the window. +This attraction of a subwindow to some part of its parent is known +as window gravity. + + + + + + Window manager + Windowmanager + + +Manipulation of windows on the screen and much of the user interface +(policy) is typically provided by a window manager client. + + + + + + XYFormat + XYFormat + + +The data for a pixmap is said to be in XY format if it is organized as +a set of bitmaps representing individual bit planes, with the planes +appearing from most-significant to least-significant in bit order. + + + + + + ZFormat + ZFormat + + +The data for a pixmap is said to be in Z format if it is organized as +a set of pixel values in scanline order. + + + + + diff --git a/miniconda3/envs/ladir/share/doc/xproto/keysyms.xml b/miniconda3/envs/ladir/share/doc/xproto/keysyms.xml new file mode 100644 index 0000000000000000000000000000000000000000..9999f8d88583d7468bec6f7d7fc2d6b64939191c --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xproto/keysyms.xml @@ -0,0 +1,6050 @@ + +KEYSYM Encoding +TypesKEYSYM +Keysym + + +KEYSYM values are 32-bit integers that encode the symbols on the +keycaps of a keyboard. The three most significant bits are always +zero, which leaves a 29-bit number space. For convenience, KEYSYM +values can be viewed as split into four bytes: + + + + + +Byte 1 is the most significant eight bits (three zero bits and +the most-significant five bits of the 29-bit effective value) + + + + +Byte 2 is the next most-significant eight bits + + + + +Byte 3 is the next most-significant eight bits + + + + +Byte 4 is the least-significant eight bits + + + + + +There are six categories of KEYSYM values. + + + +Special KEYSYMs + +There are two special values: +NoSymbol +and +VoidSymbol. +They are used to indicate the absence of symbols (see +Section 5, Keyboards). + + + + + + + + + + + + + + Byte 1 + Byte 2 + Byte 3 + Byte 4 + Hex. value + Name + + + + + 0 + 0 + 0 + 0 + #x00000000 + NoSymbol + + + 0 + 255 + 255 + 255 + #x00FFFFFF + VoidSymbol + + + + + + + +Latin-1 KEYSYMs + + +The Latin-1 KEYSYMs occupy the range #x0020 to #x007E and #x00A0 to +#00FF and represent the ISO 10646 / Unicode characters U+0020 to +U+007E and U+00A0 to U+00FF, respectively. + + + + +Unicode KEYSYMs +KeysymUnicode + + +These occupy the range #x01000100 to #x0110FFFF and represent the ISO +10646 / Unicode characters U+0100 to U+10FFFF, respectively. The +numeric value of a Unicode KEYSYM is the Unicode position of the +corresponding character plus #x01000000. In the interest of backwards +compatibility, clients should be able to process both the Unicode +KEYSYM and the Legacy KEYSYM for those characters where both exist. + + +Dead keys, which place an accent on the next character entered, shall +be encoded as Function KEYSYMs, and not as the Unicode KEYSYM +corresponding to an equivalent combining character. Where a keycap +indicates a specific function with a graphical symbol that is also +available in Unicode (e.g., an upwards arrow for the cursor up +function), the appropriate Function KEYSYM should be used, and not +the Unicode KEYSYM corresponding to the depicted symbol. + + + +Function KEYSYMs + + +These represent keycap symbols that do not directly represent elements +of a coded character set. Instead, they typically identify a software +function, mode, or operation (e.g., cursor up, caps lock, insert) that +can be activated using a dedicated key. Function KEYSYMs have zero +values for bytes 1 and 2. Byte 3 distinguishes between several 8-bit +sets within which byte 4 identifies the individual function key. + + + + + + + + + + Byte 3 + Byte 4 + + + + + 255 + Keyboard + + + 254 + Keyboard (XKB) Extension + + + 253 + 3270 + + + + + + +Within a national market, keyboards tend to be comparatively standard +with respect to the character keys, but they can differ significantly +on the miscellaneous function keys. Some have function keys left over +from early timesharing days, others were designed for a specific +application, such as text processing, web browsing, or accessing +audiovisual data. The symbols on the keycaps can differ significantly +between manufacturers and national markets, even where they denote the +same software function (e.g., Ctrl in the U.S. versus Strg in Germany) + + + +There are two ways of thinking about how to define KEYSYMs for such a +world: + + + + +The Engraving approach + + + + +The Common approach + + + + + +The Engraving approach is to create a KEYSYM for every unique key +engraving. This is effectively taking the union of all key engravings +on all keyboards. For example, some keyboards label function keys +across the top as F1 through Fn, and others label them as PF1 through +PFn. These would be different keys under the Engraving +approach. Likewise, Lock would differ from Shift Lock, which is +different from the up-arrow symbol that has the effect of changing +lowercase to uppercase. There are lots of other aliases such as Del, +DEL, Delete, Remove, and so forth. The Engraving approach makes it +easy to decide if a new entry should be added to the KEYSYM set: if it +does not exactly match an existing one, then a new one is created. + + + +The Common approach tries to capture all of the keys present on an +interesting number of keyboards, folding likely aliases into the same +KEYSYM. For example, Del, DEL, and Delete are all merged into a single +KEYSYM. Vendors can augment the KEYSYM set (using the vendor-specific +encoding space) to include all of their unique keys that were not +included in the standard set. Each vendor decides which of its keys +map into the standard KEYSYMs, which presumably can be overridden by a +user. It is more difficult to implement this approach, because +judgment is required about when a sufficient set of keyboards +implements an engraving to justify making it a KEYSYM in the standard +set and about which engravings should be merged into a single +KEYSYM. + + + +Although neither scheme is perfect or elegant, the Common approach has +been selected because it makes it easier to write a portable +application. Having the Delete functionality merged into a single +KEYSYM allows an application to implement a deletion function and +expect reasonable bindings on a wide set of workstations. Under the +Common approach, application writers are still free to look for and +interpret vendor-specific KEYSYMs, but because they are in the +extended set, the application developer is more conscious that they +are writing the application in a nonportable fashion. + + + +The Keyboard set is a miscellaneous collection of commonly occurring +keys on keyboards. Within this set, the numeric keypad symbols are +generally duplicates of symbols found on keys on the main part of the +keyboard, but they are distinguished here because they often have a +distinguishable semantics associated with them. + + + + + + + + + + KEYSYM value + Name + Set + + + + + #xFF08 + BACKSPACE, BACK SPACE, BACK CHAR + Keyboard + + + #xFF09 + TAB + Keyboard + + + #xFF0A + LINEFEED, LF + Keyboard + + + #xFF0B + CLEAR + Keyboard + + + #xFF0D + RETURN, ENTER + Keyboard + + + #xFF13 + PAUSE, HOLD + Keyboard + + + #xFF14 + SCROLL LOCK + Keyboard + + + #xFF15 + SYS REQ, SYSTEM REQUEST + Keyboard + + + #xFF1B + ESCAPE + Keyboard + + + #xFF20 + MULTI-KEY CHARACTER PREFACE + Keyboard + + + #xFF21 + KANJI, KANJI CONVERT + Keyboard + + + #xFF22 + MUHENKAN + Keyboard + + + #xFF23 + HENKAN MODE + Keyboard + + + #xFF24 + ROMAJI + Keyboard + + + #xFF25 + HIRAGANA + Keyboard + + + #xFF26 + KATAKANA + Keyboard + + + #xFF27 + HIRAGANA/KATAKANA TOGGLE + Keyboard + + + #xFF28 + ZENKAKU + Keyboard + + + #xFF29 + HANKAKU + Keyboard + + + #xFF2A + ZENKAKU/HANKAKU TOGGLE + Keyboard + + + #xFF2B + TOUROKU + Keyboard + + + #xFF2C + MASSYO + Keyboard + + + #xFF2D + KANA LOCK + Keyboard + + + #xFF2E + KANA SHIFT + Keyboard + + + #xFF2F + EISU SHIFT + Keyboard + + + #xFF30 + EISU TOGGLE + Keyboard + + + #xFF31 + HANGUL START/STOP (TOGGLE) + Keyboard + + + #xFF32 + HANGUL START + Keyboard + + + #xFF33 + HANGUL END, ENGLISH START + Keyboard + + + #xFF34 + START HANGUL/HANJA CONVERSION + Keyboard + + + #xFF35 + HANGUL JAMO MODE + Keyboard + + + #xFF36 + HANGUL ROMAJA MODE + Keyboard + + + #xFF37 + HANGUL CODE INPUT + Keyboard + + + #xFF38 + HANGUL JEONJA MODE + Keyboard + + + #xFF39 + HANGUL BANJA MODE + Keyboard + + + #xFF3A + HANGUL PREHANJA CONVERSION + Keyboard + + + #xFF3B + HANGUL POSTHANJA CONVERSION + Keyboard + + + #xFF3C + HANGUL SINGLE CANDIDATE + Keyboard + + + #xFF3D + HANGUL MULTIPLE CANDIDATE + Keyboard + + + #xFF3E + HANGUL PREVIOUS CANDIDATE + Keyboard + + + #xFF3F + HANGUL SPECIAL SYMBOLS + Keyboard + + + #xFF50 + HOME + Keyboard + + + #xFF51 + LEFT, MOVE LEFT, LEFT ARROW + Keyboard + + + #xFF52 + UP, MOVE UP, UP ARROW + Keyboard + + + #xFF53 + RIGHT, MOVE RIGHT, RIGHT ARROW + Keyboard + + + #xFF54 + DOWN, MOVE DOWN, DOWN ARROW + Keyboard + + + #xFF55 + PRIOR, PREVIOUS, PAGE UP + Keyboard + + + #xFF56 + NEXT, PAGE DOWN + Keyboard + + + #xFF57 + END, EOL + Keyboard + + + #xFF58 + BEGIN, BOL + Keyboard + + + #xFF60 + SELECT, MARK + Keyboard + + + #xFF61 + PRINT + Keyboard + + + #xFF62 + EXECUTE, RUN, DO + Keyboard + + + #xFF63 + INSERT, INSERT HERE + Keyboard + + + #xFF65 + UNDO, OOPS + Keyboard + + + #xFF66 + REDO, AGAIN + Keyboard + + + #xFF67 + MENU + Keyboard + + + #xFF68 + FIND, SEARCH + Keyboard + + + #xFF69 + CANCEL, STOP, ABORT, EXIT + Keyboard + + + #xFF6A + HELP + Keyboard + + + #xFF6B + BREAK + Keyboard + + + #xFF7E + MODE SWITCH, SCRIPT SWITCH, CHARACTER SET SWITCH + Keyboard + + + #xFF7F + NUM LOCK + Keyboard + + + #xFF80 + KEYPAD SPACE + Keyboard + + + #xFF89 + KEYPAD TAB + Keyboard + + + #xFF8D + KEYPAD ENTER + Keyboard + + + #xFF91 + KEYPAD F1, PF1, A + Keyboard + + + #xFF92 + KEYPAD F2, PF2, B + Keyboard + + + #xFF93 + KEYPAD F3, PF3, C + Keyboard + + + #xFF94 + KEYPAD F4, PF4, D + Keyboard + + + #xFF95 + KEYPAD HOME + Keyboard + + + #xFF96 + KEYPAD LEFT + Keyboard + + + #xFF97 + KEYPAD UP + Keyboard + + + #xFF98 + KEYPAD RIGHT + Keyboard + + + #xFF99 + KEYPAD DOWN + Keyboard + + + #xFF9A + KEYPAD PRIOR, PAGE UP + Keyboard + + + #xFF9B + KEYPAD NEXT, PAGE DOWN + Keyboard + + + #xFF9C + KEYPAD END + Keyboard + + + #xFF9D + KEYPAD BEGIN + Keyboard + + + #xFF9E + KEYPAD INSERT + Keyboard + + + #xFF9F + KEYPAD DELETE + Keyboard + + + #xFFAA + KEYPAD MULTIPLICATION SIGN, ASTERISK + Keyboard + + + #xFFAB + KEYPAD PLUS SIGN + Keyboard + + + #xFFAC + KEYPAD SEPARATOR, COMMA + Keyboard + + + #xFFAD + KEYPAD MINUS SIGN, HYPHEN + Keyboard + + + #xFFAE + KEYPAD DECIMAL POINT, FULL STOP + Keyboard + + + #xFFAF + KEYPAD DIVISION SIGN, SOLIDUS + Keyboard + + + #xFFB0 + KEYPAD DIGIT ZERO + Keyboard + + + #xFFB1 + KEYPAD DIGIT ONE + Keyboard + + + #xFFB2 + KEYPAD DIGIT TWO + Keyboard + + + #xFFB3 + KEYPAD DIGIT THREE + Keyboard + + + #xFFB4 + KEYPAD DIGIT FOUR + Keyboard + + + #xFFB5 + KEYPAD DIGIT FIVE + Keyboard + + + #xFFB6 + KEYPAD DIGIT SIX + Keyboard + + + #xFFB7 + KEYPAD DIGIT SEVEN + Keyboard + + + #xFFB8 + KEYPAD DIGIT EIGHT + Keyboard + + + #xFFB9 + KEYPAD DIGIT NINE + Keyboard + + + #xFFBD + KEYPAD EQUALS SIGN + Keyboard + + + #xFFBE + F1 + Keyboard + + + #xFFBF + F2 + Keyboard + + + #xFFC0 + F3 + Keyboard + + + #xFFC1 + F4 + Keyboard + + + #xFFC2 + F5 + Keyboard + + + #xFFC3 + F6 + Keyboard + + + #xFFC4 + F7 + Keyboard + + + #xFFC5 + F8 + Keyboard + + + #xFFC6 + F9 + Keyboard + + + #xFFC7 + F10 + Keyboard + + + #xFFC8 + F11, L1 + Keyboard + + + #xFFC9 + F12, L2 + Keyboard + + + #xFFCA + F13, L3 + Keyboard + + + #xFFCB + F14, L4 + Keyboard + + + #xFFCC + F15, L5 + Keyboard + + + #xFFCD + F16, L6 + Keyboard + + + #xFFCE + F17, L7 + Keyboard + + + #xFFCF + F18, L8 + Keyboard + + + #xFFD0 + F19, L9 + Keyboard + + + #xFFD1 + F20, L10 + Keyboard + + + #xFFD2 + F21, R1 + Keyboard + + + #xFFD3 + F22, R2 + Keyboard + + + #xFFD4 + F23, R3 + Keyboard + + + #xFFD5 + F24, R4 + Keyboard + + + #xFFD6 + F25, R5 + Keyboard + + + #xFFD7 + F26, R6 + Keyboard + + + #xFFD8 + F27, R7 + Keyboard + + + #xFFD9 + F28, R8 + Keyboard + + + #xFFDA + F29, R9 + Keyboard + + + #xFFDB + F30, R10 + Keyboard + + + #xFFDC + F31, R11 + Keyboard + + + #xFFDD + F32, R12 + Keyboard + + + #xFFDE + F33, R13 + Keyboard + + + #xFFDF + F34, R14 + Keyboard + + + #xFFE0 + F35, R15 + Keyboard + + + #xFFE1 + LEFT SHIFT + Keyboard + + + #xFFE2 + RIGHT SHIFT + Keyboard + + + #xFFE3 + LEFT CONTROL + Keyboard + + + #xFFE4 + RIGHT CONTROL + Keyboard + + + #xFFE5 + CAPS LOCK + Keyboard + + + #xFFE6 + SHIFT LOCK + Keyboard + + + #xFFE7 + LEFT META + Keyboard + + + #xFFE8 + RIGHT META + Keyboard + + + #xFFE9 + LEFT ALT + Keyboard + + + #xFFEA + RIGHT ALT + Keyboard + + + #xFFEB + LEFT SUPER + Keyboard + + + #xFFEC + RIGHT SUPER + Keyboard + + + #xFFED + LEFT HYPER + Keyboard + + + #xFFEE + RIGHT HYPER + Keyboard + + + #xFFFF + DELETE, RUBOUT + Keyboard + + + + + + +The Keyboard (XKB) Extension set, which provides among other things +a range of dead keys, is defined in "The X Keyboard Extension: +Protocol Specification", Appendix C. + + + +The 3270 set defines additional keys that are specific to IBM 3270 +terminals. + + + + + + + + + + KEYSYM value + Name + Set + + + + + #xFD01 + 3270 DUPLICATE + 3270 + + + #xFD02 + 3270 FIELDMARK + 3270 + + + #xFD03 + 3270 RIGHT2 + 3270 + + + #xFD04 + 3270 LEFT2 + 3270 + + + #xFD05 + 3270 BACKTAB + 3270 + + + #xFD06 + 3270 ERASEEOF + 3270 + + + #xFD07 + 3270 ERASEINPUT + 3270 + + + #xFD08 + 3270 RESET + 3270 + + + #xFD09 + 3270 QUIT + 3270 + + + #xFD0A + 3270 PA1 + 3270 + + + #xFD0B + 3270 PA2 + 3270 + + + #xFD0C + 3270 PA3 + 3270 + + + #xFD0D + 3270 TEST + 3270 + + + #xFD0E + 3270 ATTN + 3270 + + + #xFD0F + 3270 CURSORBLINK + 3270 + + + #xFD10 + 3270 ALTCURSOR + 3270 + + + #xFD11 + 3270 KEYCLICK + 3270 + + + #xFD12 + 3270 JUMP + 3270 + + + #xFD13 + 3270 IDENT + 3270 + + + #xFD14 + 3270 RULE + 3270 + + + #xFD15 + 3270 COPY + 3270 + + + #xFD16 + 3270 PLAY + 3270 + + + #xFD17 + 3270 SETUP + 3270 + + + #xFD18 + 3270 RECORD + 3270 + + + #xFD19 + 3270 CHANGESCREEN + 3270 + + + #xFD1A + 3270 DELETEWORD + 3270 + + + #xFD1B + 3270 EXSELECT + 3270 + + + #xFD1C + 3270 CURSORSELECT + 3270 + + + #xFD1D + 3270 PRINTSCREEN + 3270 + + + #xFD1E + 3270 ENTER + 3270 + + + + + + + + +Vendor KEYSYMs + + +The KEYSYM number range #x10000000 to #x1FFFFFFF is available for +vendor-specific extensions. Among these, the range #x11000000 to +#x1100FFFF is designated for keypad KEYSYMs. + + + + +Legacy KEYSYMs + + +These date from the time before ISO 10646 / Unicode was +available. They represent characters from a number of different older +8-bit coded character sets and have zero values for bytes 1 and +2. Byte 3 indicates a coded character set and byte 4 is the 8-bit +value of the particular character within that set. + + + + + + + + + + + Byte 3 + Byte 4 + Byte 3 + Byte 4 + + + + + 1 + Latin-2 + 11 + APL + + + 2 + Latin-3 + 12 + Hebrew + + + 3 + Latin-4 + 13 + Thai + + + 4 + Kana + 14 + Korean + + + 5 + Arabic + 15 + Latin-5 + + + 6 + Cyrillic + 16 + Latin-6 + + + 7 + Greek + 17 + Latin-7 + + + 8 + Technical + 18 + Latin-8 + + + 9 + Special + 19 + Latin-9 + + + 10 + Publishing + 32 + Currency + + + + + + +Each character set contains gaps where codes have been removed that +were duplicates with codes in previous character sets (that is, +character sets with lesser byte 3 value). + + + +The Latin, Arabic, Cyrillic, Greek, Hebrew, and Thai sets were taken +from the early drafts of the relevant ISO 8859 parts available at the +time. However, in the case of the Cyrillic and Greek sets, these +turned out differently in the final versions of the ISO standard. The +Technical, Special, and Publishing sets are based on Digital Equipment +Corporation standards, as no equivalent international standards were +available at the time. + + + +The table below lists all standardized Legacy KEYSYMs, along with the +name used in the source document. Where there exists an unambiguous +equivalent in Unicode, as it is the case with all ISO 8859 characters, +it is given in the second column as a cross reference. Where there is +no Unicode number provided, the exact semantics of the KEYSYM may have +been lost and a Unicode KEYSYM should be used instead, if available. + + + +As support of Unicode KEYSYMs increases, some or all of the Legacy +KEYSYMs may be phased out and withdrawn in future versions of this +standard. Most KEYSYMs in the sets Technical, Special, Publishing, APL +and Currency (with the exception of #x20AC) were probably never used +in practice, and were not supported by pre-Unicode fonts. In +particular, the Currency set, which was copied from Unicode, has +already been deprecated by the introduction of the Unicode KEYSYMs. + + + + + + + + + + + KEYSYM value + Unicode value + Name + Set + + + + + #x01A1 + U+0104 + LATIN CAPITAL LETTER A WITH OGONEK + Latin-2 + + + #x01A2 + U+02D8 + BREVE + Latin-2 + + + #x01A3 + U+0141 + LATIN CAPITAL LETTER L WITH STROKE + Latin-2 + + + #x01A5 + U+013D + LATIN CAPITAL LETTER L WITH CARON + Latin-2 + + + #x01A6 + U+015A + LATIN CAPITAL LETTER S WITH ACUTE + Latin-2 + + + #x01A9 + U+0160 + LATIN CAPITAL LETTER S WITH CARON + Latin-2 + + + #x01AA + U+015E + LATIN CAPITAL LETTER S WITH CEDILLA + Latin-2 + + + #x01AB + U+0164 + LATIN CAPITAL LETTER T WITH CARON + Latin-2 + + + #x01AC + U+0179 + LATIN CAPITAL LETTER Z WITH ACUTE + Latin-2 + + + #x01AE + U+017D + LATIN CAPITAL LETTER Z WITH CARON + Latin-2 + + + #x01AF + U+017B + LATIN CAPITAL LETTER Z WITH DOT ABOVE + Latin-2 + + + #x01B1 + U+0105 + LATIN SMALL LETTER A WITH OGONEK + Latin-2 + + + #x01B2 + U+02DB + OGONEK + Latin-2 + + + #x01B3 + U+0142 + LATIN SMALL LETTER L WITH STROKE + Latin-2 + + + #x01B5 + U+013E + LATIN SMALL LETTER L WITH CARON + Latin-2 + + + #x01B6 + U+015B + LATIN SMALL LETTER S WITH ACUTE + Latin-2 + + + #x01B7 + U+02C7 + CARON + Latin-2 + + + #x01B9 + U+0161 + LATIN SMALL LETTER S WITH CARON + Latin-2 + + + #x01BA + U+015F + LATIN SMALL LETTER S WITH CEDILLA + Latin-2 + + + #x01BB + U+0165 + LATIN SMALL LETTER T WITH CARON + Latin-2 + + + #x01BC + U+017A + LATIN SMALL LETTER Z WITH ACUTE + Latin-2 + + + #x01BD + U+02DD + DOUBLE ACUTE ACCENT + Latin-2 + + + #x01BE + U+017E + LATIN SMALL LETTER Z WITH CARON + Latin-2 + + + #x01BF + U+017C + LATIN SMALL LETTER Z WITH DOT ABOVE + Latin-2 + + + #x01C0 + U+0154 + LATIN CAPITAL LETTER R WITH ACUTE + Latin-2 + + + #x01C3 + U+0102 + LATIN CAPITAL LETTER A WITH BREVE + Latin-2 + + + #x01C5 + U+0139 + LATIN CAPITAL LETTER L WITH ACUTE + Latin-2 + + + #x01C6 + U+0106 + LATIN CAPITAL LETTER C WITH ACUTE + Latin-2 + + + #x01C8 + U+010C + LATIN CAPITAL LETTER C WITH CARON + Latin-2 + + + #x01CA + U+0118 + LATIN CAPITAL LETTER E WITH OGONEK + Latin-2 + + + #x01CC + U+011A + LATIN CAPITAL LETTER E WITH CARON + Latin-2 + + + #x01CF + U+010E + LATIN CAPITAL LETTER D WITH CARON + Latin-2 + + + #x01D0 + U+0110 + LATIN CAPITAL LETTER D WITH STROKE + Latin-2 + + + #x01D1 + U+0143 + LATIN CAPITAL LETTER N WITH ACUTE + Latin-2 + + + #x01D2 + U+0147 + LATIN CAPITAL LETTER N WITH CARON + Latin-2 + + + #x01D5 + U+0150 + LATIN CAPITAL LETTER O WITH DOUBLE ACUTE + Latin-2 + + + #x01D8 + U+0158 + LATIN CAPITAL LETTER R WITH CARON + Latin-2 + + + #x01D9 + U+016E + LATIN CAPITAL LETTER U WITH RING ABOVE + Latin-2 + + + #x01DB + U+0170 + LATIN CAPITAL LETTER U WITH DOUBLE ACUTE + Latin-2 + + + #x01DE + U+0162 + LATIN CAPITAL LETTER T WITH CEDILLA + Latin-2 + + + #x01E0 + U+0155 + LATIN SMALL LETTER R WITH ACUTE + Latin-2 + + + #x01E3 + U+0103 + LATIN SMALL LETTER A WITH BREVE + Latin-2 + + + #x01E5 + U+013A + LATIN SMALL LETTER L WITH ACUTE + Latin-2 + + + #x01E6 + U+0107 + LATIN SMALL LETTER C WITH ACUTE + Latin-2 + + + #x01E8 + U+010D + LATIN SMALL LETTER C WITH CARON + Latin-2 + + + #x01EA + U+0119 + LATIN SMALL LETTER E WITH OGONEK + Latin-2 + + + #x01EC + U+011B + LATIN SMALL LETTER E WITH CARON + Latin-2 + + + #x01EF + U+010F + LATIN SMALL LETTER D WITH CARON + Latin-2 + + + #x01F0 + U+0111 + LATIN SMALL LETTER D WITH STROKE + Latin-2 + + + #x01F1 + U+0144 + LATIN SMALL LETTER N WITH ACUTE + Latin-2 + + + #x01F2 + U+0148 + LATIN SMALL LETTER N WITH CARON + Latin-2 + + + #x01F5 + U+0151 + LATIN SMALL LETTER O WITH DOUBLE ACUTE + Latin-2 + + + #x01F8 + U+0159 + LATIN SMALL LETTER R WITH CARON + Latin-2 + + + #x01F9 + U+016F + LATIN SMALL LETTER U WITH RING ABOVE + Latin-2 + + + #x01FB + U+0171 + LATIN SMALL LETTER U WITH DOUBLE ACUTE + Latin-2 + + + #x01FE + U+0163 + LATIN SMALL LETTER T WITH CEDILLA + Latin-2 + + + #x01FF + U+02D9 + DOT ABOVE + Latin-2 + + + #x02A1 + U+0126 + LATIN CAPITAL LETTER H WITH STROKE + Latin-3 + + + #x02A6 + U+0124 + LATIN CAPITAL LETTER H WITH CIRCUMFLEX + Latin-3 + + + #x02A9 + U+0130 + LATIN CAPITAL LETTER I WITH DOT ABOVE + Latin-3 + + + #x02AB + U+011E + LATIN CAPITAL LETTER G WITH BREVE + Latin-3 + + + #x02AC + U+0134 + LATIN CAPITAL LETTER J WITH CIRCUMFLEX + Latin-3 + + + #x02B1 + U+0127 + LATIN SMALL LETTER H WITH STROKE + Latin-3 + + + #x02B6 + U+0125 + LATIN SMALL LETTER H WITH CIRCUMFLEX + Latin-3 + + + #x02B9 + U+0131 + LATIN SMALL LETTER DOTLESS I + Latin-3 + + + #x02BB + U+011F + LATIN SMALL LETTER G WITH BREVE + Latin-3 + + + #x02BC + U+0135 + LATIN SMALL LETTER J WITH CIRCUMFLEX + Latin-3 + + + #x02C5 + U+010A + LATIN CAPITAL LETTER C WITH DOT ABOVE + Latin-3 + + + #x02C6 + U+0108 + LATIN CAPITAL LETTER C WITH CIRCUMFLEX + Latin-3 + + + #x02D5 + U+0120 + LATIN CAPITAL LETTER G WITH DOT ABOVE + Latin-3 + + + #x02D8 + U+011C + LATIN CAPITAL LETTER G WITH CIRCUMFLEX + Latin-3 + + + #x02DD + U+016C + LATIN CAPITAL LETTER U WITH BREVE + Latin-3 + + + #x02DE + U+015C + LATIN CAPITAL LETTER S WITH CIRCUMFLEX + Latin-3 + + + #x02E5 + U+010B + LATIN SMALL LETTER C WITH DOT ABOVE + Latin-3 + + + #x02E6 + U+0109 + LATIN SMALL LETTER C WITH CIRCUMFLEX + Latin-3 + + + #x02F5 + U+0121 + LATIN SMALL LETTER G WITH DOT ABOVE + Latin-3 + + + #x02F8 + U+011D + LATIN SMALL LETTER G WITH CIRCUMFLEX + Latin-3 + + + #x02FD + U+016D + LATIN SMALL LETTER U WITH BREVE + Latin-3 + + + #x02FE + U+015D + LATIN SMALL LETTER S WITH CIRCUMFLEX + Latin-3 + + + #x03A2 + U+0138 + LATIN SMALL LETTER KRA + Latin-4 + + + #x03A3 + U+0156 + LATIN CAPITAL LETTER R WITH CEDILLA + Latin-4 + + + #x03A5 + U+0128 + LATIN CAPITAL LETTER I WITH TILDE + Latin-4 + + + #x03A6 + U+013B + LATIN CAPITAL LETTER L WITH CEDILLA + Latin-4 + + + #x03AA + U+0112 + LATIN CAPITAL LETTER E WITH MACRON + Latin-4 + + + #x03AB + U+0122 + LATIN CAPITAL LETTER G WITH CEDILLA + Latin-4 + + + #x03AC + U+0166 + LATIN CAPITAL LETTER T WITH STROKE + Latin-4 + + + #x03B3 + U+0157 + LATIN SMALL LETTER R WITH CEDILLA + Latin-4 + + + #x03B5 + U+0129 + LATIN SMALL LETTER I WITH TILDE + Latin-4 + + + #x03B6 + U+013C + LATIN SMALL LETTER L WITH CEDILLA + Latin-4 + + + #x03BA + U+0113 + LATIN SMALL LETTER E WITH MACRON + Latin-4 + + + #x03BB + U+0123 + LATIN SMALL LETTER G WITH CEDILLA + Latin-4 + + + #x03BC + U+0167 + LATIN SMALL LETTER T WITH STROKE + Latin-4 + + + #x03BD + U+014A + LATIN CAPITAL LETTER ENG + Latin-4 + + + #x03BF + U+014B + LATIN SMALL LETTER ENG + Latin-4 + + + #x03C0 + U+0100 + LATIN CAPITAL LETTER A WITH MACRON + Latin-4 + + + #x03C7 + U+012E + LATIN CAPITAL LETTER I WITH OGONEK + Latin-4 + + + #x03CC + U+0116 + LATIN CAPITAL LETTER E WITH DOT ABOVE + Latin-4 + + + #x03CF + U+012A + LATIN CAPITAL LETTER I WITH MACRON + Latin-4 + + + #x03D1 + U+0145 + LATIN CAPITAL LETTER N WITH CEDILLA + Latin-4 + + + #x03D2 + U+014C + LATIN CAPITAL LETTER O WITH MACRON + Latin-4 + + + #x03D3 + U+0136 + LATIN CAPITAL LETTER K WITH CEDILLA + Latin-4 + + + #x03D9 + U+0172 + LATIN CAPITAL LETTER U WITH OGONEK + Latin-4 + + + #x03DD + U+0168 + LATIN CAPITAL LETTER U WITH TILDE + Latin-4 + + + #x03DE + U+016A + LATIN CAPITAL LETTER U WITH MACRON + Latin-4 + + + #x03E0 + U+0101 + LATIN SMALL LETTER A WITH MACRON + Latin-4 + + + #x03E7 + U+012F + LATIN SMALL LETTER I WITH OGONEK + Latin-4 + + + #x03EC + U+0117 + LATIN SMALL LETTER E WITH DOT ABOVE + Latin-4 + + + #x03EF + U+012B + LATIN SMALL LETTER I WITH MACRON + Latin-4 + + + #x03F1 + U+0146 + LATIN SMALL LETTER N WITH CEDILLA + Latin-4 + + + #x03F2 + U+014D + LATIN SMALL LETTER O WITH MACRON + Latin-4 + + + #x03F3 + U+0137 + LATIN SMALL LETTER K WITH CEDILLA + Latin-4 + + + #x03F9 + U+0173 + LATIN SMALL LETTER U WITH OGONEK + Latin-4 + + + #x03FD + U+0169 + LATIN SMALL LETTER U WITH TILDE + Latin-4 + + + #x03FE + U+016B + LATIN SMALL LETTER U WITH MACRON + Latin-4 + + + #x047E + U+203E + OVERLINE + Kana + + + #x04A1 + U+3002 + KANA FULL STOP + Kana + + + #x04A2 + U+300C + KANA OPENING BRACKET + Kana + + + #x04A3 + U+300D + KANA CLOSING BRACKET + Kana + + + #x04A4 + U+3001 + KANA COMMA + Kana + + + #x04A5 + U+30FB + KANA CONJUNCTIVE + Kana + + + #x04A6 + U+30F2 + KANA LETTER WO + Kana + + + #x04A7 + U+30A1 + KANA LETTER SMALL A + Kana + + + #x04A8 + U+30A3 + KANA LETTER SMALL I + Kana + + + #x04A9 + U+30A5 + KANA LETTER SMALL U + Kana + + + #x04AA + U+30A7 + KANA LETTER SMALL E + Kana + + + #x04AB + U+30A9 + KANA LETTER SMALL O + Kana + + + #x04AC + U+30E3 + KANA LETTER SMALL YA + Kana + + + #x04AD + U+30E5 + KANA LETTER SMALL YU + Kana + + + #x04AE + U+30E7 + KANA LETTER SMALL YO + Kana + + + #x04AF + U+30C3 + KANA LETTER SMALL TSU + Kana + + + #x04B0 + U+30FC + PROLONGED SOUND SYMBOL + Kana + + + #x04B1 + U+30A2 + KANA LETTER A + Kana + + + #x04B2 + U+30A4 + KANA LETTER I + Kana + + + #x04B3 + U+30A6 + KANA LETTER U + Kana + + + #x04B4 + U+30A8 + KANA LETTER E + Kana + + + #x04B5 + U+30AA + KANA LETTER O + Kana + + + #x04B6 + U+30AB + KANA LETTER KA + Kana + + + #x04B7 + U+30AD + KANA LETTER KI + Kana + + + #x04B8 + U+30AF + KANA LETTER KU + Kana + + + #x04B9 + U+30B1 + KANA LETTER KE + Kana + + + #x04BA + U+30B3 + KANA LETTER KO + Kana + + + #x04BB + U+30B5 + KANA LETTER SA + Kana + + + #x04BC + U+30B7 + KANA LETTER SHI + Kana + + + #x04BD + U+30B9 + KANA LETTER SU + Kana + + + #x04BE + U+30BB + KANA LETTER SE + Kana + + + #x04BF + U+30BD + KANA LETTER SO + Kana + + + #x04C0 + U+30BF + KANA LETTER TA + Kana + + + #x04C1 + U+30C1 + KANA LETTER CHI + Kana + + + #x04C2 + U+30C4 + KANA LETTER TSU + Kana + + + #x04C3 + U+30C6 + KANA LETTER TE + Kana + + + #x04C4 + U+30C8 + KANA LETTER TO + Kana + + + #x04C5 + U+30CA + KANA LETTER NA + Kana + + + #x04C6 + U+30CB + KANA LETTER NI + Kana + + + #x04C7 + U+30CC + KANA LETTER NU + Kana + + + #x04C8 + U+30CD + KANA LETTER NE + Kana + + + #x04C9 + U+30CE + KANA LETTER NO + Kana + + + #x04CA + U+30CF + KANA LETTER HA + Kana + + + #x04CB + U+30D2 + KANA LETTER HI + Kana + + + #x04CC + U+30D5 + KANA LETTER FU + Kana + + + #x04CD + U+30D8 + KANA LETTER HE + Kana + + + #x04CE + U+30DB + KANA LETTER HO + Kana + + + #x04CF + U+30DE + KANA LETTER MA + Kana + + + #x04D0 + U+30DF + KANA LETTER MI + Kana + + + #x04D1 + U+30E0 + KANA LETTER MU + Kana + + + #x04D2 + U+30E1 + KANA LETTER ME + Kana + + + #x04D3 + U+30E2 + KANA LETTER MO + Kana + + + #x04D4 + U+30E4 + KANA LETTER YA + Kana + + + #x04D5 + U+30E6 + KANA LETTER YU + Kana + + + #x04D6 + U+30E8 + KANA LETTER YO + Kana + + + #x04D7 + U+30E9 + KANA LETTER RA + Kana + + + #x04D8 + U+30EA + KANA LETTER RI + Kana + + + #x04D9 + U+30EB + KANA LETTER RU + Kana + + + #x04DA + U+30EC + KANA LETTER RE + Kana + + + #x04DB + U+30ED + KANA LETTER RO + Kana + + + #x04DC + U+30EF + KANA LETTER WA + Kana + + + #x04DD + U+30F3 + KANA LETTER N + Kana + + + #x04DE + U+309B + VOICED SOUND SYMBOL + Kana + + + #x04DF + U+309C + SEMIVOICED SOUND SYMBOL + Kana + + + #x05AC + U+060C + ARABIC COMMA + Arabic + + + #x05BB + U+061B + ARABIC SEMICOLON + Arabic + + + #x05BF + U+061F + ARABIC QUESTION MARK + Arabic + + + #x05C1 + U+0621 + ARABIC LETTER HAMZA + Arabic + + + #x05C2 + U+0622 + ARABIC LETTER ALEF WITH MADDA ABOVE + Arabic + + + #x05C3 + U+0623 + ARABIC LETTER ALEF WITH HAMZA ABOVE + Arabic + + + #x05C4 + U+0624 + ARABIC LETTER WAW WITH HAMZA ABOVE + Arabic + + + #x05C5 + U+0625 + ARABIC LETTER ALEF WITH HAMZA BELOW + Arabic + + + #x05C6 + U+0626 + ARABIC LETTER YEH WITH HAMZA ABOVE + Arabic + + + #x05C7 + U+0627 + ARABIC LETTER ALEF + Arabic + + + #x05C8 + U+0628 + ARABIC LETTER BEH + Arabic + + + #x05C9 + U+0629 + ARABIC LETTER TEH MARBUTA + Arabic + + + #x05CA + U+062A + ARABIC LETTER TEH + Arabic + + + #x05CB + U+062B + ARABIC LETTER THEH + Arabic + + + #x05CC + U+062C + ARABIC LETTER JEEM + Arabic + + + #x05CD + U+062D + ARABIC LETTER HAH + Arabic + + + #x05CE + U+062E + ARABIC LETTER KHAH + Arabic + + + #x05CF + U+062F + ARABIC LETTER DAL + Arabic + + + #x05D0 + U+0630 + ARABIC LETTER THAL + Arabic + + + #x05D1 + U+0631 + ARABIC LETTER REH + Arabic + + + #x05D2 + U+0632 + ARABIC LETTER ZAIN + Arabic + + + #x05D3 + U+0633 + ARABIC LETTER SEEN + Arabic + + + #x05D4 + U+0634 + ARABIC LETTER SHEEN + Arabic + + + #x05D5 + U+0635 + ARABIC LETTER SAD + Arabic + + + #x05D6 + U+0636 + ARABIC LETTER DAD + Arabic + + + #x05D7 + U+0637 + ARABIC LETTER TAH + Arabic + + + #x05D8 + U+0638 + ARABIC LETTER ZAH + Arabic + + + #x05D9 + U+0639 + ARABIC LETTER AIN + Arabic + + + #x05DA + U+063A + ARABIC LETTER GHAIN + Arabic + + + #x05E0 + U+0640 + ARABIC TATWEEL + Arabic + + + #x05E1 + U+0641 + ARABIC LETTER FEH + Arabic + + + #x05E2 + U+0642 + ARABIC LETTER QAF + Arabic + + + #x05E3 + U+0643 + ARABIC LETTER KAF + Arabic + + + #x05E4 + U+0644 + ARABIC LETTER LAM + Arabic + + + #x05E5 + U+0645 + ARABIC LETTER MEEM + Arabic + + + #x05E6 + U+0646 + ARABIC LETTER NOON + Arabic + + + #x05E7 + U+0647 + ARABIC LETTER HEH + Arabic + + + #x05E8 + U+0648 + ARABIC LETTER WAW + Arabic + + + #x05E9 + U+0649 + ARABIC LETTER ALEF MAKSURA + Arabic + + + #x05EA + U+064A + ARABIC LETTER YEH + Arabic + + + #x05EB + U+064B + ARABIC FATHATAN + Arabic + + + #x05EC + U+064C + ARABIC DAMMATAN + Arabic + + + #x05ED + U+064D + ARABIC KASRATAN + Arabic + + + #x05EE + U+064E + ARABIC FATHA + Arabic + + + #x05EF + U+064F + ARABIC DAMMA + Arabic + + + #x05F0 + U+0650 + ARABIC KASRA + Arabic + + + #x05F1 + U+0651 + ARABIC SHADDA + Arabic + + + #x05F2 + U+0652 + ARABIC SUKUN + Arabic + + + #x06A1 + U+0452 + CYRILLIC SMALL LETTER DJE + Cyrillic + + + #x06A2 + U+0453 + CYRILLIC SMALL LETTER GJE + Cyrillic + + + #x06A3 + U+0451 + CYRILLIC SMALL LETTER IO + Cyrillic + + + #x06A4 + U+0454 + CYRILLIC SMALL LETTER UKRAINIAN IE + Cyrillic + + + #x06A5 + U+0455 + CYRILLIC SMALL LETTER DZE + Cyrillic + + + #x06A6 + U+0456 + CYRILLIC SMALL LETTER BYELORUSSIAN-UKRAINIAN I + Cyrillic + + + #x06A7 + U+0457 + CYRILLIC SMALL LETTER YI + Cyrillic + + + #x06A8 + U+0458 + CYRILLIC SMALL LETTER JE + Cyrillic + + + #x06A9 + U+0459 + CYRILLIC SMALL LETTER LJE + Cyrillic + + + #x06AA + U+045A + CYRILLIC SMALL LETTER NJE + Cyrillic + + + #x06AB + U+045B + CYRILLIC SMALL LETTER TSHE + Cyrillic + + + #x06AC + U+045C + CYRILLIC SMALL LETTER KJE + Cyrillic + + + #x06AD + U+0491 + CYRILLIC SMALL LETTER GHE WITH UPTURN + Cyrillic + + + #x06AE + U+045E + CYRILLIC SMALL LETTER SHORT U + Cyrillic + + + #x06AF + U+045F + CYRILLIC SMALL LETTER DZHE + Cyrillic + + + #x06B0 + U+2116 + NUMERO SIGN + Cyrillic + + + #x06B1 + U+0402 + CYRILLIC CAPITAL LETTER DJE + Cyrillic + + + #x06B2 + U+0403 + CYRILLIC CAPITAL LETTER GJE + Cyrillic + + + #x06B3 + U+0401 + CYRILLIC CAPITAL LETTER IO + Cyrillic + + + #x06B4 + U+0404 + CYRILLIC CAPITAL LETTER UKRAINIAN IE + Cyrillic + + + #x06B5 + U+0405 + CYRILLIC CAPITAL LETTER DZE + Cyrillic + + + #x06B6 + U+0406 + CYRILLIC CAPITAL LETTER BYELORUSSIAN-UKRAINIAN I + Cyrillic + + + #x06B7 + U+0407 + CYRILLIC CAPITAL LETTER YI + Cyrillic + + + #x06B8 + U+0408 + CYRILLIC CAPITAL LETTER JE + Cyrillic + + + #x06B9 + U+0409 + CYRILLIC CAPITAL LETTER LJE + Cyrillic + + + #x06BA + U+040A + CYRILLIC CAPITAL LETTER NJE + Cyrillic + + + #x06BB + U+040B + CYRILLIC CAPITAL LETTER TSHE + Cyrillic + + + #x06BC + U+040C + CYRILLIC CAPITAL LETTER KJE + Cyrillic + + + #x06BD + U+0490 + CYRILLIC CAPITAL LETTER GHE WITH UPTURN + Cyrillic + + + #x06BE + U+040E + CYRILLIC CAPITAL LETTER SHORT U + Cyrillic + + + #x06BF + U+040F + CYRILLIC CAPITAL LETTER DZHE + Cyrillic + + + #x06C0 + U+044E + CYRILLIC SMALL LETTER YU + Cyrillic + + + #x06C1 + U+0430 + CYRILLIC SMALL LETTER A + Cyrillic + + + #x06C2 + U+0431 + CYRILLIC SMALL LETTER BE + Cyrillic + + + #x06C3 + U+0446 + CYRILLIC SMALL LETTER TSE + Cyrillic + + + #x06C4 + U+0434 + CYRILLIC SMALL LETTER DE + Cyrillic + + + #x06C5 + U+0435 + CYRILLIC SMALL LETTER IE + Cyrillic + + + #x06C6 + U+0444 + CYRILLIC SMALL LETTER EF + Cyrillic + + + #x06C7 + U+0433 + CYRILLIC SMALL LETTER GHE + Cyrillic + + + #x06C8 + U+0445 + CYRILLIC SMALL LETTER HA + Cyrillic + + + #x06C9 + U+0438 + CYRILLIC SMALL LETTER I + Cyrillic + + + #x06CA + U+0439 + CYRILLIC SMALL LETTER SHORT I + Cyrillic + + + #x06CB + U+043A + CYRILLIC SMALL LETTER KA + Cyrillic + + + #x06CC + U+043B + CYRILLIC SMALL LETTER EL + Cyrillic + + + #x06CD + U+043C + CYRILLIC SMALL LETTER EM + Cyrillic + + + #x06CE + U+043D + CYRILLIC SMALL LETTER EN + Cyrillic + + + #x06CF + U+043E + CYRILLIC SMALL LETTER O + Cyrillic + + + #x06D0 + U+043F + CYRILLIC SMALL LETTER PE + Cyrillic + + + #x06D1 + U+044F + CYRILLIC SMALL LETTER YA + Cyrillic + + + #x06D2 + U+0440 + CYRILLIC SMALL LETTER ER + Cyrillic + + + #x06D3 + U+0441 + CYRILLIC SMALL LETTER ES + Cyrillic + + + #x06D4 + U+0442 + CYRILLIC SMALL LETTER TE + Cyrillic + + + #x06D5 + U+0443 + CYRILLIC SMALL LETTER U + Cyrillic + + + #x06D6 + U+0436 + CYRILLIC SMALL LETTER ZHE + Cyrillic + + + #x06D7 + U+0432 + CYRILLIC SMALL LETTER VE + Cyrillic + + + #x06D8 + U+044C + CYRILLIC SMALL LETTER SOFT SIGN + Cyrillic + + + #x06D9 + U+044B + CYRILLIC SMALL LETTER YERU + Cyrillic + + + #x06DA + U+0437 + CYRILLIC SMALL LETTER ZE + Cyrillic + + + #x06DB + U+0448 + CYRILLIC SMALL LETTER SHA + Cyrillic + + + #x06DC + U+044D + CYRILLIC SMALL LETTER E + Cyrillic + + + #x06DD + U+0449 + CYRILLIC SMALL LETTER SHCHA + Cyrillic + + + #x06DE + U+0447 + CYRILLIC SMALL LETTER CHE + Cyrillic + + + #x06DF + U+044A + CYRILLIC SMALL LETTER HARD SIGN + Cyrillic + + + #x06E0 + U+042E + CYRILLIC CAPITAL LETTER YU + Cyrillic + + + #x06E1 + U+0410 + CYRILLIC CAPITAL LETTER A + Cyrillic + + + #x06E2 + U+0411 + CYRILLIC CAPITAL LETTER BE + Cyrillic + + + #x06E3 + U+0426 + CYRILLIC CAPITAL LETTER TSE + Cyrillic + + + #x06E4 + U+0414 + CYRILLIC CAPITAL LETTER DE + Cyrillic + + + #x06E5 + U+0415 + CYRILLIC CAPITAL LETTER IE + Cyrillic + + + #x06E6 + U+0424 + CYRILLIC CAPITAL LETTER EF + Cyrillic + + + #x06E7 + U+0413 + CYRILLIC CAPITAL LETTER GHE + Cyrillic + + + #x06E8 + U+0425 + CYRILLIC CAPITAL LETTER HA + Cyrillic + + + #x06E9 + U+0418 + CYRILLIC CAPITAL LETTER I + Cyrillic + + + #x06EA + U+0419 + CYRILLIC CAPITAL LETTER SHORT I + Cyrillic + + + #x06EB + U+041A + CYRILLIC CAPITAL LETTER KA + Cyrillic + + + #x06EC + U+041B + CYRILLIC CAPITAL LETTER EL + Cyrillic + + + #x06ED + U+041C + CYRILLIC CAPITAL LETTER EM + Cyrillic + + + #x06EE + U+041D + CYRILLIC CAPITAL LETTER EN + Cyrillic + + + #x06EF + U+041E + CYRILLIC CAPITAL LETTER O + Cyrillic + + + #x06F0 + U+041F + CYRILLIC CAPITAL LETTER PE + Cyrillic + + + #x06F1 + U+042F + CYRILLIC CAPITAL LETTER YA + Cyrillic + + + #x06F2 + U+0420 + CYRILLIC CAPITAL LETTER ER + Cyrillic + + + #x06F3 + U+0421 + CYRILLIC CAPITAL LETTER ES + Cyrillic + + + #x06F4 + U+0422 + CYRILLIC CAPITAL LETTER TE + Cyrillic + + + #x06F5 + U+0423 + CYRILLIC CAPITAL LETTER U + Cyrillic + + + #x06F6 + U+0416 + CYRILLIC CAPITAL LETTER ZHE + Cyrillic + + + #x06F7 + U+0412 + CYRILLIC CAPITAL LETTER VE + Cyrillic + + + #x06F8 + U+042C + CYRILLIC CAPITAL LETTER SOFT SIGN + Cyrillic + + + #x06F9 + U+042B + CYRILLIC CAPITAL LETTER YERU + Cyrillic + + + #x06FA + U+0417 + CYRILLIC CAPITAL LETTER ZE + Cyrillic + + + #x06FB + U+0428 + CYRILLIC CAPITAL LETTER SHA + Cyrillic + + + #x06FC + U+042D + CYRILLIC CAPITAL LETTER E + Cyrillic + + + #x06FD + U+0429 + CYRILLIC CAPITAL LETTER SHCHA + Cyrillic + + + #x06FE + U+0427 + CYRILLIC CAPITAL LETTER CHE + Cyrillic + + + #x06FF + U+042A + CYRILLIC CAPITAL LETTER HARD SIGN + Cyrillic + + + #x07A1 + U+0386 + GREEK CAPITAL LETTER ALPHA WITH TONOS + Greek + + + #x07A2 + U+0388 + GREEK CAPITAL LETTER EPSILON WITH TONOS + Greek + + + #x07A3 + U+0389 + GREEK CAPITAL LETTER ETA WITH TONOS + Greek + + + #x07A4 + U+038A + GREEK CAPITAL LETTER IOTA WITH TONOS + Greek + + + #x07A5 + U+03AA + GREEK CAPITAL LETTER IOTA WITH DIALYTIKA + Greek + + + #x07A7 + U+038C + GREEK CAPITAL LETTER OMICRON WITH TONOS + Greek + + + #x07A8 + U+038E + GREEK CAPITAL LETTER UPSILON WITH TONOS + Greek + + + #x07A9 + U+03AB + GREEK CAPITAL LETTER UPSILON WITH DIALYTIKA + Greek + + + #x07AB + U+038F + GREEK CAPITAL LETTER OMEGA WITH TONOS + Greek + + + #x07AE + U+0385 + GREEK DIALYTIKA TONOS + Greek + + + #x07AF + U+2015 + HORIZONTAL BAR + Greek + + + #x07B1 + U+03AC + GREEK SMALL LETTER ALPHA WITH TONOS + Greek + + + #x07B2 + U+03AD + GREEK SMALL LETTER EPSILON WITH TONOS + Greek + + + #x07B3 + U+03AE + GREEK SMALL LETTER ETA WITH TONOS + Greek + + + #x07B4 + U+03AF + GREEK SMALL LETTER IOTA WITH TONOS + Greek + + + #x07B5 + U+03CA + GREEK SMALL LETTER IOTA WITH DIALYTIKA + Greek + + + #x07B6 + U+0390 + GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS + Greek + + + #x07B7 + U+03CC + GREEK SMALL LETTER OMICRON WITH TONOS + Greek + + + #x07B8 + U+03CD + GREEK SMALL LETTER UPSILON WITH TONOS + Greek + + + #x07B9 + U+03CB + GREEK SMALL LETTER UPSILON WITH DIALYTIKA + Greek + + + #x07BA + U+03B0 + GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS + Greek + + + #x07BB + U+03CE + GREEK SMALL LETTER OMEGA WITH TONOS + Greek + + + #x07C1 + U+0391 + GREEK CAPITAL LETTER ALPHA + Greek + + + #x07C2 + U+0392 + GREEK CAPITAL LETTER BETA + Greek + + + #x07C3 + U+0393 + GREEK CAPITAL LETTER GAMMA + Greek + + + #x07C4 + U+0394 + GREEK CAPITAL LETTER DELTA + Greek + + + #x07C5 + U+0395 + GREEK CAPITAL LETTER EPSILON + Greek + + + #x07C6 + U+0396 + GREEK CAPITAL LETTER ZETA + Greek + + + #x07C7 + U+0397 + GREEK CAPITAL LETTER ETA + Greek + + + #x07C8 + U+0398 + GREEK CAPITAL LETTER THETA + Greek + + + #x07C9 + U+0399 + GREEK CAPITAL LETTER IOTA + Greek + + + #x07CA + U+039A + GREEK CAPITAL LETTER KAPPA + Greek + + + #x07CB + U+039B + GREEK CAPITAL LETTER LAMDA + Greek + + + #x07CC + U+039C + GREEK CAPITAL LETTER MU + Greek + + + #x07CD + U+039D + GREEK CAPITAL LETTER NU + Greek + + + #x07CE + U+039E + GREEK CAPITAL LETTER XI + Greek + + + #x07CF + U+039F + GREEK CAPITAL LETTER OMICRON + Greek + + + #x07D0 + U+03A0 + GREEK CAPITAL LETTER PI + Greek + + + #x07D1 + U+03A1 + GREEK CAPITAL LETTER RHO + Greek + + + #x07D2 + U+03A3 + GREEK CAPITAL LETTER SIGMA + Greek + + + #x07D4 + U+03A4 + GREEK CAPITAL LETTER TAU + Greek + + + #x07D5 + U+03A5 + GREEK CAPITAL LETTER UPSILON + Greek + + + #x07D6 + U+03A6 + GREEK CAPITAL LETTER PHI + Greek + + + #x07D7 + U+03A7 + GREEK CAPITAL LETTER CHI + Greek + + + #x07D8 + U+03A8 + GREEK CAPITAL LETTER PSI + Greek + + + #x07D9 + U+03A9 + GREEK CAPITAL LETTER OMEGA + Greek + + + #x07E1 + U+03B1 + GREEK SMALL LETTER ALPHA + Greek + + + #x07E2 + U+03B2 + GREEK SMALL LETTER BETA + Greek + + + #x07E3 + U+03B3 + GREEK SMALL LETTER GAMMA + Greek + + + #x07E4 + U+03B4 + GREEK SMALL LETTER DELTA + Greek + + + #x07E5 + U+03B5 + GREEK SMALL LETTER EPSILON + Greek + + + #x07E6 + U+03B6 + GREEK SMALL LETTER ZETA + Greek + + + #x07E7 + U+03B7 + GREEK SMALL LETTER ETA + Greek + + + #x07E8 + U+03B8 + GREEK SMALL LETTER THETA + Greek + + + #x07E9 + U+03B9 + GREEK SMALL LETTER IOTA + Greek + + + #x07EA + U+03BA + GREEK SMALL LETTER KAPPA + Greek + + + #x07EB + U+03BB + GREEK SMALL LETTER LAMDA + Greek + + + #x07EC + U+03BC + GREEK SMALL LETTER MU + Greek + + + #x07ED + U+03BD + GREEK SMALL LETTER NU + Greek + + + #x07EE + U+03BE + GREEK SMALL LETTER XI + Greek + + + #x07EF + U+03BF + GREEK SMALL LETTER OMICRON + Greek + + + #x07F0 + U+03C0 + GREEK SMALL LETTER PI + Greek + + + #x07F1 + U+03C1 + GREEK SMALL LETTER RHO + Greek + + + #x07F2 + U+03C3 + GREEK SMALL LETTER SIGMA + Greek + + + #x07F3 + U+03C2 + GREEK SMALL LETTER FINAL SIGMA + Greek + + + #x07F4 + U+03C4 + GREEK SMALL LETTER TAU + Greek + + + #x07F5 + U+03C5 + GREEK SMALL LETTER UPSILON + Greek + + + #x07F6 + U+03C6 + GREEK SMALL LETTER PHI + Greek + + + #x07F7 + U+03C7 + GREEK SMALL LETTER CHI + Greek + + + #x07F8 + U+03C8 + GREEK SMALL LETTER PSI + Greek + + + #x07F9 + U+03C9 + GREEK SMALL LETTER OMEGA + Greek + + + #x08A1 + U+23B7 + LEFT RADICAL + Technical + + + #x08A2 + - + TOP LEFT RADICAL + Technical + + + #x08A3 + - + HORIZONTAL CONNECTOR + Technical + + + #x08A4 + U+2320 + TOP INTEGRAL + Technical + + + #x08A5 + U+2321 + BOTTOM INTEGRAL + Technical + + + #x08A6 + - + VERTICAL CONNECTOR + Technical + + + #x08A7 + U+23A1 + TOP LEFT SQUARE BRACKET + Technical + + + #x08A8 + U+23A3 + BOTTOM LEFT SQUARE BRACKET + Technical + + + #x08A9 + U+23A4 + TOP RIGHT SQUARE BRACKET + Technical + + + #x08AA + U+23A6 + BOTTOM RIGHT SQUARE BRACKET + Technical + + + #x08AB + U+239B + TOP LEFT PARENTHESIS + Technical + + + #x08AC + U+239D + BOTTOM LEFT PARENTHESIS + Technical + + + #x08AD + U+239E + TOP RIGHT PARENTHESIS + Technical + + + #x08AE + U+23A0 + BOTTOM RIGHT PARENTHESIS + Technical + + + #x08AF + U+23A8 + LEFT MIDDLE CURLY BRACE + Technical + + + #x08B0 + U+23AC + RIGHT MIDDLE CURLY BRACE + Technical + + + #x08B1 + - + TOP LEFT SUMMATION + Technical + + + #x08B2 + - + BOTTOM LEFT SUMMATION + Technical + + + #x08B3 + - + TOP VERTICAL SUMMATION CONNECTOR + Technical + + + #x08B4 + - + BOTTOM VERTICAL SUMMATION CONNECTOR + Technical + + + #x08B5 + - + TOP RIGHT SUMMATION + Technical + + + #x08B6 + - + BOTTOM RIGHT SUMMATION + Technical + + + #x08B7 + - + RIGHT MIDDLE SUMMATION + Technical + + + #x08BC + U+2264 + LESS THAN OR EQUAL SIGN + Technical + + + #x08BD + U+2260 + NOT EQUAL SIGN + Technical + + + #x08BE + U+2265 + GREATER THAN OR EQUAL SIGN + Technical + + + #x08BF + U+222B + INTEGRAL + Technical + + + #x08C0 + U+2234 + THEREFORE + Technical + + + #x08C1 + U+221D + VARIATION, PROPORTIONAL TO + Technical + + + #x08C2 + U+221E + INFINITY + Technical + + + #x08C5 + U+2207 + NABLA, DEL + Technical + + + #x08C8 + U+223C + IS APPROXIMATE TO + Technical + + + #x08C9 + U+2243 + SIMILAR OR EQUAL TO + Technical + + + #x08CD + U+21D4 + IF AND ONLY IF + Technical + + + #x08CE + U+21D2 + IMPLIES + Technical + + + #x08CF + U+2261 + IDENTICAL TO + Technical + + + #x08D6 + U+221A + RADICAL + Technical + + + #x08DA + U+2282 + IS INCLUDED IN + Technical + + + #x08DB + U+2283 + INCLUDES + Technical + + + #x08DC + U+2229 + INTERSECTION + Technical + + + #x08DD + U+222A + UNION + Technical + + + #x08DE + U+2227 + LOGICAL AND + Technical + + + #x08DF + U+2228 + LOGICAL OR + Technical + + + #x08EF + U+2202 + PARTIAL DERIVATIVE + Technical + + + #x08F6 + U+0192 + FUNCTION + Technical + + + #x08FB + U+2190 + LEFT ARROW + Technical + + + #x08FC + U+2191 + UPWARD ARROW + Technical + + + #x08FD + U+2192 + RIGHT ARROW + Technical + + + #x08FE + U+2193 + DOWNWARD ARROW + Technical + + + #x09DF + - + BLANK + Special + + + #x09E0 + U+25C6 + SOLID DIAMOND + Special + + + #x09E1 + U+2592 + CHECKERBOARD + Special + + + #x09E2 + U+2409 + "HT" + Special + + + #x09E3 + U+240C + "FF" + Special + + + #x09E4 + U+240D + "CR" + Special + + + #x09E5 + U+240A + "LF" + Special + + + #x09E8 + U+2424 + "NL" + Special + + + #x09E9 + U+240B + "VT" + Special + + + #x09EA + U+2518 + LOWER-RIGHT CORNER + Special + + + #x09EB + U+2510 + UPPER-RIGHT CORNER + Special + + + #x09EC + U+250C + UPPER-LEFT CORNER + Special + + + #x09ED + U+2514 + LOWER-LEFT CORNER + Special + + + #x09EE + U+253C + CROSSING-LINES + Special + + + #x09EF + U+23BA + HORIZONTAL LINE, SCAN 1 + Special + + + #x09F0 + U+23BB + HORIZONTAL LINE, SCAN 3 + Special + + + #x09F1 + U+2500 + HORIZONTAL LINE, SCAN 5 + Special + + + #x09F2 + U+23BC + HORIZONTAL LINE, SCAN 7 + Special + + + #x09F3 + U+23BD + HORIZONTAL LINE, SCAN 9 + Special + + + #x09F4 + U+251C + LEFT "T" + Special + + + #x09F5 + U+2524 + RIGHT "T" + Special + + + #x09F6 + U+2534 + BOTTOM "T" + Special + + + #x09F7 + U+252C + TOP "T" + Special + + + #x09F8 + U+2502 + VERTICAL BAR + Special + + + #x0AA1 + U+2003 + EM SPACE + Publish + + + #x0AA2 + U+2002 + EN SPACE + Publish + + + #x0AA3 + U+2004 + 3/EM SPACE + Publish + + + #x0AA4 + U+2005 + 4/EM SPACE + Publish + + + #x0AA5 + U+2007 + DIGIT SPACE + Publish + + + #x0AA6 + U+2008 + PUNCTUATION SPACE + Publish + + + #x0AA7 + U+2009 + THIN SPACE + Publish + + + #x0AA8 + U+200A + HAIR SPACE + Publish + + + #x0AA9 + U+2014 + EM DASH + Publish + + + #x0AAA + U+2013 + EN DASH + Publish + + + #x0AAC + - + SIGNIFICANT BLANK SYMBOL + Publish + + + #x0AAE + U+2026 + ELLIPSIS + Publish + + + #x0AAF + U+2025 + DOUBLE BASELINE DOT + Publish + + + #x0AB0 + U+2153 + VULGAR FRACTION ONE THIRD + Publish + + + #x0AB1 + U+2154 + VULGAR FRACTION TWO THIRDS + Publish + + + #x0AB2 + U+2155 + VULGAR FRACTION ONE FIFTH + Publish + + + #x0AB3 + U+2156 + VULGAR FRACTION TWO FIFTHS + Publish + + + #x0AB4 + U+2157 + VULGAR FRACTION THREE FIFTHS + Publish + + + #x0AB5 + U+2158 + VULGAR FRACTION FOUR FIFTHS + Publish + + + #x0AB6 + U+2159 + VULGAR FRACTION ONE SIXTH + Publish + + + #x0AB7 + U+215A + VULGAR FRACTION FIVE SIXTHS + Publish + + + #x0AB8 + U+2105 + CARE OF + Publish + + + #x0ABB + U+2012 + FIGURE DASH + Publish + + + #x0ABC + - + LEFT ANGLE BRACKET + Publish + + + #x0ABD + - + DECIMAL POINT + Publish + + + #x0ABE + - + RIGHT ANGLE BRACKET + Publish + + + #x0ABF + - + MARKER + Publish + + + #x0AC3 + U+215B + VULGAR FRACTION ONE EIGHTH + Publish + + + #x0AC4 + U+215C + VULGAR FRACTION THREE EIGHTHS + Publish + + + #x0AC5 + U+215D + VULGAR FRACTION FIVE EIGHTHS + Publish + + + #x0AC6 + U+215E + VULGAR FRACTION SEVEN EIGHTHS + Publish + + + #x0AC9 + U+2122 + TRADEMARK SIGN + Publish + + + #x0ACA + - + SIGNATURE MARK + Publish + + + #x0ACB + - + TRADEMARK SIGN IN CIRCLE + Publish + + + #x0ACC + - + LEFT OPEN TRIANGLE + Publish + + + #x0ACD + - + RIGHT OPEN TRIANGLE + Publish + + + #x0ACE + - + EM OPEN CIRCLE + Publish + + + #x0ACF + - + EM OPEN RECTANGLE + Publish + + + #x0AD0 + U+2018 + LEFT SINGLE QUOTATION MARK + Publish + + + #x0AD1 + U+2019 + RIGHT SINGLE QUOTATION MARK + Publish + + + #x0AD2 + U+201C + LEFT DOUBLE QUOTATION MARK + Publish + + + #x0AD3 + U+201D + RIGHT DOUBLE QUOTATION MARK + Publish + + + #x0AD4 + U+211E + PRESCRIPTION, TAKE, RECIPE + Publish + + + #x0AD5 + U+2030 + PER MILLE SIGN + Publish + + + #x0AD6 + U+2032 + MINUTES + Publish + + + #x0AD7 + U+2033 + SECONDS + Publish + + + #x0AD9 + U+271D + LATIN CROSS + Publish + + + #x0ADA + - + HEXAGRAM + Publish + + + #x0ADB + - + FILLED RECTANGLE BULLET + Publish + + + #x0ADC + - + FILLED LEFT TRIANGLE BULLET + Publish + + + #x0ADD + - + FILLED RIGHT TRIANGLE BULLET + Publish + + + #x0ADE + - + EM FILLED CIRCLE + Publish + + + #x0ADF + - + EM FILLED RECTANGLE + Publish + + + #x0AE0 + - + EN OPEN CIRCLE BULLET + Publish + + + #x0AE1 + - + EN OPEN SQUARE BULLET + Publish + + + #x0AE2 + - + OPEN RECTANGULAR BULLET + Publish + + + #x0AE3 + - + OPEN TRIANGULAR BULLET UP + Publish + + + #x0AE4 + - + OPEN TRIANGULAR BULLET DOWN + Publish + + + #x0AE5 + - + OPEN STAR + Publish + + + #x0AE6 + - + EN FILLED CIRCLE BULLET + Publish + + + #x0AE7 + - + EN FILLED SQUARE BULLET + Publish + + + #x0AE8 + - + FILLED TRIANGULAR BULLET UP + Publish + + + #x0AE9 + - + FILLED TRIANGULAR BULLET DOWN + Publish + + + #x0AEA + - + LEFT POINTER + Publish + + + #x0AEB + - + RIGHT POINTER + Publish + + + #x0AEC + U+2663 + CLUB + Publish + + + #x0AED + U+2666 + DIAMOND + Publish + + + #x0AEE + U+2665 + HEART + Publish + + + #x0AF0 + U+2720 + MALTESE CROSS + Publish + + + #x0AF1 + U+2020 + DAGGER + Publish + + + #x0AF2 + U+2021 + DOUBLE DAGGER + Publish + + + #x0AF3 + U+2713 + CHECK MARK, TICK + Publish + + + #x0AF4 + U+2717 + BALLOT CROSS + Publish + + + #x0AF5 + U+266F + MUSICAL SHARP + Publish + + + #x0AF6 + U+266D + MUSICAL FLAT + Publish + + + #x0AF7 + U+2642 + MALE SYMBOL + Publish + + + #x0AF8 + U+2640 + FEMALE SYMBOL + Publish + + + #x0AF9 + U+260E + TELEPHONE SYMBOL + Publish + + + #x0AFA + U+2315 + TELEPHONE RECORDER SYMBOL + Publish + + + #x0AFB + U+2117 + PHONOGRAPH COPYRIGHT SIGN + Publish + + + #x0AFC + U+2038 + CARET + Publish + + + #x0AFD + U+201A + SINGLE LOW QUOTATION MARK + Publish + + + #x0AFE + U+201E + DOUBLE LOW QUOTATION MARK + Publish + + + #x0AFF + - + CURSOR + Publish + + + #x0BA3 + - + LEFT CARET + APL + + + #x0BA6 + - + RIGHT CARET + APL + + + #x0BA8 + - + DOWN CARET + APL + + + #x0BA9 + - + UP CARET + APL + + + #x0BC0 + - + OVERBAR + APL + + + #x0BC2 + U+22A5 + DOWN TACK + APL + + + #x0BC3 + - + UP SHOE (CAP) + APL + + + #x0BC4 + U+230A + DOWN STILE + APL + + + #x0BC6 + - + UNDERBAR + APL + + + #x0BCA + U+2218 + JOT + APL + + + #x0BCC + U+2395 + QUAD + APL + + + #x0BCE + U+22A4 + UP TACK + APL + + + #x0BCF + U+25CB + CIRCLE + APL + + + #x0BD3 + U+2308 + UP STILE + APL + + + #x0BD6 + - + DOWN SHOE (CUP) + APL + + + #x0BD8 + - + RIGHT SHOE + APL + + + #x0BDA + - + LEFT SHOE + APL + + + #x0BDC + U+22A2 + LEFT TACK + APL + + + #x0BFC + U+22A3 + RIGHT TACK + APL + + + #x0CDF + U+2017 + DOUBLE LOW LINE + Hebrew + + + #x0CE0 + U+05D0 + HEBREW LETTER ALEF + Hebrew + + + #x0CE1 + U+05D1 + HEBREW LETTER BET + Hebrew + + + #x0CE2 + U+05D2 + HEBREW LETTER GIMEL + Hebrew + + + #x0CE3 + U+05D3 + HEBREW LETTER DALET + Hebrew + + + #x0CE4 + U+05D4 + HEBREW LETTER HE + Hebrew + + + #x0CE5 + U+05D5 + HEBREW LETTER VAV + Hebrew + + + #x0CE6 + U+05D6 + HEBREW LETTER ZAYIN + Hebrew + + + #x0CE7 + U+05D7 + HEBREW LETTER HET + Hebrew + + + #x0CE8 + U+05D8 + HEBREW LETTER TET + Hebrew + + + #x0CE9 + U+05D9 + HEBREW LETTER YOD + Hebrew + + + #x0CEA + U+05DA + HEBREW LETTER FINAL KAF + Hebrew + + + #x0CEB + U+05DB + HEBREW LETTER KAF + Hebrew + + + #x0CEC + U+05DC + HEBREW LETTER LAMED + Hebrew + + + #x0CED + U+05DD + HEBREW LETTER FINAL MEM + Hebrew + + + #x0CEE + U+05DE + HEBREW LETTER MEM + Hebrew + + + #x0CEF + U+05DF + HEBREW LETTER FINAL NUN + Hebrew + + + #x0CF0 + U+05E0 + HEBREW LETTER NUN + Hebrew + + + #x0CF1 + U+05E1 + HEBREW LETTER SAMEKH + Hebrew + + + #x0CF2 + U+05E2 + HEBREW LETTER AYIN + Hebrew + + + #x0CF3 + U+05E3 + HEBREW LETTER FINAL PE + Hebrew + + + #x0CF4 + U+05E4 + HEBREW LETTER PE + Hebrew + + + #x0CF5 + U+05E5 + HEBREW LETTER FINAL TSADI + Hebrew + + + #x0CF6 + U+05E6 + HEBREW LETTER TSADI + Hebrew + + + #x0CF7 + U+05E7 + HEBREW LETTER QOF + Hebrew + + + #x0CF8 + U+05E8 + HEBREW LETTER RESH + Hebrew + + + #x0CF9 + U+05E9 + HEBREW LETTER SHIN + Hebrew + + + #x0CFA + U+05EA + HEBREW LETTER TAV + Hebrew + + + #x0DA1 + U+0E01 + THAI CHARACTER KO KAI + Thai + + + #x0DA2 + U+0E02 + THAI CHARACTER KHO KHAI + Thai + + + #x0DA3 + U+0E03 + THAI CHARACTER KHO KHUAT + Thai + + + #x0DA4 + U+0E04 + THAI CHARACTER KHO KHWAI + Thai + + + #x0DA5 + U+0E05 + THAI CHARACTER KHO KHON + Thai + + + #x0DA6 + U+0E06 + THAI CHARACTER KHO RAKHANG + Thai + + + #x0DA7 + U+0E07 + THAI CHARACTER NGO NGU + Thai + + + #x0DA8 + U+0E08 + THAI CHARACTER CHO CHAN + Thai + + + #x0DA9 + U+0E09 + THAI CHARACTER CHO CHING + Thai + + + #x0DAA + U+0E0A + THAI CHARACTER CHO CHANG + Thai + + + #x0DAB + U+0E0B + THAI CHARACTER SO SO + Thai + + + #x0DAC + U+0E0C + THAI CHARACTER CHO CHOE + Thai + + + #x0DAD + U+0E0D + THAI CHARACTER YO YING + Thai + + + #x0DAE + U+0E0E + THAI CHARACTER DO CHADA + Thai + + + #x0DAF + U+0E0F + THAI CHARACTER TO PATAK + Thai + + + #x0DB0 + U+0E10 + THAI CHARACTER THO THAN + Thai + + + #x0DB1 + U+0E11 + THAI CHARACTER THO NANGMONTHO + Thai + + + #x0DB2 + U+0E12 + THAI CHARACTER THO PHUTHAO + Thai + + + #x0DB3 + U+0E13 + THAI CHARACTER NO NEN + Thai + + + #x0DB4 + U+0E14 + THAI CHARACTER DO DEK + Thai + + + #x0DB5 + U+0E15 + THAI CHARACTER TO TAO + Thai + + + #x0DB6 + U+0E16 + THAI CHARACTER THO THUNG + Thai + + + #x0DB7 + U+0E17 + THAI CHARACTER THO THAHAN + Thai + + + #x0DB8 + U+0E18 + THAI CHARACTER THO THONG + Thai + + + #x0DB9 + U+0E19 + THAI CHARACTER NO NU + Thai + + + #x0DBA + U+0E1A + THAI CHARACTER BO BAIMAI + Thai + + + #x0DBB + U+0E1B + THAI CHARACTER PO PLA + Thai + + + #x0DBC + U+0E1C + THAI CHARACTER PHO PHUNG + Thai + + + #x0DBD + U+0E1D + THAI CHARACTER FO FA + Thai + + + #x0DBE + U+0E1E + THAI CHARACTER PHO PHAN + Thai + + + #x0DBF + U+0E1F + THAI CHARACTER FO FAN + Thai + + + #x0DC0 + U+0E20 + THAI CHARACTER PHO SAMPHAO + Thai + + + #x0DC1 + U+0E21 + THAI CHARACTER MO MA + Thai + + + #x0DC2 + U+0E22 + THAI CHARACTER YO YAK + Thai + + + #x0DC3 + U+0E23 + THAI CHARACTER RO RUA + Thai + + + #x0DC4 + U+0E24 + THAI CHARACTER RU + Thai + + + #x0DC5 + U+0E25 + THAI CHARACTER LO LING + Thai + + + #x0DC6 + U+0E26 + THAI CHARACTER LU + Thai + + + #x0DC7 + U+0E27 + THAI CHARACTER WO WAEN + Thai + + + #x0DC8 + U+0E28 + THAI CHARACTER SO SALA + Thai + + + #x0DC9 + U+0E29 + THAI CHARACTER SO RUSI + Thai + + + #x0DCA + U+0E2A + THAI CHARACTER SO SUA + Thai + + + #x0DCB + U+0E2B + THAI CHARACTER HO HIP + Thai + + + #x0DCC + U+0E2C + THAI CHARACTER LO CHULA + Thai + + + #x0DCD + U+0E2D + THAI CHARACTER O ANG + Thai + + + #x0DCE + U+0E2E + THAI CHARACTER HO NOKHUK + Thai + + + #x0DCF + U+0E2F + THAI CHARACTER PAIYANNOI + Thai + + + #x0DD0 + U+0E30 + THAI CHARACTER SARA A + Thai + + + #x0DD1 + U+0E31 + THAI CHARACTER MAI HAN-AKAT + Thai + + + #x0DD2 + U+0E32 + THAI CHARACTER SARA AA + Thai + + + #x0DD3 + U+0E33 + THAI CHARACTER SARA AM + Thai + + + #x0DD4 + U+0E34 + THAI CHARACTER SARA I + Thai + + + #x0DD5 + U+0E35 + THAI CHARACTER SARA II + Thai + + + #x0DD6 + U+0E36 + THAI CHARACTER SARA UE + Thai + + + #x0DD7 + U+0E37 + THAI CHARACTER SARA UEE + Thai + + + #x0DD8 + U+0E38 + THAI CHARACTER SARA U + Thai + + + #x0DD9 + U+0E39 + THAI CHARACTER SARA UU + Thai + + + #x0DDA + U+0E3A + THAI CHARACTER PHINTHU + Thai + + + #x0DDF + U+0E3F + THAI CURRENCY SYMBOL BAHT + Thai + + + #x0DE0 + U+0E40 + THAI CHARACTER SARA E + Thai + + + #x0DE1 + U+0E41 + THAI CHARACTER SARA AE + Thai + + + #x0DE2 + U+0E42 + THAI CHARACTER SARA O + Thai + + + #x0DE3 + U+0E43 + THAI CHARACTER SARA AI MAIMUAN + Thai + + + #x0DE4 + U+0E44 + THAI CHARACTER SARA AI MAIMALAI + Thai + + + #x0DE5 + U+0E45 + THAI CHARACTER LAKKHANGYAO + Thai + + + #x0DE6 + U+0E46 + THAI CHARACTER MAIYAMOK + Thai + + + #x0DE7 + U+0E47 + THAI CHARACTER MAITAIKHU + Thai + + + #x0DE8 + U+0E48 + THAI CHARACTER MAI EK + Thai + + + #x0DE9 + U+0E49 + THAI CHARACTER MAI THO + Thai + + + #x0DEA + U+0E4A + THAI CHARACTER MAI TRI + Thai + + + #x0DEB + U+0E4B + THAI CHARACTER MAI CHATTAWA + Thai + + + #x0DEC + U+0E4C + THAI CHARACTER THANTHAKHAT + Thai + + + #x0DED + U+0E4D + THAI CHARACTER NIKHAHIT + Thai + + + #x0DF0 + U+0E50 + THAI DIGIT ZERO + Thai + + + #x0DF1 + U+0E51 + THAI DIGIT ONE + Thai + + + #x0DF2 + U+0E52 + THAI DIGIT TWO + Thai + + + #x0DF3 + U+0E53 + THAI DIGIT THREE + Thai + + + #x0DF4 + U+0E54 + THAI DIGIT FOUR + Thai + + + #x0DF5 + U+0E55 + THAI DIGIT FIVE + Thai + + + #x0DF6 + U+0E56 + THAI DIGIT SIX + Thai + + + #x0DF7 + U+0E57 + THAI DIGIT SEVEN + Thai + + + #x0DF8 + U+0E58 + THAI DIGIT EIGHT + Thai + + + #x0DF9 + U+0E59 + THAI DIGIT NINE + Thai + + + #x0EA1 + - + HANGUL KIYEOG + Korean + + + #x0EA2 + - + HANGUL SSANG KIYEOG + Korean + + + #x0EA3 + - + HANGUL KIYEOG SIOS + Korean + + + #x0EA4 + - + HANGUL NIEUN + Korean + + + #x0EA5 + - + HANGUL NIEUN JIEUJ + Korean + + + #x0EA6 + - + HANGUL NIEUN HIEUH + Korean + + + #x0EA7 + - + HANGUL DIKEUD + Korean + + + #x0EA8 + - + HANGUL SSANG DIKEUD + Korean + + + #x0EA9 + - + HANGUL RIEUL + Korean + + + #x0EAA + - + HANGUL RIEUL KIYEOG + Korean + + + #x0EAB + - + HANGUL RIEUL MIEUM + Korean + + + #x0EAC + - + HANGUL RIEUL PIEUB + Korean + + + #x0EAD + - + HANGUL RIEUL SIOS + Korean + + + #x0EAE + - + HANGUL RIEUL TIEUT + Korean + + + #x0EAF + - + HANGUL RIEUL PHIEUF + Korean + + + #x0EB0 + - + HANGUL RIEUL HIEUH + Korean + + + #x0EB1 + - + HANGUL MIEUM + Korean + + + #x0EB2 + - + HANGUL PIEUB + Korean + + + #x0EB3 + - + HANGUL SSANG PIEUB + Korean + + + #x0EB4 + - + HANGUL PIEUB SIOS + Korean + + + #x0EB5 + - + HANGUL SIOS + Korean + + + #x0EB6 + - + HANGUL SSANG SIOS + Korean + + + #x0EB7 + - + HANGUL IEUNG + Korean + + + #x0EB8 + - + HANGUL JIEUJ + Korean + + + #x0EB9 + - + HANGUL SSANG JIEUJ + Korean + + + #x0EBA + - + HANGUL CIEUC + Korean + + + #x0EBB + - + HANGUL KHIEUQ + Korean + + + #x0EBC + - + HANGUL TIEUT + Korean + + + #x0EBD + - + HANGUL PHIEUF + Korean + + + #x0EBE + - + HANGUL HIEUH + Korean + + + #x0EBF + - + HANGUL A + Korean + + + #x0EC0 + - + HANGUL AE + Korean + + + #x0EC1 + - + HANGUL YA + Korean + + + #x0EC2 + - + HANGUL YAE + Korean + + + #x0EC3 + - + HANGUL EO + Korean + + + #x0EC4 + - + HANGUL E + Korean + + + #x0EC5 + - + HANGUL YEO + Korean + + + #x0EC6 + - + HANGUL YE + Korean + + + #x0EC7 + - + HANGUL O + Korean + + + #x0EC8 + - + HANGUL WA + Korean + + + #x0EC9 + - + HANGUL WAE + Korean + + + #x0ECA + - + HANGUL OE + Korean + + + #x0ECB + - + HANGUL YO + Korean + + + #x0ECC + - + HANGUL U + Korean + + + #x0ECD + - + HANGUL WEO + Korean + + + #x0ECE + - + HANGUL WE + Korean + + + #x0ECF + - + HANGUL WI + Korean + + + #x0ED0 + - + HANGUL YU + Korean + + + #x0ED1 + - + HANGUL EU + Korean + + + #x0ED2 + - + HANGUL YI + Korean + + + #x0ED3 + - + HANGUL I + Korean + + + #x0ED4 + - + HANGUL JONG SEONG KIYEOG + Korean + + + #x0ED5 + - + HANGUL JONG SEONG SSANG KIYEOG + Korean + + + #x0ED6 + - + HANGUL JONG SEONG KIYEOG SIOS + Korean + + + #x0ED7 + - + HANGUL JONG SEONG NIEUN + Korean + + + #x0ED8 + - + HANGUL JONG SEONG NIEUN JIEUJ + Korean + + + #x0ED9 + - + HANGUL JONG SEONG NIEUN HIEUH + Korean + + + #x0EDA + - + HANGUL JONG SEONG DIKEUD + Korean + + + #x0EDB + - + HANGUL JONG SEONG RIEUL + Korean + + + #x0EDC + - + HANGUL JONG SEONG RIEUL KIYEOG + Korean + + + #x0EDD + - + HANGUL JONG SEONG RIEUL MIEUM + Korean + + + #x0EDE + - + HANGUL JONG SEONG RIEUL PIEUB + Korean + + + #x0EDF + - + HANGUL JONG SEONG RIEUL SIOS + Korean + + + #x0EE0 + - + HANGUL JONG SEONG RIEUL TIEUT + Korean + + + #x0EE1 + - + HANGUL JONG SEONG RIEUL PHIEUF + Korean + + + #x0EE2 + - + HANGUL JONG SEONG RIEUL HIEUH + Korean + + + #x0EE3 + - + HANGUL JONG SEONG MIEUM + Korean + + + #x0EE4 + - + HANGUL JONG SEONG PIEUB + Korean + + + #x0EE5 + - + HANGUL JONG SEONG PIEUB SIOS + Korean + + + #x0EE6 + - + HANGUL JONG SEONG SIOS + Korean + + + #x0EE7 + - + HANGUL JONG SEONG SSANG SIOS + Korean + + + #x0EE8 + - + HANGUL JONG SEONG IEUNG + Korean + + + #x0EE9 + - + HANGUL JONG SEONG JIEUJ + Korean + + + #x0EEA + - + HANGUL JONG SEONG CIEUC + Korean + + + #x0EEB + - + HANGUL JONG SEONG KHIEUQ + Korean + + + #x0EEC + - + HANGUL JONG SEONG TIEUT + Korean + + + #x0EED + - + HANGUL JONG SEONG PHIEUF + Korean + + + #x0EEE + - + HANGUL JONG SEONG HIEUH + Korean + + + #x0EEF + - + HANGUL RIEUL YEORIN HIEUH + Korean + + + #x0EF0 + - + HANGUL SUNKYEONGEUM MIEUM + Korean + + + #x0EF1 + - + HANGUL SUNKYEONGEUM PIEUB + Korean + + + #x0EF2 + - + HANGUL PAN SIOS + Korean + + + #x0EF3 + - + HANGUL KKOGJI DALRIN IEUNG + Korean + + + #x0EF4 + - + HANGUL SUNKYEONGEUM PHIEUF + Korean + + + #x0EF5 + - + HANGUL YEORIN HIEUH + Korean + + + #x0EF6 + - + HANGUL ARAE A + Korean + + + #x0EF7 + - + HANGUL ARAE AE + Korean + + + #x0EF8 + - + HANGUL JONG SEONG PAN SIOS + Korean + + + #x0EF9 + - + HANGUL JONG SEONG KKOGJI DALRIN IEUNG + Korean + + + #x0EFA + - + HANGUL JONG SEONG YEORIN HIEUH + Korean + + + #x0EFF + - + KOREAN WON + Korean + + + #x13BC + U+0152 + LATIN CAPITAL LIGATURE OE + Latin-9 + + + #x13BD + U+0153 + LATIN SMALL LIGATURE OE + Latin-9 + + + #x13BE + U+0178 + LATIN CAPITAL LETTER Y WITH DIAERESIS + Latin-9 + + + #x20A0 + - + CURRENCY ECU SIGN + Currency + + + #x20A1 + - + CURRENCY COLON SIGN + Currency + + + #x20A2 + - + CURRENCY CRUZEIRO SIGN + Currency + + + #x20A3 + - + CURRENCY FRENCH FRANC SIGN + Currency + + + #x20A4 + - + CURRENCY LIRA SIGN + Currency + + + #x20A5 + - + CURRENCY MILL SIGN + Currency + + + #x20A6 + - + CURRENCY NAIRA SIGN + Currency + + + #x20A7 + - + CURRENCY PESETA SIGN + Currency + + + #x20A8 + - + CURRENCY RUPEE SIGN + Currency + + + #x20A9 + - + CURRENCY WON SIGN + Currency + + + #x20AA + - + CURRENCY NEW SHEQEL SIGN + Currency + + + #x20AB + - + CURRENCY DONG SIGN + Currency + + + #x20AC + U+20AC + CURRENCY EURO SIGN + Currency + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/xproto/sect1-9.xml b/miniconda3/envs/ladir/share/doc/xproto/sect1-9.xml new file mode 100644 index 0000000000000000000000000000000000000000..c59def1f85fad481b20735efa71699ac93587bf4 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xproto/sect1-9.xml @@ -0,0 +1,15309 @@ + + +Acknowledgements + +The primary contributors to the X11 protocol are: + + + +Dave Carver (Digital HPW) +Branko Gerovac (Digital HPW) +Jim Gettys (MIT/Project Athena, Digital) +Phil Karlton (Digital WSL) +Scott McGregor (Digital SSG) +Ram Rao (Digital UEG) +David Rosenthal (Sun) +Dave Winchell (Digital UEG) + + + +The implementors of initial server who provided useful +input are: + + + +Susan Angebranndt (Digital) +Raymond Drewry (Digital) +Todd Newman (Digital) + + + +The invited reviewers who provided useful input are: + + + +Andrew Cherenson (Berkeley) +Burns Fisher (Digital) +Dan Garfinkel (HP) +Leo Hourvitz (Next) +Brock Krizan (HP) +David Laidlaw (Stellar) +Dave Mellinger (Interleaf) +Ron Newman (MIT) +John Ousterhout (Berkeley) +Andrew Palay (ITC CMU) +Ralph Swick (MIT) +Craig Taylor (Sun) +Jeffery Vroom (Stellar) + + + +Thanks go to Al Mento of Digital's UEG Documentation Group for +formatting this document. + + + +This document does not attempt to provide the rationale or pragmatics required +to fully understand the protocol or to place it in perspective within a +complete system. + + + +The protocol contains many management mechanisms that are not intended for +normal applications. +Not all mechanisms are needed to build a particular user interface. +It is important to keep in mind that the protocol is intended to +provide mechanism, not policy. + + + +Robert W. Scheifler + + +X Consortium, Inc. + + + + + Protocol Formats + +
+ Request Format + Requestformat + +Every request contains an 8-bit major opcode +Opcodemajor +and a 16-bit length field +Requestlength +expressed in units of four bytes. +Every request consists of four bytes of a header +(containing the major opcode, the length field, and a data byte) +followed by zero or more additional bytes of data. +The length field defines the total length of the request, including the header. +The length field in a request must equal the minimum length required to contain +the request. +If the specified length is smaller or larger than the required length, +an error is generated. +Unused bytes in a request are not required to be zero. +Major opcodes 128 through 255 are reserved for +extensions. +Extension +Extensions are intended to contain multiple requests, +so extension requests typically have an additional +minor opcode encoded +in the second data byte in the request header. +Opcodeminor +However, the placement and interpretation of this minor opcode and of all +other fields in extension requests are not defined by the core protocol. +Every request on a given connection is implicitly assigned a +sequence number, +Sequence number +starting with one, that is used in replies, errors, and events. + +
+ +
+ Reply Format + Replyformat + +Every reply contains a 32-bit length field +expressed in units of four bytes. +Every reply consists of 32 bytes followed by zero or more additional bytes of +data, as specified in the length field. +Unused bytes within a reply are not guaranteed to be zero. +Every reply also contains the least significant 16 bits of the sequence number +of the corresponding request. + +
+ +
+ Error Format + Error reportformat + +Error reports are 32 bytes long. +Every error includes an 8-bit error code. + +Error codes 128 through 255 are reserved for extensions. + +Error Codesextensions +Extensionerror codes +Every error also includes the major and minor opcodes of the failed request +and the least significant 16 bits of the sequence number of the request. +For the following errors (see section 4), +the failing resource ID is also returned: +Colormap, +Cursor, +Drawable, +Font, +GContext, +IDChoice, +Pixmap +and +Window. +For +Atom +errors, the failing atom is returned. +For +Value +errors, the failing value is returned. +Other core errors return no additional data. +Unused bytes within an error are not guaranteed to be zero. + +
+ +
+ Event Format + Eventformat + +Events are 32 bytes long. +Unused bytes within an event are not guaranteed to be zero. +Every event contains an 8-bit type code. +The most significant bit in this code is set if the event was generated from a +SendEvent +request. + +Event codes 64 through 127 are reserved for extensions, although the core +protocol does not define a mechanism for selecting interest in such events. + +Eventextension +Extensionevent +Every core event (with the exception of +KeymapNotify) +also contains the least significant 16 bits of the sequence number of the last +request issued by the client that was (or is currently being) processed by +the server. + +
+ + + +Syntactic Conventions + + + + + +The rest of this document uses the following syntactic conventions. + + + + +The syntax {...} encloses a set of alternatives. + + + + +The syntax [...] encloses a set of structure components. + + + + +In general, TYPEs are in uppercase and +AlternativeValues +are capitalized. + + + + +Requests in section 9 are described +in the following format: + +RequestName + arg1: type1 + ... + argN: typeN + ▶ + result1: type1 + ... + resultM: typeM + + Errors: kind1, ..., kindK + + Description. + + + +If no ▶ is present in the description, +then the request has no reply (it is asynchronous), +although errors may still be reported. +If ▶+ is used, +then one or more replies can be generated for a single request. + + + + +Events in section 11 are described +in the following format: + +EventName + value1: type1 + ... + valueN: typeN + + Description. + + + + + + + +Common Types + + + + + + + + + + Name + Value + + + + + LISTofFOOTypesLISTofFOO + + +A type name of the form LISTofFOO means a counted list of elements of type +FOO. +The size of the length field may vary (it is not necessarily the same +size as a FOO), and in some cases, it may be implicit. +It is fully specified in Appendix B. +Except where explicitly noted, +zero-length lists are legal. + + + + BITMASKTypesBITMASKLISTofVALUETypesLISTofVALUE + + +The types BITMASK and LISTofVALUE are somewhat special. +Various requests contain arguments of the form: + + +value-mask: BITMASK + + +value-list: LISTofVALUE + + +These are used to allow the client to specify a subset of a heterogeneous +collection of optional arguments. +The value-mask specifies which arguments are to be provided; +each such argument is assigned a unique bit position. +The representation of the BITMASK will typically contain more bits than +there are defined arguments. +The unused bits in the value-mask must be zero (or the server generates a +Value +error). +The value-list contains one value for each bit set to 1 in the mask, +from least significant to most significant bit in the mask. +Each value is represented with four bytes, +but the actual value occupies only the least significant bytes as required. +The values of the unused bytes do not matter. + + + + + ORTypesOR + +A type of the form "T1 or ... or Tn" means the union of the indicated types. +A single-element type is given as the element without enclosing braces. + + + + WINDOWTypesWINDOW + 32-bit value (top three bits guaranteed to be zero) + + + PIXMAPTypesPIXMAP + 32-bit value (top three bits guaranteed to be zero) + + + CURSORTypesCURSOR + 32-bit value (top three bits guaranteed to be zero) + + + FONTTypesFONT + 32-bit value (top three bits guaranteed to be zero) + + + GCONTEXTTypesGCONTEXT + 32-bit value (top three bits guaranteed to be zero) + + + COLORMAPTypesCOLORMAP + 32-bit value (top three bits guaranteed to be zero) + + + DRAWABLETypesDRAWABLE + WINDOW or PIXMAP + + + FONTABLETypesFONTABLE + FONT or GCONTEXT + + + ATOMTypesATOM + 32-bit value (top three bits guaranteed to be zero) + + + VISUALIDTypesVISUALID + 32-bit value (top three bits guaranteed to be zero) + + + VALUETypesVALUE + 32-bit quantity (used only in LISTofVALUE) + + + BYTETypesBYTE + 8-bit value + + + INT8TypesINT8 + 8-bit signed integer + + + INT16TypesINT16 + 16-bit signed integer + + + INT32TypesINT32 + 32-bit signed integer + + + CARD8TypesCARD8 + 8-bit unsigned integer + + + CARD16TypesCARD16 + 16-bit unsigned integer + + + CARD32TypesCARD32 + 32-bit unsigned integer + + + TIMESTAMPTypesTIMESTAMP + CARD32 + + + BITGRAVITYTypesBITGRAVITY + +{ Forget, +Static, +NorthWest, +North, +NorthEast, +West, +Center, +East, +SouthWest, +South, +SouthEast } + + + + WINGRAVITYTypesWINGRAVITY + +{ Unmap, +Static, +NorthWest, +North, +NorthEast, +West, +Center, +East, +SouthWest, +South, +SouthEast } + + + + BOOLTypesBOOL + +{ True, +False } + + + + EVENTTypesEVENT + +{ KeyPress, +KeyRelease, +OwnerGrabButton, +ButtonPress, +ButtonRelease, +EnterWindow, +LeaveWindow, +PointerMotion, +PointerMotionHint, +Button1Motion, +Button2Motion, +Button3Motion, +Button4Motion, +Button5Motion, +ButtonMotion, +Exposure, +VisibilityChange, +StructureNotify, +ResizeRedirect, +SubstructureNotify, +SubstructureRedirect, +FocusChange, +PropertyChange, +ColormapChange, +KeymapState } + + + + POINTEREVENTTypesPOINTEREVENT + +{ ButtonPress, +ButtonRelease, +EnterWindow, +LeaveWindow, +PointerMotion, +PointerMotionHint, +Button1Motion, +Button2Motion, +Button3Motion, +Button4Motion, +Button5Motion, +ButtonMotion, +KeymapState } + + + + DEVICEEVENTTypesDEVICEEVENT + +{ KeyPress, +KeyRelease, +ButtonPress, +ButtonRelease, +PointerMotion, +Button1Motion, +Button2Motion, +Button3Motion, +Button4Motion, +Button5Motion, +ButtonMotion } + + + + KEYSYMTypesKEYSYM + 32-bit value (top three bits guaranteed to be zero) + + + KEYCODETypesKEYCODE + CARD8 + + + BUTTONTypesBUTTON + CARD8 + + + KEYMASKTypesKEYMASK + +{ Shift, +Lock, +Control, +Mod1, +Mod2, +Mod3, +Mod4, +Mod5 } + + + + BUTMASKTypesBUTMASK + +{ Button1, +Button2, +Button3, +Button4, +Button5 } + + + + KEYBUTMASKTypesKEYBUTMASK + KEYMASK or BUTMASK + + + STRING8TypesSTRING8 + LISTofCARD8 + + + STRING16TypesSTRING16 + LISTofCHAR2B + + + CHAR2BTypesCHAR2B + [byte1, byte2: CARD8] + + + POINTTypesPOINT + [x, y: INT16] + + + RECTANGLETypesRECTANGLE + +[x, y: INT16, +width, height: CARD16] + + + + ARCTypesARC + +[x, y: INT16, +width, height: CARD16, +angle1, angle2: INT16] + + + + HOSTTypesHOST + + +[family: +{ Internet, +InternetV6, +ServerInterpreted, +DECnet, +Chaos } + +address: LISTofBYTE] + + + + + + + +The [x,y] coordinates of a RECTANGLE specify the upper-left corner. + + + +The primary interpretation of large characters in a STRING16 is that they +are composed of two bytes used to index a two-dimensional matrix, +hence, the use of CHAR2B rather than CARD16. +This corresponds to the JIS/ISO method of indexing 2-byte characters. +It is expected that most large fonts will be defined with 2-byte +matrix indexing. +For large fonts constructed with linear indexing, +a CHAR2B can be interpreted as a 16-bit number by treating byte1 as +the most significant byte. +This means that clients should always transmit such +16-bit character values most significant byte first, as the server will never +byte-swap CHAR2B quantities. + + + +The length, format, and interpretation of a HOST address are specific to the +family (see +ChangeHosts +request). + + + + +Errors + + + + + +In general, when a request terminates with an error, +the request has no side effects (that is, there is no partial execution). +The only requests for which this is not true are +ChangeWindowAttributes, +ChangeGC, +PolyText8, +PolyText16, +FreeColors, +StoreColors +and +ChangeKeyboardControl. + + + +The following error codes result from various requests as follows: + + + + + + + + + Error + Description + + + + + AccessError CodesAccess + +An attempt is made to grab a key/button combination already grabbed by another +client. +An attempt is made to free a colormap entry not allocated by the client +or to free an entry in a colormap that was created with all entries writable. +An attempt is made to store into a read-only or an unallocated colormap entry. +An attempt is made to modify the access control list from other than the local +host (or otherwise authorized client). +An attempt is made to select an event type that only one client can +select at a time when another client has already selected it. + + + + AllocError CodesAlloc + +The server failed to allocate the requested resource. +Note that the explicit listing of +Alloc +errors in request only covers allocation errors at a very coarse level +and is not intended to cover all cases +of a server running out of allocation space in the middle of service. +The semantics when a server runs out of allocation space are left unspecified, +but a server may generate an +Alloc +error on any request for this reason, +and clients should be prepared to receive such errors and handle +or discard them. + + + + AtomError CodesAtom + +A value for an ATOM argument does not name a defined ATOM. + + + + ColormapError CodesColormap + +A value for a COLORMAP argument does not name a defined COLORMAP. + + + + CursorError CodesCursor + +A value for a CURSOR argument does not name a defined CURSOR. + + + + DrawableError CodesDrawable + +A value for a DRAWABLE argument does not name a defined WINDOW +or PIXMAP. + + + + FontError CodesFont + +A value for a FONT argument does not name a defined FONT. +A value for a FONTABLE argument does not name a defined FONT or a +defined GCONTEXT. + + + + GContextError CodesGContext + +A value for a GCONTEXT argument does not name a defined GCONTEXT. + + + + IDChoiceError CodesIDChoice + +The value chosen for a resource identifier either is not included +in the range assigned to the client or is already in use. + + + + ImplementationError CodesImplementation + +The server does not implement some aspect of the request. +A server that generates this error for a core request is deficient. +As such, this error is not listed for any of the requests, +but clients should be prepared to receive such errors +and handle or discard them. + + + + LengthError CodesLength + +The length of a request is shorter or longer than that required +to minimally contain the arguments. +The length of a request exceeds the maximum length accepted by the +server. + + + + MatchError CodesMatch + +An +InputOnly +window is used as a DRAWABLE. +In a graphics request, the GCONTEXT argument does not have the same +root and depth as the destination DRAWABLE argument. +Some argument (or pair of arguments) has the correct type and range, +but it fails to match in some other way required by the request. + + + + NameError CodesName + +A font or color of the specified name does not exist. + + + + PixmapError CodesPixmap + +A value for a PIXMAP argument does not name a defined PIXMAP. + + + + RequestError CodesRequest + +The major or minor opcode does not specify a valid request. + + + + ValueError CodesValue + +Some numeric value falls outside the range of values accepted by the request. +Unless a specific range is specified for an argument, +the full range defined by the argument's type is accepted. +Any argument defined as a set of alternatives typically can generate +this error (due to the encoding). + + + + WindowError CodesWindow + +A value for a WINDOW argument does not name a defined WINDOW. + + + + + + + +The +Atom, +Colormap, +Cursor, +Drawable, +Font, +GContext, +Pixmap +and +Window +errors are also used when the argument type is extended by union with a +set of fixed alternatives, for example, <WINDOW or +PointerRoot +or +None>. + + + + +Keyboards +Keyboard + + + + +A KEYCODE represents a physical (or logical) key. +TypesKEYCODE +Keycode +Keycodes lie in the inclusive range [8,255]. +A keycode value carries no intrinsic information, +although server implementors may attempt to encode geometry information +(for example, matrix) to be interpreted in a server-dependent fashion. +The mapping between keys and keycodes cannot be changed using the +protocol. + + +A KEYSYM is an encoding of a symbol on the cap of a key. +TypesKEYSYM +Keysym +The set of defined KEYSYMs include the character sets Latin-1, Latin-2, +Latin-3, Latin-4, Kana, Arabic, Cyrillic, Greek, Tech, Special, Publish, APL, +Hebrew, Thai, and Korean as well as a set of symbols common on keyboards +(Return, Help, Tab, +and so on). +KEYSYMs with the most significant bit (of the 29 bits) set are reserved +as vendor-specific. + + +A list of KEYSYMs is associated with each KEYCODE. +The list is intended to convey the set of symbols on the corresponding key. +If the list (ignoring trailing +NoSymbol +entries) is a single KEYSYM "K", +then the list is treated as if it were +the list "K NoSymbol +K NoSymbol". +If the list (ignoring trailing NoSymbol entries) +is a pair of KEYSYMs +"K1 K2", then the list is treated as +if it were the list +"K1 K2 K1 K2". +If the list (ignoring trailing +NoSymbol +entries) is +a triple of KEYSYMs "K1 K2 K3", +then the list is treated as if it were the list " +K1 K2 K3 NoSymbol". +When an explicit "void" element is desired in the list, +the value +VoidSymbol +can be used. + + + +The first four elements of the list are split into two groups of KEYSYMs. +Group 1 contains the first and second KEYSYMs, Group 2 contains the third and +fourth KEYSYMs. +Within each group, +if the second element of the group is +NoSymbol, +then the group should be treated as if the second element were the +same as the first element, except when the first element is an alphabetic +KEYSYM "K" for which both lowercase +and uppercase forms are defined. +In that case, the group should be treated as if the first element were the +lowercase form of "K" and the second +element were the uppercase form +of "K". + + + +The standard rules for obtaining a KEYSYM from a +KeyPress +KeyPress +event make use of only the Group 1 and Group 2 KEYSYMs; no interpretation of +other KEYSYMs in the list is defined. The modifier state determines which +group to use. Switching between groups is controlled by the KEYSYM named +MODE SWITCH, by attaching that KEYSYM to some KEYCODE and attaching that +KEYCODE to any one of the modifiers +Mod1 +through +Mod5. +This modifier is +modifiergroup +called the "group modifier". For any KEYCODE, Group 1 is used when the +group modifier is off, and Group 2 is used when the group modifier is on. + + + +The +Lock +modifierLock +modifier is interpreted as CapsLock when the KEYSYM named CAPS +LOCK is attached to some KEYCODE and that KEYCODE is attached to the +Lock +modifier. The +Lock +modifier is interpreted as ShiftLock when the KEYSYM +named SHIFT LOCK is attached to some KEYCODE and that KEYCODE is attached +to the +Lock +modifier. If the +Lock +modifier could be interpreted as both +CapsLock and ShiftLock, the CapsLock interpretation is used. + + + + +The operation of "keypad" keys is controlled by the KEYSYM named NUM LOCK, +by attaching that KEYSYM to some KEYCODE and attaching that KEYCODE to any +one of the modifiers +Mod1 +through +Mod5. +This modifier is called the +modifierNumLock +"numlock modifier". The standard KEYSYMs with the prefix KEYPAD in their +name are called "keypad" KEYSYMs; these are KEYSYMS with numeric value in +the hexadecimal range #xFF80 to #xFFBD inclusive. In addition, +vendor-specific KEYSYMS in the hexadecimal range #x11000000 to #x1100FFFF +are also keypad KEYSYMs. + + + +Within a group, the choice of KEYSYM is determined by applying the first +rule that is satisfied from the following list: + + + + + +The numlock modifier is on and the second KEYSYM is a keypad KEYSYM. In +this case, if the +Shift +modifier is on, or if the +Lock +modifier is on and +is interpreted as ShiftLock, then the first KEYSYM is used; otherwise, the +second KEYSYM is used. + + + + +The +Shift +and +Lock +modifiers are both off. In this case, the first +KEYSYM is used. + + + + +The +Shift +modifier is off, and the +Lock +modifier is on and is +interpreted as CapsLock. In this case, the first KEYSYM is used, but if +that KEYSYM is lowercase alphabetic, then the corresponding uppercase +KEYSYM is used instead. + + + + +The +Shift +modifier is on, and the +Lock +modifier is on and is interpreted +as CapsLock. In this case, the second KEYSYM is used, but if that KEYSYM +is lowercase alphabetic, then the corresponding uppercase KEYSYM is used +instead. + + + + +The +Shift +modifier is on, or the +Lock +modifier is on and is interpreted +as ShiftLock, or both. In this case, the second KEYSYM is used. + + + + + + +The mapping between KEYCODEs and KEYSYMs is not used directly by the server; +it is merely stored for reading and writing by clients. + + + + +Pointers + + + + +Buttons are always numbered starting with one. +Buttonnumber + + + + +Predefined Atoms + + + + + +Atompredefined +Predefined atoms are not strictly necessary and may not be useful in all +environments, but they will eliminate many +InternAtom +requests in most applications. +Note that they are predefined only in the sense of having numeric values, +not in the sense of having required semantics. +The core protocol imposes no semantics on these names, +but semantics are specified in other X Window System standards, +such as the +Inter-Client Communication Conventions Manual +and the X Logical Font Description Conventions. + + + +The following names have predefined atom values. +Note that uppercase and lowercase matter. + + + + ARC + ATOM + BITMAP + CAP_HEIGHT + CARDINAL + COLORMAP + COPYRIGHT + CURSOR + CUT_BUFFER0 + CUT_BUFFER1 + CUT_BUFFER2 + CUT_BUFFER3 + CUT_BUFFER4 + CUT_BUFFER5 + CUT_BUFFER6 + CUT_BUFFER7 + DRAWABLE + END_SPACE + FAMILY_NAME + FONT + FONT_NAME + FULL_NAME + INTEGER + ITALIC_ANGLE + MAX_SPACE + MIN_SPACE + NORM_SPACE + NOTICE + PIXMAP + POINT + POINT_SIZE + PRIMARY + QUAD_WIDTH + RECTANGLE + RESOLUTION + RESOURCE_MANAGER + RGB_BEST_MAP + RGB_BLUE_MAP + RGB_COLOR_MAP + RGB_DEFAULT_MAP + RGB_GRAY_MAP + RGB_GREEN_MAP + RGB_RED_MAP + SECONDARY + STRIKEOUT_ASCENT + STRIKEOUT_DESCENT + STRING + SUBSCRIPT_X + SUBSCRIPT_Y + SUPERSCRIPT_X + SUPERSCRIPT_Y + UNDERLINE_POSITION + UNDERLINE_THICKNESS + VISUALID + WEIGHT + WINDOW + WM_CLASS + WM_CLIENT_MACHINE + WM_COMMAND + WM_HINTS + WM_ICON_NAME + WM_ICON_SIZE + WM_NAME + WM_NORMAL_HINTS + WM_SIZE_HINTS + WM_TRANSIENT_FOR + WM_ZOOM_HINTS + X_HEIGHT + + + + +To avoid conflicts with possible future names for which semantics might be +imposed (either at the protocol level or in terms of higher level user +interface models), +names beginning with an underscore should be used for atoms +that are private to a particular vendor or organization. +To guarantee no conflicts between vendors and organizations, +additional prefixes need to be used. +However, the protocol does not define the mechanism for choosing such prefixes. +For names private to a single application or end user but stored in globally +accessible locations, +it is suggested that two leading underscores be used to avoid conflicts with +other names. + + + + + Connection Setup + Connection + + +For remote clients, +the X protocol can be built on top of any reliable byte stream. + + +
+ Connection Initiation + Connectionopening + + +The client must send an initial byte of data to identify the byte order to be +employed. +Byte order +The value of the byte must be octal 102 or 154. +The value 102 (ASCII uppercase B) means values are transmitted most significant +byte first, and value 154 (ASCII lowercase l) means values are transmitted +least significant byte first. +Except where explicitly noted in the protocol, +all 16-bit and 32-bit quantities sent by the client must be transmitted with +this byte order, +and all 16-bit and 32-bit quantities returned by the server will be transmitted +with this byte order. + + +Following the byte-order byte, +the client sends the following information at connection setup: + +
+ +protocol-major-version: CARD16 + + +protocol-minor-version: CARD16 + + +authorization-protocol-name: STRING8 + + +authorization-protocol-data: STRING8 + +
+ +The version numbers indicate what version of the protocol the client +expects the server to implement. + + +The authorization name indicates what authorization (and authentication) +protocol the client +expects the server to use, and the data is specific to that protocol. +Authorization +Specification of valid authorization mechanisms is not part of the core +X protocol. +A server that does not implement the protocol the client expects +or that only implements the host-based mechanism may simply ignore this +information. +If both name and data strings are empty, +this is to be interpreted as "no explicit authorization." + +
+ +
+ Server Response + + +The client receives the following information at connection setup: + + + + + +success: +{ Failed, +Success, +Authenticate} + + + + + +The client receives the following additional data if the returned success +value is +Failed, +and the connection is not successfully established: + + +
+ +protocol-major-version: CARD16 + + +protocol-minor-version: CARD16 + + +reason: STRING8 + +
+ + +The client receives the following additional data if the returned success +value is +Authenticate, +and further authentication negotiation is required: + + +
+ +reason: STRING8 + +
+ + +The contents of the reason string are specific to the authorization +protocol in use. The semantics of this authentication negotiation are +not constrained, except that the negotiation must eventually terminate +with a reply from the server containing a success value of +Failed +or +Success. + + + +The client receives the following additional data if the returned success +value is +Success, +and the connection is successfully established: + + +
+ +protocol-major-version: CARD16 + + + +protocol-minor-version: CARD16 + + + +vendor: STRING8 + + + +release-number: CARD32 + + + +resource-id-base, resource-id-mask: CARD32 + + + +image-byte-order: +{ LSBFirst, +MSBFirst } + + + +bitmap-scanline-unit: {8, 16, 32} + + + +bitmap-scanline-pad: {8, 16, 32} + + + +bitmap-bit-order: +{ LeastSignificant, +MostSignificant } + + + +pixmap-formats: LISTofFORMAT + + + +roots: LISTofSCREEN + + + +motion-buffer-size: CARD32 + + + +maximum-request-length: CARD16 + + + +min-keycode, max-keycode: KEYCODE + + +where: + +
+ + + + + + + FORMAT: + [depth: CARD8, + + + + +bits-per-pixel: {1, 4, 8, 16, 24, 32} + + + + + +scanline-pad: {8, 16, 32}] + + + + SCREEN: + [root: WINDOW + + + + width-in-pixels, height-in-pixels: CARD16 + + + + width-in-millimeters, height-in-millimeters: CARD16 + + + + allowed-depths: LISTofDEPTH + + + + root-depth: CARD8 + + + + root-visual: VISUALID + + + + default-colormap: COLORMAP + + + + white-pixel, black-pixel: CARD32 + + + + min-installed-maps, max-installed-maps: CARD16 + + + + backing-stores: {Never, WhenMapped, Always} + + + + save-unders: BOOL + + + + current-input-masks: SETofEVENT] + + + DEPTH: + [depth: CARD8 + + + + visuals: LISTofVISUALTYPE] + + + VISUALTYPE: + [visual-id: VISUALID + + + + +class: {StaticGray, StaticColor, TrueColor, GrayScale, +PseudoColor, DirectColor} + + + + + red-mask, green-mask, blue-mask: CARD32 + + + + bits-per-rgb-value: CARD8 + + + + colormap-entries: CARD16] + + + + +
+
+
+ +
+ Server Information + + +The information that is global to the server is: + + + +The protocol version numbers are an escape hatch in case future revisions of +the protocol are necessary. +In general, +the major version would increment for incompatible changes, +and the minor version would increment for small upward compatible changes. +Barring changes, +the major version will be 11, and the minor version will be 0. +The protocol version numbers returned indicate the protocol the server +actually supports. +This might not equal the version sent by the client. +The server can (but need not) refuse connections from clients that offer a +different version than the server supports. +A server can (but need not) support more than one version simultaneously. + + +The vendor string gives some identification of the owner of the server +implementation. +The vendor controls the semantics of the release number. + + +The resource-id-mask contains a single contiguous set of bits (at least 18). +The client allocates resource IDs for types WINDOW, PIXMAP, +CURSOR, FONT, GCONTEXT, and COLORMAP by choosing a value with only +some subset of these bits set and ORing it with resource-id-base. +ResourceID +Only values constructed in this way can be used to name newly created +resources over this connection. +Resource IDs never have the top three bits set. +The client is not restricted to linear or contiguous allocation +of resource IDs. +Once an ID has been freed, +it can be reused. +An ID must be unique with respect to the IDs of all other resources, +not just other resources of the same type. +However, note that the value spaces of resource identifiers, +atoms, visualids, and keysyms are distinguished by context, and +as such, are not required to be disjoint; for example, a given numeric value +might be both a valid window ID, a valid atom, and a valid keysym. + + +Although the server is in general responsible for byte-swapping data to +match the client, +images are always transmitted and received in formats (including byte order) +specified by the server. +The byte order for images is given by image-byte-order and applies to each +scanline unit in XY format (bitmap format) and to each pixel value in Z format. + + +A bitmap is represented in scanline order. +Bitmapformat +Each scanline +is padded to a multiple of bits as given by bitmap-scanline-pad. +The pad bits are of arbitrary value. +The scanline is quantized in multiples of bits as given by bitmap-scanline-unit. +The bitmap-scanline-unit is always less than or equal to the +bitmap-scanline-pad. +Within each unit, +the leftmost bit in the bitmap is either the least significant +or most significant bit in the unit, as given by bitmap-bit-order. +XYFormat +If a pixmap is represented in XY format, +each plane is represented as a bitmap, and the planes appear from +most significant to least significant in bit order with no padding +between planes. + + +Pixmap-formats contains one entry for each +depth value. +Pixmapformat +ZFormat +The entry describes the Z format +used to represent images of that depth. +An entry for a depth is included if any screen supports that depth, +and all screens supporting that depth must support only that Z format for that +depth. +In Z format, +the pixels are in scanline order, left to right within a scanline. +The number of bits used to hold each pixel is given by bits-per-pixel. +Bits-per-pixel may be larger than strictly required by the depth, +in which case the least significant bits are used to hold +the pixmap data, and the values of the unused high-order bits are +undefined. +When the bits-per-pixel is 4, +the order of nibbles in the byte is the same as the image byte-order. +When the bits-per-pixel is 1, +the format is identical for bitmap format. +Each scanline is padded to a multiple of bits as given by scanline-pad. +When bits-per-pixel is 1, +this will be identical to bitmap-scanline-pad. + + +How a pointing device roams the screens is up to the server +implementation and is transparent to the protocol. +No geometry is defined among screens. + + +The server may retain the recent history of pointer motion and do so to a +finer granularity than is reported by +MotionNotify +events. +The +GetMotionEvents +request makes such history available. +The motion-buffer-size gives the approximate maximum number +of elements in the history buffer. + + +Maximum-request-length specifies the maximum length of a request +accepted by the server, in 4-byte units. +Requestlength +That is, length is the maximum value that can appear in the length field of a +request. +Requests larger than this maximum generate a +Length +error, +and the server will read and simply discard the entire request. +Maximum-request-length will always be at least 4096 +(that is, requests of length up to and including 16384 bytes +will be accepted by all servers). + + +TypesKEYCODE +Keycode +Min-keycode and max-keycode specify the smallest and largest keycode +values transmitted by the server. +Min-keycode is never less than 8, +and max-keycode is never greater than 255. +Not all keycodes in this range are required to have corresponding keys. + +
+ +
+ Screen Information + Screen + + +The information that applies per screen is: + + + +The allowed-depths specifies what pixmap and window depths are supported. +Pixmaps are supported for each depth listed, +and windows of that depth are supported if at least one visual type is listed +for the depth. +A pixmap depth of one is always supported and listed, +but windows of depth one might not be supported. +A depth of zero is never listed, +but zero-depth +InputOnly +windows are always supported. + + +Root-depth and root-visual specify the depth and visual type of the +root window. +Width-in-pixels and height-in-pixels specify the size of +the root window (which cannot be changed). +The class of the root window is always +InputOutput. +Width-in-millimeters and height-in-millimeters can be used to determine the +physical size and the aspect ratio. + + +The default-colormap is the one initially associated with the root window. +Clients with minimal color requirements creating windows of +the same depth as the root may want to allocate from this map by +default. + + +Black-pixel and white-pixel can be used in implementing a monochrome +application. +These pixel values are for permanently allocated entries in the +default-colormap. +The actual RGB values may be settable on some screens +and, in any case, may not actually be black and white. +The names are intended to convey the expected relative intensity of the colors. + + +The border of the root window is initially a pixmap filled with the black-pixel. +The initial background of the root window is a pixmap filled with some +unspecified two-color pattern using black-pixel and white-pixel. + + +Min-installed-maps specifies the number of maps that can be guaranteed +to be installed simultaneously (with +InstallColormap), +regardless of the number of entries allocated in each map. +Max-installed-maps specifies the maximum number of maps that might possibly be +installed simultaneously, depending on their allocations. +Multiple static-visual colormaps with identical contents but differing in +resource ID should be considered as a single map for the purposes of this +number. +For the typical case of a single hardware colormap, both values will be 1. + + +Backing store +Backing-stores indicates when the server supports backing stores for +this screen, although it may be storage limited in the number of +windows it can support at once. +If save-unders is +True, +the server can support the save-under mode in +CreateWindow +and +ChangeWindowAttributes, +although again it may be storage limited. + + +The current-input-events is what +GetWindowAttributes +would return for the all-event-masks for the root window. + +
+ +
+ Visual Information + Visualinformation + + +The information that applies per visual-type is: + + + +A given visual type might be listed for more than one depth or for +more than one screen. + + + +Colormaptypes +Pixel value +For +PseudoColor, +a pixel value indexes a colormap to produce independent RGB values; +the RGB values can be changed dynamically. +GrayScale +is treated in the same way as +PseudoColor +except which primary drives the screen is undefined; +thus, the client should always store the +same value for red, green, and blue in colormaps. +For +DirectColor, +a pixel value is decomposed into separate RGB subfields, +and each subfield separately indexes the colormap for the corresponding value. +The RGB values can be changed dynamically. +TrueColor +is treated in the same way as +DirectColor +except the colormap has predefined read-only RGB values. +These values are server-dependent but provide linear or near-linear +increasing ramps in each primary. +StaticColor +is treated in the same way as +PseudoColor +except the colormap has predefined read-only RGB values, +which are server-dependent. +StaticGray +is treated in the same way as +StaticColor +except the red, green, and blue values are equal for any +single pixel value, resulting in shades of gray. +StaticGray +with a two-entry colormap can be thought of as monochrome. + + + +The red-mask, green-mask, and blue-mask are only defined for +DirectColor +and +TrueColor. +Each has one contiguous set of bits set to 1 with no intersections. +Usually each mask has the same number of bits set to 1. + + + +The bits-per-rgb-value specifies the log base 2 of the number of +distinct color intensity values (individually) of red, green, and blue. +This number need not bear any relation to the number of colormap entries. +Actual RGB values are always passed in the protocol within a +16-bit spectrum, with 0 being minimum intensity and 65535 being the +maximum intensity. +On hardware that provides a linear zero-based intensity ramp, +the following relationship exists: + + + + + hw-intensity = protocol-intensity / (65536 / total-hw-intensities) + + + + +Colormap entries are indexed from 0. +The colormap-entries defines the number of available colormap entries in a +newly created colormap. +For +DirectColor +and +TrueColor, +this will usually be 2 to the power of the maximum number of bits set to 1 in +red-mask, green-mask, and blue-mask. + +
+ + + + Requests +
+ CreateWindow + CreateWindow + + + + + + + + +wid, parent: WINDOW + + + + +class: +{ InputOutput, +InputOnly, +CopyFromParent} + + + + +depth: CARD8 + + + + +visual: VISUALID or +CopyFromParent + + + + +x, y: INT16 + + + + +width, height, border-width: CARD16 + + + + +value-mask: BITMASK + + + + +value-list: LISTofVALUE + + + + + + +Errors: +Alloc, +Colormap, +Cursor, +IDChoice, +Match, +Pixmap, +Value, +Window + + + + + + + + + +This request creates an unmapped window and assigns the identifier wid to it. + + +A class of +CopyFromParent +means the class is taken from the parent. +A depth of zero for class +InputOutput +or +CopyFromParent +means the depth is taken from the parent. +A visual of +CopyFromParent +means the visual type is taken from the parent. +For class +InputOutput, +the visual type and depth must be a combination supported for the screen +(or a +Match +error results). +The depth need not be the same as the parent, +but the parent must not be of class +InputOnly +(or a +Match +error results). +For class +InputOnly, +the depth must be zero (or a +Match +error results), and the visual must be one supported for the screen (or a +Match +error results). +However, the parent can have any depth and class. + + +The server essentially acts as if +InputOnly +windows do not exist for the purposes of graphics requests, +exposure processing, and +VisibilityNotify +events. +An +InputOnly +window cannot be used as a drawable (as a source or destination for graphics +requests). +InputOnly +and +InputOutput +windows act identically in other respects-properties, +grabs, input control, and so on. + + +The coordinate system has the X axis horizontal and the Y axis vertical +with the origin [0, 0] at the upper-left corner. +Coordinates are integral, +in terms of pixels, +and coincide with pixel centers. +Each window and pixmap has its own coordinate system. +For a window, +the origin is inside the border at the inside, upper-left corner. + + +The x and y coordinates +for the window are relative to the parent's origin +and specify the position of the upper-left outer corner of the window +(not the origin). +The width and height specify the inside size (not including the border) +and must be nonzero (or a +Value +error results). +The border-width for an +InputOnly +window must be zero (or a +Match +error results). + + +The window is placed on top in the stacking order with respect to siblings. + + +The value-mask and value-list specify attributes of the window that are +to be explicitly initialized. +The possible values are: + + + + + + + + Attribute + Type + + + + + background-pixmap + +PIXMAP or +None +or +ParentRelative + + + + background-pixel + CARD32 + + + border-pixmap + +PIXMAP or +CopyFromParent + + + + border-pixel + CARD32 + + + bit-gravity + BITGRAVITY + + + win-gravity + WINGRAVITY + + + backing-store + +{ NotUseful, +WhenMapped, +Always } + + + + backing-planes + CARD32 + + + backing-pixel + CARD32 + + + save-under + BOOL + + + event-mask + SETofEVENT + + + do-not-propagate-mask + SETofDEVICEEVENT + + + override-redirect + BOOL + + + colormap + +COLORMAP or +CopyFromParent + + + + cursor + +CURSOR or +None + + + + + + + +The default values when attributes are not explicitly initialized +are: + + + + + + + + + Attribute + Default + + + + + background-pixmap + +None + + + + border-pixmap + +CopyFromParent + + + + bit-gravity + +Forget + + + + win-gravity + +NorthWest + + + + backing-store + +NotUseful + + + + backing-planes + all ones + + + backing-pixel + zero + + + save-under + +False + + + + event-mask + {} (empty set) + + + do-not-propagate-mask + {} (empty set) + + + override-redirect + +False + + + + colormap + +CopyFromParent + + + + cursor + +None + + + + + + + +Only the following attributes are defined for +InputOnly +windows: + + + + + +win-gravity + + + + +event-mask + + + + +do-not-propagate-mask + + + + +override-redirect + + + + +cursor + + + + + +It is a +Match +error to specify any other attributes for +InputOnly +windows. + + +Background +If background-pixmap is given, +it overrides the default background-pixmap. +The background pixmap and the window must have the +same root and the same depth (or a +Match +error results). +Any size pixmap can be used, although some sizes may be faster than others. +If background +None +is specified, the window has no defined background. +If background +ParentRelative +is specified, the parent's background is used, +but the window must have the same depth as the parent (or a +Match +error results). +If the parent has background +None, +then the window will also have background +None. +A copy of the parent's background is not made. +The parent's background is reexamined each time the window background is +required. +If background-pixel is given, it overrides the default +background-pixmap and any background-pixmap given explicitly, +and a pixmap of undefined size filled with background-pixel is used for the +background. +Range checking is not performed on the background-pixel value; +it is simply truncated to the appropriate number of bits. +For a +ParentRelative +background, +the background tile origin always aligns with the parent's background tile +origin. +Otherwise, the background tile origin is always the window origin. + + +When no valid contents are available for regions of a window +and the regions are either visible or the server is maintaining backing store, +the server automatically tiles the regions with the window's background +unless the window has a background of +None. +If the background is +None, +the previous screen contents from other windows of the same depth as the window +are simply left in place if the contents come from the parent of the window +or an inferior of the parent; +otherwise, the initial contents of the exposed regions are undefined. +Exposure events are then generated for the regions, even if the background is +None. + + +The border tile origin is always the same as the background tile origin. +If border-pixmap is given, +it overrides the default border-pixmap. +The border pixmap and the window must have the same root +and the same depth (or a +Match +error results). +Any size pixmap can be used, +although some sizes may be faster than others. +If +CopyFromParent +is given, the parent's border pixmap is copied (subsequent changes to +the parent's border attribute do not affect the child), +but the window must have the same depth as the parent (or a +Match +error results). +The pixmap might be copied by sharing the same pixmap object between the +child and parent or by making a complete copy of the pixmap contents. +If border-pixel is given, +it overrides the default border-pixmap and any border-pixmap given explicitly, +and a pixmap of undefined size filled with border-pixel is used for the border. +Range checking is not performed on the border-pixel value; +it is simply truncated to the appropriate number of bits. + + +Output to a window is always clipped to the inside of the window, +so that the border is never affected. + + +The bit-gravity defines which region of the window should be retained +if the window is resized, and win-gravity defines how the window should +be repositioned if the parent is resized (see +ConfigureWindow +request). + + +A backing-store of +WhenMapped +advises the server that maintaining contents of obscured regions +when the window is mapped would be beneficial. +A backing-store of +Always +advises the server that maintaining contents even when the window is +unmapped would be beneficial. +In this case, +the server may generate an exposure event when the window is created. +A value of +NotUseful +advises the server that maintaining contents is unnecessary, +although a server may still choose to maintain contents while the window +is mapped. +Note that if the server maintains contents, +then the server should maintain complete contents +not just the region within the parent boundaries, +even if the window is larger than its parent. +While the server maintains contents, +exposure events will not normally be generated, +but the server may stop maintaining contents at any time. + + +If save-under is +True, +the server is advised that when this window is +mapped, saving the contents of windows it obscures would be beneficial. + + +When the contents of obscured regions of a window are being maintained, +regions obscured by noninferior windows are included in the +destination (and source, when the window is the source) of graphics +requests, but regions obscured by inferior windows are not included. + + +The backing-planes indicates (with bits set to 1) which bit planes +of the window hold dynamic data that must be preserved in backing-stores +and during save-unders. +The backing-pixel specifies what value to use in planes not +covered by backing-planes. +The server is free to save only the specified bit planes in the backing-store +or save-under and regenerate the remaining planes with the specified pixel +value. +Any bits beyond the specified depth of the window in these +values are simply ignored. + + +Eventmask +Eventpropagation +The event-mask defines which events the client is interested in for +this window (or for some event types, inferiors of the window). +The do-not-propagate-mask defines which events should not be propagated to +ancestor windows when no client has the event type selected in this +window. + + +The override-redirect specifies whether map and configure requests on this +window should override a +SubstructureRedirect +on the parent, typically to inform a window manager not to tamper with +the window. + + +The colormap specifies the colormap that best reflects the true +colors of the window. +Servers capable of supporting multiple hardware colormaps may use this +information, and window managers may use it for +InstallColormap +requests. +The colormap must have the same visual type and root as the window (or a +Match +error results). +If +CopyFromParent +is specified, +the parent's colormap is copied (subsequent changes to the parent's +colormap attribute do not affect the child). +However, the window must have the same visual type as the parent (or a +Match +error results), and the parent must not have a colormap of +None +(or a +Match +error results). +For an explanation of +None, +see FreeColormap +request. +The colormap is copied by sharing the colormap object between the child +and the parent, +not by making a complete copy of the colormap contents. + + +If a cursor is specified, +it will be used whenever the pointer is in the window. +If +None +is specified, +the parent's cursor will be used when the pointer is in the window, +and any change in the parent's cursor will cause an immediate change +in the displayed cursor. + + +This request generates a +CreateNotify +event. + + +The background and border pixmaps and the cursor may be freed +immediately if no further explicit references to them are to be made. + + +Subsequent drawing into the background or border pixmap has an +undefined effect on the window state. +The server might or might not make a copy of the pixmap. + + +
+
+ ChangeWindowAttributes + ChangeWindowAttributes + + + + + + + + +window: WINDOW + + + + +value-mask: BITMASK + + + + +value-list: LISTofVALUE + + + + + + +Errors: +Access, +Colormap, +Cursor, +Match, +Pixmap, +Value, +Window + + + + + + + + + +The value-mask and value-list specify which attributes are to be changed. +The values and restrictions are the same as for +CreateWindow. + + +Setting a new background, whether by background-pixmap or +background-pixel, overrides any previous background. +Setting a new border, whether by border-pixel or border-pixmap, +overrides any previous border. + + +Changing the background does not cause the window contents to be changed. +Setting the border or changing the background such that the +border tile origin changes causes the border to be repainted. +Changing the background of a root window to +None +or +ParentRelative +restores the default background pixmap. +Changing the border of a root window to +CopyFromParent +restores the default border pixmap. + + +Changing the win-gravity does not affect the current position of the +window. + + +Changing the backing-store of an obscured window to +WhenMapped +or +Always +or changing the backing-planes, backing-pixel, or save-under of +a mapped window may have no immediate effect. + + +Multiple clients can select input on the same window; +their event-masks are disjoint. +When an event is generated, +it will be reported to all interested clients. +However, only one client at a time can select for +SubstructureRedirect, +only one client at a time can select for +ResizeRedirect, +and only one client at a time can select for +ButtonPress. +An attempt to violate these restrictions results in an +Access +error. + + +There is only one do-not-propagate-mask for a window, not one per +client. + + +Changing the colormap of a window (by defining a new map, not by +changing the contents of the existing map) generates a +ColormapNotify +event. +Changing the colormap of a visible window might have no immediate effect +on the screen (see +InstallColormap +request). + + +Changing the cursor of a root window to +None +restores the default cursor. + + +The order in which attributes are verified and altered is server-dependent. +If an error is generated, +a subset of the attributes may have been altered. + + +
+
+ GetWindowAttributes + GetWindowAttributes + + + + + + + + +window: WINDOW + + + + + + ▶ + + + + + +visual: VISUALID + + + + +class: +{ InputOutput, +InputOnly} + + + + +bit-gravity: BITGRAVITY + + + + +win-gravity: WINGRAVITY + + + + +backing-store: +{ NotUseful, +WhenMapped, +Always} + + + + +backing-planes: CARD32 + + + + +backing-pixel: CARD32 + + + + +save-under: BOOL + + + + +colormap: COLORMAP or +None + + + + +map-is-installed: BOOL + + + + +map-state: +{ Unmapped, +Unviewable, +Viewable} + + + + +all-event-masks, your-event-mask: SETofEVENT + + + + +do-not-propagate-mask: SETofDEVICEEVENT + + + + +override-redirect: BOOL + + + + + + +Errors: +Window + + + + + + + + + +This request returns the current attributes of the window. +A window is +Unviewable +if it is mapped but some ancestor is unmapped. +All-event-masks is the inclusive-OR of all event masks selected on the window +by clients. +Your-event-mask is the event mask selected by the querying client. + + +
+
+ DestroyWindow + DestroyWindow + + + + + + + + +window: WINDOW + + + + + + +Errors: +Window + + + + + + + + + +If the argument window is mapped, +an +UnmapWindow +request is performed automatically. +The window and all inferiors are then destroyed, and a +DestroyNotify +event is generated for each window. +The ordering of the +DestroyNotify +events is such that for any given window, +DestroyNotify +is generated on all inferiors of the window before being generated on +the window itself. +The ordering among siblings and across subhierarchies is not otherwise +constrained. + + +Normal exposure processing on formerly obscured windows is performed. + + +If the window is a root window, +this request has no effect. + + +
+
+ DestroySubwindows + DestroySubwindows + + + + + + + + +window: WINDOW + + + + + + +Errors: +Window + + + + + + + + + +This request performs a +DestroyWindow +request on all children of the window, in bottom-to-top stacking order. + + +
+
+ ChangeSaveSet + ChangeSaveSet + + + + + + + + +window: WINDOW + + + + +mode: +{ Insert, +Delete} + + + + + +Errors: + +Match, +Value, +Window + + + + + + + + + +This request adds or removes the specified window from the client's +save-set. +The window must have been created by some other client (or a +Match +error results). +For further information about the use of the save-set, +see section 10. + + +When windows are destroyed, +the server automatically removes them from the save-set. + + +
+
+ ReparentWindow + ReparentWindow + + + + + + + + +window, parent: WINDOW + + + + +x, y: INT16 + + + + + + +Errors: +Match, +Window + + + + + + + + + +If the window is mapped, +an +UnmapWindow +request is performed automatically first. +The window is then removed from its current position in the hierarchy +and is inserted as a child of the specified parent. +The x and y coordinates are relative to the parent's origin +and specify the new position of the upper-left outer corner of the +window. +The window is placed on top in the stacking order with respect +to siblings. +A +ReparentNotify +event is then generated. +The override-redirect attribute of the window is passed on in this event; +a value of +True +indicates that a window manager should not tamper with this window. +Finally, if the window was originally mapped, a +MapWindow +request is performed automatically. + + +Normal exposure processing on formerly obscured windows is performed. +The server might not generate exposure events for regions from the +initial unmap that are immediately obscured by the final map. + + +A +Match +error is generated if: + +The new parent is not on the same screen as the old parent. + +The new parent is the window itself or an inferior of the window. + +The new parent is +InputOnly, +and the window is not. + +The window has a +ParentRelative +background, and the new parent is not the same depth as the window. + + +
+
+ MapWindow + MapWindow + Mapped window + + + + + + + + +window: WINDOW + + + + + + +Errors: +Window + + + + + + + + + +If the window is already mapped, this request has no effect. + + +If the override-redirect attribute of the window is +False +and some other client has selected +SubstructureRedirect +on the parent, then a +MapRequest +event is generated, but the window remains unmapped. +Otherwise, the window is mapped, +and a +MapNotify +event is generated. + + +If the window is now viewable and its contents have been discarded, +the window is tiled with its background (if no background is defined, +the existing screen contents are not altered), and zero or more exposure +events are generated. +If a backing-store has been maintained while the window was unmapped, +no exposure events are generated. +If a backing-store will now be maintained, +a full-window exposure is always generated. +Otherwise, only visible regions may be reported. +Similar tiling and exposure take place for any newly viewable inferiors. + + +
+
+ MapSubwindows + MapSubwindows + + + + + + + + +window: WINDOW + + + + + + +Errors: +Window + + + + + + + + + +This request performs a +MapWindow +request on all unmapped children of the window, +in top-to-bottom stacking order. + + +
+
+ UnmapWindow + UnmapWindow + + + + + + + + +window: WINDOW + + + + + + +Errors: +Window + + + + + + + + + +If the window is already unmapped, this request has no effect. +Otherwise, the window is unmapped, and an +UnmapNotify +event is generated. +Normal exposure processing on formerly obscured windows is performed. + + +
+
+ UnmapSubwindows + UnmapSubwindows + + + + + + + + +window: WINDOW + + + + + + +Errors: +Window + + + + + + + + + +This request performs an +UnmapWindow +request on all mapped children of the window, +in bottom-to-top stacking order. + + +
+
+ ConfigureWindow + ConfigureWindow + + + + + + + + +window: WINDOW + + + + +value-mask: BITMASK + + + + +value-list: LISTofVALUE + + + + + + +Errors: +Match, +Value, +Window + + + + + + + + + +This request changes the configuration of the window. +The value-mask and value-list specify which values are to be given. +The possible values are: + + + + + + + + + + Attribute + Type + + + + + x + INT16 + + + y + INT16 + + + width + CARD16 + + + height + CARD16 + + + border-width + CARD16 + + + sibling + WINDOW + + + stack-mode + +{ Above, +Below, +TopIf, +BottomIf, +Opposite } + + + + + + + +The x and y coordinates are relative to the parent's origin +and specify the position of the upper-left outer corner of the window. +The width and height specify the inside size, not including the border, and +must be nonzero (or a +Value +error results). +Those values not specified are taken from the existing geometry of the window. +Note that changing just the border-width leaves the outer-left corner +of the window in a fixed position but moves the absolute position of the +window's origin. +It is a +Match +error to attempt to make the border-width of an +InputOnly +window nonzero. + + +If the override-redirect attribute of the window is +False +and some other client has selected +SubstructureRedirect +on the parent, a +ConfigureRequest +event is generated, and no further processing is performed. +Otherwise, the following is performed: + + +If some other client has selected +ResizeRedirect +on the window and the inside width or height of the window is being changed, +a +ResizeRequest +event is generated, +and the current inside width and height are used instead. +Note that the override-redirect attribute of the window has no effect on +ResizeRedirect +and that +SubstructureRedirect +on the parent has precedence over +ResizeRedirect +on the window. + + +Gravity +Bitgravity +Windowgravity +The geometry of the window is changed as specified, +the window is restacked among siblings, and a +ConfigureNotify +event is generated if the state of the window actually changes. +If the inside width or height of the window has actually changed, +then children of the window are affected, +according to their win-gravity. +Exposure processing is performed on formerly obscured windows +(including the window itself and its inferiors if regions of them were +obscured but now are not). +Exposure processing is also performed on any new regions of the window +(as a result of increasing the width or height) +and on any regions where window contents are lost. + + +If the inside width or height of a window is not changed +but the window is moved or its border is changed, +then the contents of the window are not lost but move with the window. +Changing the inside width or height of the window causes its contents to be +moved or lost, depending on the bit-gravity of the window. +It also causes children to be reconfigured, depending on their win-gravity. +For a change of width and height of W and H, +we define the [x, y] pairs as: + + + + + + + + + + Direction + Deltas + + + + + +NorthWest + + [0, 0] + + + +North + + [W/2, 0] + + + +NorthEast + + [W, 0] + + + +West + + [0, H/2] + + + +Center + + [W/2, H/2] + + + +East + + [W, H/2] + + + +SouthWest + + [0, H] + + + +South + + [W/2, H] + + + +SouthEast + + [W, H] + + + + + + +When a window with one of these bit-gravities is resized, +the corresponding pair defines the change in position of each pixel in the +window. +When a window with one of these win-gravities has its parent window resized, +the corresponding pair defines the change in position +of the window within the parent. +This repositioning generates a +GravityNotify +event. +GravityNotify +events are generated after the +ConfigureNotify +event is generated. + + +A gravity of +Static +indicates that the contents or origin should not move relative to the origin +of the root window. +If the change in size of the window is coupled with a change +in position of [X, Y], +then for bit-gravity the change in position of each pixel is [-X, -Y] and for +win-gravity the change in position of a child when its parent is so +resized is [-X, -Y]. +Note that +Static +gravity still only takes effect when the width or height of the +window is changed, not when the window is simply moved. + + +A bit-gravity of +Forget +indicates that the window contents are always discarded after a size change, +even if backing-store or save-under has been requested. +The window is tiled with its background (except, if no background is defined, +the existing screen contents are not altered) +and zero or more exposure events are generated. + + +The contents and borders of inferiors are not affected by their parent's +bit-gravity. +A server is permitted to ignore the specified bit-gravity and use +Forget +instead. + + +A win-gravity of +Unmap +is like +NorthWest, +but the child is also unmapped when the parent is resized, +and an +UnmapNotify +event is generated. +UnmapNotify +events are generated after the +ConfigureNotify +event is generated. + + +If a sibling and a stack-mode are specified, +the window is restacked as follows: + + + + + + + + + + +Above + + +The window is placed just above the sibling. + + + + +Below + + +The window is placed just below the sibling. + + + + +TopIf + + +If the sibling occludes the window, +then the window is placed at the top of the stack. + + + + +BottomIf + + +If the window occludes the sibling, +then the window is placed at the bottom of the stack. + + + + +Opposite + + +If the sibling occludes the window, +then the window is placed at the top of the stack. +Otherwise, if the window occludes the sibling, +then the window is placed at the bottom of the stack. + + + + + + + +If a stack-mode is specified but no sibling is specified, +the window is restacked as follows: + + + + + + + + + + +Above + + +The window is placed at the top of the stack. + + + + +Below + + +The window is placed at the bottom of the stack. + + + + +TopIf + + +If any sibling occludes the window, +then the window is placed at the top of the stack. + + + + +BottomIf + + +If the window occludes any sibling, +then the window is placed at the bottom of the stack. + + + + +Opposite + + +If any sibling occludes the window, +then the window is placed at the top of the stack. +Otherwise, if the window occludes any sibling, +then the window is placed at the bottom of the stack. + + + + + + + +It is a +Match +error if a sibling is specified without a stack-mode +or if the window is not actually a sibling. + + +Note that the computations for +BottomIf, +TopIf, +and +Opposite +are performed with respect to the window's final geometry (as controlled by +the other arguments to the request), not to its initial geometry. + + +Attempts to configure a root window have no effect. + + +
+
+ CirculateWindow + CirculateWindow + + + + + + + + +window: WINDOW + + + + +direction: +{ RaiseLowest, +LowerHighest} + + + + + + +Errors: +Value, +Window + + + + + + + + + +If some other client has selected +SubstructureRedirect +on the window, then a +CirculateRequest +event is generated, and no further processing is performed. +Otherwise, the following is performed, and then a +CirculateNotify +event is generated if the window is actually restacked. + + +For +RaiseLowest, +CirculateWindow +raises the lowest mapped child (if any) that is +occluded by another child to the top of the stack. +For +LowerHighest, +CirculateWindow +lowers the highest mapped child (if any) that occludes another child to +the bottom of the stack. +Exposure processing is performed on formerly obscured windows. + + +
+
+ GetGeometry + GetGeometry + + + + + + + + +drawable: DRAWABLE + + + + + + ▶ + + + + + +root: WINDOW + + + + +depth: CARD8 + + + + +x, y: INT16 + + + + +width, height, border-width: CARD16 + + + + + + +Errors: +Drawable + + + + + + + + + +This request returns the root and current geometry of the drawable. +The depth is the number of bits per pixel for the object. +The x, y, and border-width will always be zero for pixmaps. +For a window, +the x and y coordinates specify the upper-left outer corner of the window +relative to its parent's origin, +and the width and height specify the inside size, not including the border. + + +It is legal to pass an +InputOnly +window as a drawable to this request. + + +
+
+ QueryTree + QueryTree + Children + + + + + + + + +window: WINDOW + + + + + + ▶ + + + + + +root: WINDOW + + + + +parent: WINDOW or +None + + + + +children: LISTofWINDOW + + + + + + +Errors: +Window + + + + + + + + + +This request returns the root, the parent, and the children of the window. +The children are listed in bottom-to-top stacking order. + + +
+
+ InternAtom + InternAtom + Atom + + + + + + + + +name: STRING8 + + + + +only-if-exists: BOOL + + + + + + ▶ + + + + + +atom: ATOM or +None + + + + + + +Errors: +Alloc, +Value + + + + + + + + + +This request returns the atom for the given name. +If only-if-exists is +False, +then the atom is created if it does not exist. +The string should use the ISO Latin-1 encoding. +Uppercase and lowercase matter. + + +The lifetime of an atom is not tied to the interning client. +Atoms remain defined until server reset (see section 10). + + +
+
+ GetAtomName + GetAtomName + + + + + + + + +atom: ATOM + + + + + + ▶ + + + + + +name: STRING8 + + + + + + +Errors: +Atom + + + + + + + + + +This request returns the name for the given atom. + + +
+
+ ChangeProperty + ChangeProperty + Property + + + + + + + + +window: WINDOW + + + + +property, type: ATOM + + + + +format: {8, 16, 32} + + + + +mode: +{ Replace, +Prepend, +Append} + + + + +data: LISTofINT8 or LISTofINT16 or LISTofINT32 + + + + + + +Errors: +Alloc, +Atom, +Match, +Value, +Window + + + + + + + + + +This request alters the property for the specified window. +The type is uninterpreted by the server. +The format specifies whether the data should be viewed as a list of 8-bit, +16-bit, or 32-bit quantities so that the server can correctly byte-swap +as necessary. + + +If the mode is +Replace, +the previous property value is discarded. +If the mode is +Prepend +or +Append, +then the type and format must match the existing property value (or a +Match +error results). +If the property is undefined, +it is treated as defined with the correct type +and format with zero-length data. +For +Prepend, +the data is tacked on to the beginning of the existing data, and for +Append, +it is tacked on to the end of the existing data. + + +This request generates a +PropertyNotify +event on the window. + + +The lifetime of a property is not tied to the storing client. +Properties remain until explicitly deleted, until the window is destroyed, +or until server reset (see section 10). + + +The maximum size of a property is server-dependent and may vary dynamically. + + +
+
+ DeleteProperty + DeleteProperty + + + + + + + + +window: WINDOW + + + + +property: ATOM + + + + + + +Errors: +Atom, +Window + + + + + + + + + +This request deletes the property from the specified window +if the property exists and generates a +PropertyNotify +event on the window unless the property does not exist. + + +
+
+ GetProperty + GetProperty + + + + + + + + +window: WINDOW + + + + +property: ATOM + + + + +type: ATOM or +AnyPropertyType + + + + +long-offset, long-length: CARD32 + + + + +delete: BOOL + + + + + + ▶ + + + + + +type: ATOM or +None + + + + +format: {0, 8, 16, 32} + + + + +bytes-after: CARD32 + + + + +value: LISTofINT8 or LISTofINT16 or LISTofINT32 + + + + + + +Errors: +Atom, +Value, +Window + + + + + + + + + +If the specified property does not exist for the specified window, +then the return type is +None, +the format and bytes-after are zero, +and the value is empty. +The delete argument is ignored in this case. +If the specified property exists but its type does not match the specified type, +then the return type is the actual type of the property, +the format is the actual format of the property (never zero), +the bytes-after is the length of the property in bytes +(even if the format is 16 or 32), +and the value is empty. +The delete argument is ignored in this case. +If the specified property exists and either +AnyPropertyType +is specified or the specified type matches the actual type of the property, +then the return type is the actual type of the property, +the format is the actual format of the property (never zero), +and the bytes-after and value are as follows, given: + + N = actual length of the stored property in bytes + (even if the format is 16 or 32) + I = 4 * long-offset + T = N - I + L = MINIMUM(T, 4 * long-length) + A = N - (I + L) + + + +The returned value starts at byte index I in the property (indexing from 0), +and its length in bytes is L. +However, it is a +Value +error if long-offset is given such that L is negative. +The value of bytes-after is A, +giving the number of trailing unread bytes in the stored +property. +If delete is +True +and the bytes-after is zero, +the property is also deleted from the window, +and a +PropertyNotify +event is generated on the window. + + +
+
+ RotateProperties + RotateProperties + + + + + + + + +window: WINDOW + + + + +delta: INT16 + + + + +properties: LISTofATOM + + + + + + +Errors: +Atom, +Match, +Window + + + + + + + + + +If the property names in the list are viewed as being numbered starting +from zero, and there are N property names in the list, +then the value associated with property name I becomes the value +associated with property name (I + delta) mod N, for all I from zero to N - 1. +The effect is to rotate the states by delta places around the virtual ring +of property names (right for positive delta, left for negative delta). + + +If delta mod N is nonzero, +a +PropertyNotify +event is generated for each property in the order listed. + + +If an atom occurs more than once in the list or no property with that +name is defined for the window, +a +Match +error is generated. +If an +Atom +or +Match +error is generated, no properties are changed. + + +
+
+ ListProperties + ListProperties + + + + + + + + +window: WINDOW + + + + + + ▶ + + + + + +atoms: LISTofATOM + + + + + + +Errors: +Window + + + + + + + + + +This request returns the atoms of properties currently defined on the window. + + +
+
+ SetSelectionOwner + SetSelectionOwner + Selection + + + + + + + + +selection: ATOM + + + + +owner: WINDOW or +None + + + + +time: TIMESTAMP or +CurrentTime + + + + + + +Errors: +Atom, +Window + + + + + + + + + +This request changes the owner, owner window, +and last-change time of the specified selection. +This request has no effect if the specified time is earlier +than the current last-change time of the specified selection or is +later than the current server time. +Otherwise, the last-change time is set to the specified time +with +CurrentTime +replaced by the current server time. +If the owner window is specified as +None, +then the owner of the selection becomes +None +(that is, no owner). +Otherwise, the owner of the selection becomes the client executing the request. +If the new owner (whether a client or +None) +is not the same as the current owner +and the current owner is not +None, +then the current owner is sent a +SelectionClear +event. + + +If the client that is the owner of a selection is later terminated +(that is, its connection is closed) or if the owner window it has +specified in the request is later destroyed, +then the owner of the selection automatically reverts to +None, +but the last-change time is not affected. + + +The selection atom is uninterpreted by the server. +The owner window is returned by the +GetSelectionOwner +request and is reported in +SelectionRequest +and +SelectionClear +events. + + +Selections are global to the server. + + +
+
+ GetSelectionOwner + GetSelectionOwner + + + + + + + + +selection: ATOM + + + + + + ▶ + + + + + +owner: WINDOW or +None + + + + + + +Errors: +Atom + + + + + + + + + +This request returns the current owner window of the specified selection, +if any. +If +None +is returned, then there is no owner for the selection. + + +
+
+ ConvertSelection + ConvertSelection + + + + + + + + +selection, target: ATOM + + + + +property: ATOM or +None + + + + +requestor: WINDOW + + + + +time: TIMESTAMP or +CurrentTime + + + + + + +Errors: +Atom, +Window + + + + + + + + + +If the specified selection has an owner, +the server sends a +SelectionRequest +event to that owner. +If no owner for the specified selection exists, +the server generates a +SelectionNotify +event to the requestor with property +None. +The arguments are passed on unchanged in either of the events. + + +
+
+ SendEvent + SendEvent + Eventsending + + + + + + + + +destination: WINDOW or +PointerWindow +or +InputFocus + + + + +propagate: BOOL + + + + +event-mask: SETofEVENT + + + + +event: <normal-event-format> + + + + + + +Errors: +Value, +Window + + + + + + + + + +If +PointerWindow +is specified, +destination is replaced with the window that the pointer is in. +If +InputFocus +is specified and the focus window contains the pointer, +destination is replaced with the window that the pointer is in. +Otherwise, destination is replaced with the focus window. + + +If the event-mask is the empty set, +then the event is sent to the client that created the destination window. +If that client no longer exists, no event is sent. + + +If propagate is +False, +then the event is sent to every client selecting +on destination any of the event types in event-mask. + + +If propagate is +True +and no clients have selected on destination any +of the event types in event-mask, +then destination is replaced with the +closest ancestor of destination for which some client has selected a +type in event-mask and no intervening window has that type in its +do-not-propagate-mask. +If no such window exists or if the window is an ancestor of the focus window +and +InputFocus +was originally specified as the destination, +then the event is not sent to any clients. +Otherwise, the event is reported to every client selecting on the final +destination any of the types specified in event-mask. + + +The event code must be one of the core events or one of the events +defined by an extension (or a +Value +error results) so that the server can correctly byte-swap the +contents as necessary. +The contents of the event are otherwise unaltered and unchecked +by the server except to force on the most significant bit of the event code +and to set the sequence number in the event correctly. + + +Active grabs are ignored for this request. + + +
+
+ GrabPointer + GrabPointer + Active grabpointer + Pointergrabbing + + + + + + + + +grab-window: WINDOW + + + + +owner-events: BOOL + + + + +event-mask: SETofPOINTEREVENT + + + + +pointer-mode, keyboard-mode: +{ Synchronous, +Asynchronous} + + + + +confine-to: WINDOW or +None + + + + +cursor: CURSOR or +None + + + + +time: TIMESTAMP or +CurrentTime + + + + + + ▶ + + + + + +status: +{ Success, +AlreadyGrabbed, +Frozen, +InvalidTime, +NotViewable} + + + + + + +Errors: +Cursor, +Value, +Window + + + + + + + + + +This request actively grabs control of the pointer. +Further pointer events are only reported to the grabbing client. +The request overrides any active pointer grab by this client. + + +If owner-events is +False, +all generated pointer events are reported with respect to grab-window +and are only reported if selected by event-mask. +If owner-events is +True +and a generated pointer event would normally be reported to this client, +it is reported normally. +Otherwise, the event is reported with respect to the grab-window and is +only reported if selected by event-mask. +For either value of owner-events, +unreported events are simply discarded. + + +If pointer-mode is +Asynchronous, +pointer event processing continues normally. +If the pointer is currently frozen by this client, +then processing of pointer events is resumed. +If pointer-mode is +Synchronous, +the state of the pointer (as seen by means of the protocol) appears to freeze, +and no further pointer events are generated by the server until the +grabbing client issues a releasing +AllowEvents +request or until the pointer grab is released. +Actual pointer changes are not lost while the pointer is frozen. +They are simply queued for later processing. + + +If keyboard-mode is +Asynchronous, +keyboard event processing is unaffected by activation of the grab. +If keyboard-mode is +Synchronous, +the state of the keyboard (as seen by means of the protocol) appears to freeze, +and no further keyboard events are generated by the server until the grabbing +client issues a releasing +AllowEvents +request or until the pointer grab is released. +Actual keyboard changes are not lost while the keyboard is frozen. +They are simply queued for later processing. + + +If a cursor is specified, +then it is displayed regardless of what window the pointer is in. +If no cursor is specified, +then when the pointer is in grab-window or one of its subwindows, +the normal cursor for that window is displayed. +Otherwise, the cursor for grab-window is displayed. + + +If a confine-to window is specified, +then the pointer will be restricted to stay contained in that window. +The confine-to window need have no relationship to the grab-window. +If the pointer is not initially in the confine-to window, +then it is warped automatically to the closest edge +(and enter/leave events are generated normally) just before the grab activates. +If the confine-to window is subsequently reconfigured, +the pointer will be warped automatically as necessary to +keep it contained in the window. + + +This request generates +EnterNotify +and +LeaveNotify +events. + + +The request fails with status +AlreadyGrabbed +if the pointer is actively grabbed by some other client. +The request fails with status +Frozen +if the pointer is frozen by an active grab of another client. +The request fails with status +NotViewable +if grab-window or confine-to window is not viewable +or if the confine-to window lies completely outside the boundaries +of the root window. +The request fails with status +InvalidTime +if the specified time is earlier than the last-pointer-grab time or later than +the current server time. +Otherwise, the last-pointer-grab time is set to the specified time, with +CurrentTime +replaced by the current server time. + + +
+
+ UngrabPointer + UngrabPointer + + + + + + + + +time: TIMESTAMP or +CurrentTime + + + + + + + + + +This request releases the pointer if this client has it actively grabbed (from +either +GrabPointer +or +GrabButton +or from a normal button press) and releases any queued events. +The request has no effect if the specified time is earlier than +the last-pointer-grab time or is later than the current server time. + + +This request generates +EnterNotify +and +LeaveNotify +events. + + +An +UngrabPointer +request is performed automatically if the event window or +confine-to window for an active pointer grab becomes not viewable +or if window reconfiguration causes the confine-to window to lie +completely outside the boundaries of the root window. + + +
+
+ GrabButton + GrabButton + Buttongrabbing + + + + + + + + +modifiers: SETofKEYMASK or +AnyModifier + + + + +button: BUTTON or +AnyButton + + + + +grab-window: WINDOW + + + + +owner-events: BOOL + + + + +event-mask: SETofPOINTEREVENT + + + + +pointer-mode, keyboard-mode: +{ Synchronous, +Asynchronous} + + + + +confine-to: WINDOW or +None + + + + +cursor: CURSOR or +None + + + + + + +Errors: +Access, +Cursor, +Value, +Window + + + + + + + + + +This request establishes a passive grab. +Passive grabpointer +In the future, +the pointer is actively grabbed as described in +GrabPointer, +the last-pointer-grab time is set to the time at which the button was +pressed (as transmitted in the +ButtonPress +event), and the +ButtonPress +event is reported if all of the following conditions are true: + +The pointer is not grabbed and the specified button is logically pressed +when the specified modifier keys are logically down, +and no other buttons or modifier keys are logically down. + +The grab-window contains the pointer. + +The confine-to window (if any) is viewable. + +A passive grab on the same button/key combination does not exist +on any ancestor of grab-window. + + +The interpretation of the remaining arguments is the same as for +GrabPointer. +The active grab is terminated automatically when +the logical state of the pointer has all buttons released, +independent of the logical state of modifier keys. +Note that the logical state of a device (as seen by means of the protocol) +may lag the physical state if device event processing is frozen. + + +This request overrides all previous passive grabs by the same client on +the same button/key combinations on the same window. +A modifier of +AnyModifier +is equivalent to issuing the request for all possible modifier combinations +(including the combination of no modifiers). +It is not required that all specified modifiers have currently assigned +keycodes. +A button of +AnyButton +is equivalent to issuing the request for all possible buttons. +Otherwise, it is not required that the button specified currently be assigned +to a physical button. + + +An +Access +error is generated if some other client has already issued a +GrabButton +request with the same button/key combination on the same window. +When using +AnyModifier +or +AnyButton, +the request fails completely (no grabs are established), and an +Access +error is generated if there is a conflicting grab for any combination. +The request has no effect on an active grab. + + +
+
+ UngrabButton + UngrabButton + + + + + + + + +modifiers: SETofKEYMASK or +AnyModifier + + + + +button: BUTTON or +AnyButton + + + + +grab-window: WINDOW + + + + + + +Errors: +Value, +Window + + + + + + + + + +This request releases the passive button/key combination +on the specified window if it was grabbed by this client. +A modifiers argument of +AnyModifier +is equivalent to issuing the request for all possible modifier +combinations (including the combination of no modifiers). +A button of +AnyButton +is equivalent to issuing the request for all possible buttons. +The request has no effect on an active grab. + + +
+
+ ChangeActivePointerGrab + ChangeActivePointerGrab + Active grabpointer + + + + + + + + +event-mask: SETofPOINTEREVENT + + + + +cursor: CURSOR or +None + + + + +time: TIMESTAMP or +CurrentTime + + + + + + +Errors: +Cursor, +Value + + + + + + + + + +This request changes the specified dynamic parameters if the pointer is +actively grabbed by the client and the specified time is no earlier than the +last-pointer-grab time and no later than the current server time. +The interpretation of event-mask and cursor are the same as in +GrabPointer. +This request has no effect on the parameters of any passive grabs established +with +GrabButton. + + +
+
+ GrabKeyboard + GrabKeyboard + Active grabkeyboard + Keyboardgrabbing + + + + + + + + +grab-window: WINDOW + + + + +owner-events: BOOL + + + + +pointer-mode, keyboard-mode: +{ Synchronous, +Asynchronous} + + + + +time: TIMESTAMP or +CurrentTime + + + + + + ▶ + + + + + +status: +{ Success, +AlreadyGrabbed, +Frozen, +InvalidTime, +NotViewable} + + + + + + +Errors: +Value, +Window + + + + + + + + + +This request actively grabs control of the keyboard. +Further key events are reported only to the grabbing client. +This request overrides any active keyboard grab by this client. + + +If owner-events is +False, +all generated key events are reported with respect to grab-window. +If owner-events is +True +and if a generated key event would normally be reported to this client, +it is reported normally. +Otherwise, the event is reported with respect to the grab-window. +Both +KeyPress +and +KeyRelease +events are always reported, +independent of any event selection made by the client. + + +If keyboard-mode is +Asynchronous, +keyboard event processing continues normally. +If the keyboard is currently frozen by this client, +then processing of keyboard events is resumed. +If keyboard-mode is +Synchronous, +the state of the keyboard (as seen by means of the protocol) appears to freeze. +No further keyboard events are generated by the server until the +grabbing client issues a releasing +AllowEvents +request or until the keyboard grab is released. +Actual keyboard changes are not lost while the keyboard is frozen. +They are simply queued for later processing. + + +If pointer-mode is +Asynchronous, +pointer event processing is unaffected by activation of the grab. +If pointer-mode is +Synchronous, +the state of the pointer (as seen by means of the protocol) appears to freeze. +No further pointer events are generated by the server +until the grabbing client issues a releasing +AllowEvents +request or until the keyboard grab is released. +Actual pointer changes are not lost while the pointer is frozen. +They are simply queued for later processing. + + +This request generates +FocusIn +and +FocusOut +events. + + +The request fails with status +AlreadyGrabbed +if the keyboard is actively grabbed by some other client. +The request fails with status +Frozen +if the keyboard is frozen by an active grab of another client. +The request fails with status +NotViewable +if grab-window is not viewable. +The request fails with status +InvalidTime +if the specified time is earlier than the last-keyboard-grab time +or later than the current server time. +Otherwise, the last-keyboard-grab time is set to the specified time with +CurrentTime +replaced by the current server time. + + +
+
+ UngrabKeyboard + UngrabKeyboard + + + + + + + + +time: TIMESTAMP or +CurrentTime + + + + + + + + + +This request releases the keyboard if this client has it actively grabbed +(as a result of either +GrabKeyboard +or +GrabKey) +and releases any queued events. +The request has no effect if the specified time is earlier than the +last-keyboard-grab time or is later than the current server time. + + +This request generates +FocusIn +and +FocusOut +events. + + +An +UngrabKeyboard +is performed automatically if the event window for an active keyboard grab +becomes not viewable. + + +
+
+ GrabKey + GrabKey + Keygrabbing + + + + + + + + +key: KEYCODE or +AnyKey + + + + +modifiers: SETofKEYMASK or +AnyModifier + + + + +grab-window: WINDOW + + + + +owner-events: BOOL + + + + +pointer-mode, keyboard-mode: +{ Synchronous, +Asynchronous} + + + + + + +Errors: +Access, +Value, +Window + + + + + + + + + +This request establishes a passive grab on the keyboard. +Passive grabkeyboard +In the future, +the keyboard is actively grabbed as described in +GrabKeyboard, +the last-keyboard-grab time is set to the time at which the key was pressed +(as transmitted in the +KeyPress +event), and the +KeyPress +event is reported if all of the following conditions are true: + +The keyboard is not grabbed and the specified key +(which can itself be a modifier key) is logically pressed +when the specified modifier keys are logically down, +and no other modifier keys are logically down. + +Either the grab-window is an ancestor of (or is) the focus window, +or the grab-window is a descendent of the focus window and contains the pointer. + +A passive grab on the same key combination does not exist +on any ancestor of grab-window. + + +The interpretation of the remaining arguments is the same as for +GrabKeyboard. +The active grab is terminated automatically when the logical state +of the keyboard has the specified key released, +independent of the logical state of modifier keys. +Note that the logical state of a device (as seen by means of the protocol) +may lag the physical state if device event processing is frozen. + + +This request overrides all previous passive grabs by the same client +on the same key combinations on the same window. +A modifier of +AnyModifier +is equivalent to issuing the request for all possible modifier combinations +(including the combination of no modifiers). +It is not required that all modifiers specified have +currently assigned keycodes. +A key of +AnyKey +is equivalent to issuing the request for all possible keycodes. +Otherwise, the key must be in the range specified by min-keycode +and max-keycode in the connection setup (or a +Value +error results). + + +An +Access +error is generated if some other client has issued a +GrabKey +with the same key combination on the same window. +When using +AnyModifier +or +AnyKey, +the request fails completely (no grabs are established), +and an +Access +error is generated if there is a conflicting grab for any combination. + + +
+
+ UngrabKey + UngrabKey + + + + + + + + +key: KEYCODE or +AnyKey + + + + +modifiers: SETofKEYMASK or +AnyModifier + + + + +grab-window: WINDOW + + + + + + +Errors: +Value, +Window + + + + + + + + + +This request releases the key combination on the specified window +if it was grabbed by this client. +A modifiers argument of +AnyModifier +is equivalent to issuing the request for all possible modifier combinations +(including the combination of no modifiers). +A key of +AnyKey +is equivalent to issuing the request for all possible keycodes. +This request has no effect on an active grab. + + +
+
+ AllowEvents + AllowEvents + + + + + + + + +mode: +{ AsyncPointer, +SyncPointer, +ReplayPointer, +AsyncKeyboard, + + + + +SyncKeyboard, +ReplayKeyboard, +AsyncBoth, +SyncBoth} + + + + +time: TIMESTAMP or +CurrentTime + + + + + + +Errors: +Value + + + + + + + + + +This request releases some queued events if the client has caused a device to +freeze. +The request has no effect if the specified time is earlier +than the last-grab time of the most recent active grab for the client +or if the specified time is later than the current server time. + + +For +AsyncPointer, +if the pointer is frozen by the client, +pointer event processing continues normally. +If the pointer is frozen twice by the client on behalf of two separate grabs, +AsyncPointer +thaws for both. +AsyncPointer +has no effect if the pointer is not frozen by the client, +but the pointer need not be grabbed by the client. + + +For +SyncPointer, +if the pointer is frozen and actively grabbed by the client, +pointer event processing continues normally until the next +ButtonPress +or +ButtonRelease +event is reported to the client, +at which time the pointer again appears to freeze. +However, if the reported event causes the pointer grab to be released, +then the pointer does not freeze. +SyncPointer +has no effect if the pointer is not frozen by the +client or if the pointer is not grabbed by the client. + + +For +ReplayPointer, +if the pointer is actively grabbed by the client and +is frozen as the result of an event having been sent to the client +(either from the activation of a +GrabButton +or from a previous +AllowEvents +with mode +SyncPointer +but not from a +GrabPointer), +then the pointer grab is released and that event is completely reprocessed, +this time ignoring any passive grabs at or above (towards the root) +the grab-window of the grab just released. +The request has no effect if the pointer is not grabbed by the client +or if the pointer is not frozen as the result of an event. + + +For +AsyncKeyboard, +if the keyboard is frozen by the client, +keyboard event processing continues normally. +If the keyboard is frozen twice by the client on behalf of two separate grabs, +AsyncKeyboard +thaws for both. +AsyncKeyboard +has no effect if the keyboard is not frozen by the client, +but the keyboard need not be grabbed by the client. + + +For +SyncKeyboard, +if the keyboard is frozen and actively grabbed by the client, +keyboard event processing continues normally until the next +KeyPress +or +KeyRelease +event is reported to the client, +at which time the keyboard again appears to freeze. +However, if the reported event causes the keyboard grab to be released, +then the keyboard does not freeze. +SyncKeyboard +has no effect if the keyboard is not frozen by the client or +if the keyboard is not grabbed by the client. + + +For +ReplayKeyboard, +if the keyboard is actively grabbed by the client +and is frozen as the result of an event having been sent to the client +(either from the activation of a +GrabKey +or from a previous +AllowEvents +with mode +SyncKeyboard +but not from a +GrabKeyboard), +then the keyboard grab is released and that event is completely reprocessed, +this time ignoring any passive grabs at or above (towards the root) +the grab-window of the grab just released. +The request has no effect if the keyboard is not grabbed by the client +or if the keyboard is not frozen as the result of an event. + + +For +SyncBoth, +if both pointer and keyboard are frozen by the client, +event processing (for both devices) continues normally until the next +ButtonPress, +ButtonRelease, +KeyPress, +or +KeyRelease +event is reported to the client for a grabbed device +(button event for the pointer, key event for the keyboard), +at which time the devices again appear to freeze. +However, if the reported event causes the grab to be released, +then the devices do not freeze (but if the other device is still +grabbed, then a subsequent event for it will still cause both devices +to freeze). +SyncBoth +has no effect unless both pointer and keyboard are frozen by the client. +If the pointer or keyboard is frozen twice by the client on behalf +of two separate grabs, +SyncBoth +thaws for both (but a subsequent freeze for +SyncBoth +will only freeze each device once). + + +For +AsyncBoth, +if the pointer and the keyboard are frozen by the client, +event processing for both devices continues normally. +If a device is frozen twice by the client on behalf of two separate grabs, +AsyncBoth +thaws for both. +AsyncBoth +has no effect unless both pointer and keyboard are frozen by the client. + + +AsyncPointer, +SyncPointer, +and +ReplayPointer +have no effect on processing of keyboard events. +AsyncKeyboard, +SyncKeyboard, +and +ReplayKeyboard +have no effect on processing of pointer events. + + +It is possible for both a pointer grab and a keyboard grab to be active +simultaneously (by the same or different clients). +When a device is frozen on behalf of either grab, +no event processing is performed for the device. +It is possible for a single device to be frozen because of both grabs. +In this case, the freeze must be released on behalf of both grabs +before events can again be processed. +If a device is frozen twice by a single client, then a single +AllowEvents +releases both. + + +
+
+ GrabServer + GrabServer + Servergrabbing + +This request disables processing of requests and close-downs on all +connections other than the one this request arrived on. + + +
+
+ UngrabServer + UngrabServer + +This request restarts processing of requests and close-downs +on other connections. + + +
+
+ QueryPointer + QueryPointer + + + + + + + + +window: WINDOW + + + + + + ▶ + + + + + +root: WINDOW + + + + +child: WINDOW or +None + + + + +same-screen: BOOL + + + + +root-x, root-y, win-x, win-y: INT16 + + + + +mask: SETofKEYBUTMASK + + + + + + +Errors: +Window + + + + + + + + + +The root window the pointer is logically on and the pointer coordinates +relative to the root's origin are returned. +If same-screen is +False, +then the pointer is not on the same screen as the argument window, +child is +None, +and win-x and win-y are zero. +If same-screen is +True, +then win-x and win-y are the pointer coordinates relative to the +argument window's origin, and child is the child containing the +pointer, if any. +The current logical state of the modifier keys and the buttons +are also returned. +Note that the logical state of a device (as seen by means of the protocol) +may lag the physical state if device event processing is frozen. + + +
+
+ GetMotionEvents + GetMotionEvents + + + + + + + + +start, +stop: TIMESTAMP or +CurrentTime + + + + +window: WINDOW + + + + + + ▶ + + + + + +events: LISTofTIMECOORD + + + + + +where: + + + + +TIMECOORD: [x, y: INT16 + + + + + time: TIMESTAMP] + + + + + + + +Errors: +Window + + + + + + + + + +This request returns all events in the motion history buffer that fall +between the specified start and stop times (inclusive) +and that have coordinates that lie within (including borders) +the specified window at its present placement. +The x and y coordinates are reported relative to the origin of the window. + + +If the start time is later than the stop time or if the start time is +in the future, no events are returned. +If the stop time is in the future, it is equivalent to specifying +CurrentTime. + + +
+
+ TranslateCoordinates + TranslateCoordinates + Coordinate systemtranslating + + + + + + + + +src-window, dst-window: WINDOW + + + + +src-x, src-y: INT16 + + + + + + ▶ + + + + + +same-screen: BOOL + + + + +child: WINDOW or +None + + + + +dst-x, dst-y: INT16 + + + + + + +Errors: +Window + + + + + + + + + +The src-x and src-y coordinates are taken relative to src-window's +origin and are returned as dst-x and dst-y coordinates relative to +dst-window's origin. +If same-screen is +False, +then src-window and dst-window are on different screens, +and dst-x and dst-y are zero. +If the coordinates are contained in a mapped child of dst-window, +then that child is returned. + + +
+
+ WarpPointer + WarpPointer + + + + + + + + +src-window: WINDOW or +None + + + + +dst-window: WINDOW or +None + + + + +src-x, src-y: INT16 + + + + +src-width, src-height: CARD16 + + + + +dst-x, dst-y: INT16 + + + + + + +Errors: +Window + + + + + + + + + +If dst-window is +None, +this request moves the pointer by offsets [dst-x, dst-y] +relative to the current position of the pointer. +If dst-window is a window, +this request moves the pointer to [dst-x, dst-y] relative to dst-window's +origin. +However, if src-window is not +None, +the move only takes place if src-window contains the pointer +and the pointer is contained in the specified rectangle of src-window. + + +The src-x and src-y coordinates are relative to src-window's origin. +If src-height is zero, +it is replaced with the current height of src-window minus src-y. +If src-width is zero, +it is replaced with the current width of src-window minus src-x. + + +This request cannot be used to move the pointer outside the confine-to +window of an active pointer grab. +An attempt will only move the pointer as far as the closest edge +of the confine-to window. + + +This request will generate events just as if the user had instantaneously +moved the pointer. + + +
+
+ SetInputFocus + SetInputFocus + Input focus + + + + + + + + +focus: WINDOW or +PointerRoot +or +None + + + + +revert-to: +{ Parent, +PointerRoot, +None} + + + + +time: TIMESTAMP or +CurrentTime + + + + + + +Errors: +Match, +Value, +Window + + + + + + + + + +This request changes the input focus and the last-focus-change time. +The request has no effect if the specified time is earlier than the current +last-focus-change time or is later than the current server time. +Otherwise, the last-focus-change time is set to the specified time +with +CurrentTime +replaced by the current server time. + + +If +None +is specified as the focus, +all keyboard events are discarded until a new focus window is set. +In this case, the revert-to argument is ignored. + + +If a window is specified as the focus, +it becomes the keyboard's focus window. +If a generated keyboard event would normally be reported to +this window or one of its inferiors, the event is reported normally. +Otherwise, the event is reported with respect to the focus window. + + +If +PointerRoot +is specified as the focus, +the focus window is dynamically taken to be the root window of whatever screen +the pointer is on at each keyboard event. +In this case, +the revert-to argument is ignored. + + +This request generates +FocusIn +and +FocusOut +events. + + +The specified focus window must be viewable at the time of the request (or a +Match +error results). +If the focus window later becomes not viewable, +the new focus window depends on the revert-to argument. +If revert-to is +Parent, +the focus reverts to the parent (or the closest viewable ancestor) +and the new revert-to value is taken to be +None. +If revert-to is +PointerRoot +or +None, +the focus reverts to that value. +When the focus reverts, +FocusIn +and +FocusOut +events are generated, +but the last-focus-change time is not affected. + + +
+
+ GetInputFocus + GetInputFocus + + + + + + + + ▶ + + + + + +focus: WINDOW or +PointerRoot +or +None + + + + +revert-to: +{ Parent, +PointerRoot, +None} + + + + + + + + + +This request returns the current focus state. + + +
+
+ QueryKeymap + QueryKeymap + + + + + + + + ▶ + + + + + +keys: LISTofCARD8 + + + + + + + + + +This request returns a bit vector for the logical state of the keyboard. +Each bit set to 1 indicates that the corresponding key is currently pressed. +The vector is represented as 32 bytes. +Byte N (from 0) contains the bits for keys 8N to 8N + 7 +with the least significant bit in the byte representing key 8N. +Note that the logical state of a device (as seen by means of the protocol) +may lag the physical state if device event processing is frozen. + + +
+
+ OpenFont + OpenFont + Font + + + + + + + + +fid: FONT + + + + +name: STRING8 + + + + + + +Errors: +Alloc, +IDChoice, +Name + + + + + + + + + +This request loads the specified font, if necessary, +and associates identifier fid with it. +The font name should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +When the characters ? and * are used in a font name, a +pattern match is performed and any matching font is used. +In the pattern, +the ? character (octal value 77) will match any single character, +and the * character (octal value 52) will match any number +of characters. +A structured format for font names is specified in the +X.Org standard X Logical Font Description Conventions. + + +Fonts are not associated with a particular screen +and can be stored as a component of any graphics context. + + +
+
+ CloseFont + CloseFont + + + + + + + + +font: FONT + + + + + + +Errors: +Font + + + + + + + + + +This request deletes the association between the resource ID and the font. +The font itself will be freed when no other resource references it. + + +
+
+ QueryFont + QueryFont + + + + + + + + + + + +font: FONTABLE + + + + + + ▶ + + + + + +font-info: FONTINFO + + + + +char-infos: LISTofCHARINFO + + + + + + +where: + + + + +FONTINFO: + + +[draw-direction: +{ LeftToRight, +RightToLeft } + + + + +min-char-or-byte2, max-char-or-byte2: CARD16 + + + + +min-byte1, max-byte1: CARD8 + + + + +all-chars-exist: BOOL + + + + +default-char: CARD16 + + + + +min-bounds: CHARINFO + + + + +max-bounds: CHARINFO + + + + +font-ascent: INT16 + + + + +font-descent: INT16 + + + + +properties: LISTofFONTPROP] + + + + +FONTPROP: + + +[name: ATOM + + + + +value: <32-bit-value>] + + + + +CHARINFO: + + +[left-side-bearing: INT16 + + + + +right-side-bearing: INT16 + + + + +character-width: INT16 + + + + +ascent: INT16 + + + + +descent: INT16 + + + + +attributes: CARD16] + + + + + +Errors: +Font + + + + + + + + + +This request returns logical information about a font. +If a gcontext is given for font, +the currently contained font is used. + + +The draw-direction is just a hint +and indicates whether most char-infos have a positive, +LeftToRight, +or a negative, +RightToLeft, +character-width metric. +The core protocol defines no support for vertical text. + + +If min-byte1 and max-byte1 are both zero, +then min-char-or-byte2 specifies the linear character index corresponding +to the first element of char-infos, +and max-char-or-byte2 specifies the linear character index of the last element. +If either min-byte1 or max-byte1 are nonzero, +then both min-char-or-byte2 and max-char-or-byte2 will be less than 256, +and the 2-byte character index values corresponding to char-infos element N +(counting from 0) are: + + byte1 = N/D + min-byte1 + byte2 = N\\D + min-char-or-byte2 + + + +where: + + D = max-char-or-byte2 - min-char-or-byte2 + 1 + / = integer division + \\ = integer modulus + + + +If char-infos has length zero, +then min-bounds and max-bounds will be identical, +and the effective char-infos is one filled with this char-info, of length: + + L = D * (max-byte1 - min-byte1 + 1) + + + +That is, +all glyphs in the specified linear or matrix range have the same information, +as given by min-bounds (and max-bounds). +If all-chars-exist is +True, +then all characters in char-infos have nonzero bounding boxes. + + +The default-char specifies the character that will be used when an +undefined or nonexistent character is used. +Note that default-char is a CARD16, not CHAR2B. +For a font using 2-byte matrix format, +the default-char has byte1 in the most significant byte +and byte2 in the least significant byte. +If the default-char itself specifies an undefined or nonexistent character, +then no printing is performed for an undefined or nonexistent character. + + +The min-bounds and max-bounds contain the minimum and maximum values of +each individual CHARINFO component over all char-infos (ignoring +nonexistent characters). +The bounding box of the font (that is, the +smallest rectangle enclosing the shape obtained by superimposing all +characters at the same origin [x,y]) has its upper-left coordinate at: + + [x + min-bounds.left-side-bearing, y - max-bounds.ascent] + +with a width of: + + max-bounds.right-side-bearing - min-bounds.left-side-bearing + + + +and a height of: + + max-bounds.ascent + max-bounds.descent + + + +The font-ascent is the logical extent of the font above the baseline +and is used for determining line spacing. +Specific characters may extend beyond this. +The font-descent is the logical extent of the font at or below the baseline +and is used for determining line spacing. +Specific characters may extend beyond this. +If the baseline is at Y-coordinate y, +then the logical extent of the font is inclusive +between the Y-coordinate values (y - font-ascent) and (y + font-descent - 1). + + +A font is not guaranteed to have any properties. +The interpretation of the property value (for example, INT32, CARD32) +must be derived from a priori knowledge of the property. +A basic set of font properties is specified in the X.Org +standard X Logical Font Description Conventions. + + +For a character origin at [x,y], +the bounding box of a character (that is, +the smallest rectangle enclosing the character's shape), described in +terms of CHARINFO components, is a rectangle with its upper-left corner at: + + [x + left-side-bearing, y - ascent] + + + +with a width of: + + right-side-bearing - left-side-bearing + + + +and a height of: + + ascent + descent + + + +and the origin for the next character is defined to be: + + [x + character-width, y] + + + +Note that the baseline is logically viewed as being just below +nondescending characters (when descent is zero, only pixels with +Y-coordinates less than y are drawn) and that the origin is logically +viewed as being coincident with the left edge of a nonkerned character +(when left-side-bearing is zero, no pixels with X-coordinate less than +x are drawn). + + +Note that CHARINFO metric values can be negative. + + +A nonexistent character is represented with all CHARINFO components +zero. + + +The interpretation of the per-character attributes field is +server-dependent. + + +
+
+ QueryTextExtents + QueryTextExtents + + + + + + + + +font: FONTABLE + + + + +string: STRING16 + + + + + + ▶ + + + + + +draw-direction: +{ LeftToRight, +RightToLeft} + + + + +font-ascent: INT16 + + + + +font-descent: INT16 + + + + +overall-ascent: INT16 + + + + +overall-descent: INT16 + + + + +overall-width: INT32 + + + + +overall-left: INT32 + + + + +overall-right: INT32 + + + + + + +Errors: +Font + + + + + + + + + +This request returns the logical extents of the specified string of characters +in the specified font. +If a gcontext is given for font, +the currently contained font is used. +The draw-direction, font-ascent, and font-descent are the same as +described in +QueryFont. +The overall-ascent is the maximum of the ascent metrics of all characters +in the string, and the overall-descent is the maximum of the descent metrics. +The overall-width is the sum of the character-width metrics of all characters +in the string. +For each character in the string, +let W be the sum of the character-width metrics of all characters preceding it +in the string, +let L be the left-side-bearing metric of the character plus W, +and let R be the right-side-bearing metric of the character plus W. +The overall-left is the minimum L of all characters in the string, +and the overall-right is the maximum R. + + +For fonts defined with linear indexing rather than 2-byte matrix indexing, +the server will interpret each CHAR2B as a 16-bit number that +has been transmitted most significant byte first (that is, byte1 of the +CHAR2B is taken as the most significant byte). + + +Characters with all zero metrics are ignored. +If the font has no defined default-char, +then undefined characters in the string are also ignored. + + +
+
+ ListFonts + ListFonts + + + + + + + + +pattern: STRING8 + + + + +max-names: CARD16 + + + + + + ▶ + + + + + +names: LISTofSTRING8 + + + + + + + + + +This request returns a list +of available font names (as controlled by the font search path; see +SetFontPath +request) +that match the pattern. +At most, max-names names will be returned. +The pattern should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +In the pattern, +the ? character (octal value 77) will match any single character, +and the * character (octal value 52) will match any number +of characters. +The returned names are in lowercase. + + +
+
+ ListFontsWithInfo + ListFontsWithInfo + + + + + + + + +pattern: STRING8 + + + + +max-names: CARD16 + + + + + + ▶ + + + + + +name: STRING8 + + + + +info FONTINFO + + + + +replies-hint: CARD32 + + + + + + +where: + + + + + + +FONTINFO: <same type definition as in +QueryFont> + + + + + + + + +This request is similar to +ListFonts, +but it also returns information about each font. +The information returned for each font is identical to what +QueryFont +would return except that the per-character metrics are not returned. +Note that this request can generate multiple replies. +With each reply, +replies-hint may provide an indication of how many more fonts will be returned. +This number is a hint only and may be larger or smaller than +the number of fonts actually returned. +A zero value does not guarantee that no more fonts will be returned. +After the font replies, +a reply with a zero-length name is sent to indicate the end of the reply +sequence. + + +
+
+ SetFontPath + SetFontPath + + + + + + + + +path: LISTofSTRING8 + + + + + + +Errors: +Value + + + + + + + + + +This request defines the search path for font lookup. +There is only one search path per server, not one per client. +The interpretation of the strings is operating-system-dependent, +but the strings are intended to specify directories to be searched in the +order listed. + + +Setting the path to the empty list restores the default path defined +for the server. + + +As a side effect of executing this request, +the server is guaranteed to flush all cached information about fonts +for which there currently are no explicit resource IDs allocated. + + +The meaning of an error from this request is system specific. + + +
+
+ GetFontPath + GetFontPath + + + + + + + + ▶ + + + + + +path: LISTofSTRING8 + + + + + + + + + +This request returns the current search path for fonts. + + +
+
+ CreatePixmap + CreatePixmap + + + + + + + + +pid: PIXMAP + + + + +drawable: DRAWABLE + + + + +depth: CARD8 + + + + +width, height: CARD16 + + + + + + +Errors: +Alloc, +Drawable, +IDChoice, +Value + + + + + + + + + +This request creates a pixmap and assigns the identifier pid to it. +The width and height must be nonzero (or a +Value +error results). +The depth must be one of the depths supported by the root of the specified +drawable (or a +Value +error results). +The initial contents of the pixmap are undefined. + + +It is legal to pass an +InputOnly +window as a drawable to this request. + + +
+
+ FreePixmap + FreePixmap + + + + + + + + +pixmap: PIXMAP + + + + + + +Errors: +Pixmap + + + + + + + + + +This request deletes the association between the resource ID and the pixmap. +The pixmap storage will be freed when no other resource references it. + + +
+
+ CreateGC + CreateGC + Graphics context + + + + + + + + +cid: GCONTEXT + + + + +drawable: DRAWABLE + + + + +value-mask: BITMASK + + + + +value-list: LISTofVALUE + + + + + + +Errors: +Alloc, +Drawable, +Font, +IDChoice, +Match, +Pixmap, +Value + + + + + + + + + +This request creates a graphics context +and assigns the identifier cid to it. +The gcontext can be used with any destination drawable having the same root +and depth as the specified drawable; +use with other drawables results in a +Match +error. + + +The value-mask and value-list specify which components are to be +explicitly initialized. +The context components are: + + + + + + + + + + Component + Type + + + + + function + +{ Clear, +And, +AndReverse, +Copy, +AndInverted, +NoOp, +Xor, +Or, +Nor, +Equiv, +Invert, +OrReverse, +CopyInverted, +OrInverted, +Nand, +Set } + + + + plane-mask + CARD32 + + + foreground + CARD32 + + + background + CARD32 + + + line-width + CARD16 + + + line-style + +{ Solid, +OnOffDash, +DoubleDash } + + + + cap-style + +{ NotLast, +Butt, +Round, +Projecting } + + + + join-style + +{ Miter, +Round, +Bevel } + + + + fill-style + +{ Solid, +Tiled, +OpaqueStippled, +Stippled } + + + + fill-rule + +{ EvenOdd, +Winding } + + + + arc-mode + +{ Chord, +PieSlice } + + + + tile + PIXMAP + + + stipple + PIXMAP + + + tile-stipple-x-origin + INT16 + + + tile-stipple-y-origin + INT16 + + + font + FONT + + + subwindow-mode + +{ ClipByChildren, +IncludeInferiors } + + + + graphics-exposures + BOOL + + + clip-x-origin + INT16 + + + clip-y-origin + INT16 + + + clip-mask + +PIXMAP or +None + + + + dash-offset + CARD16 + + + dashes + CARD8 + + + + + + +Planemask +In graphics operations, +given a source and destination pixel, +the result is computed bitwise on corresponding bits of the pixels; +that is, a Boolean operation is performed in each bit plane. +The plane-mask restricts the operation to a subset of planes, +so the result is: + + + + ((src FUNC dst) AND plane-mask) OR (dst AND (NOT plane-mask)) + + + +Range checking is not performed on the values for foreground, background, +or plane-mask. +They are simply truncated to the appropriate number of bits. + + + +The meanings of the functions are: + + + + + + + + + + Function + Operation + + + + + +Clear + + 0 + + + +And + + src AND dst + + + +AndReverse + + src AND (NOT dst) + + + +Copy + + src + + + +AndInverted + + (NOT src) AND dst + + + +NoOp + + dst + + + +Xor + + src XOR dst + + + +Or + + src OR dst + + + +Nor + + (NOT src) AND (NOT dst) + + + +Equiv + + (NOT src) XOR dst + + + +Invert + + NOT dst + + + +OrReverse + + src OR (NOT dst) + + + +CopyInverted + + NOT src + + + +OrInverted + + (NOT src) OR dst + + + +Nand + + (NOT src) OR (NOT dst) + + + +Set + + 1 + + + + + + +Linedrawing +The line-width is measured in pixels and can be greater than or equal to +one, a wide line, or the special value zero, a thin line. + + + +Wide lines are drawn centered on the path described by the graphics request. +Unless otherwise specified by the join or cap style, +the bounding box of a wide line with endpoints [x1, y1], [x2, y2] and +width w is a rectangle with vertices at the following real coordinates: + + + + [x1-(w*sn/2), y1+(w*cs/2)], [x1+(w*sn/2), y1-(w*cs/2)], + [x2-(w*sn/2), y2+(w*cs/2)], [x2+(w*sn/2), y2-(w*cs/2)] + + + +The sn is the sine of the angle of the line and cs is the cosine of +the angle of the line. +A pixel is part of the line (and hence drawn) if the center of the pixel +is fully inside the bounding box, which is viewed as having infinitely thin +edges. +If the center of the pixel is exactly on the bounding box, +it is part of the line if and only if the interior is immediately to its right +(x increasing direction). +Pixels with centers on a horizontal edge are a special case and are part of +the line if and only if the interior or the boundary is immediately below +(y increasing direction) and if the interior or the boundary is immediately +to the right (x increasing direction). +Note that this description is a mathematical model describing the pixels +that are drawn for a wide line and does not imply that trigonometry is required +to implement such a model. +Real or fixed point arithmetic is recommended for computing the corners of the +line endpoints for lines greater than one pixel in width. + + +Thin lines (zero line-width) are nominally one pixel wide lines drawn using an +unspecified, device-dependent algorithm. +There are only two constraints on this algorithm. +First, if a line is drawn unclipped from [x1,y1] to [x2,y2] +and another line is drawn unclipped from [x1+dx,y1+dy] to [x2+dx,y2+dy], +then a point [x,y] is touched by drawing the first line if +and only if the point [x+dx,y+dy] is touched by drawing the second line. +Second, the effective set of points comprising a line cannot be affected +by clipping. +Thus, a point is touched in a clipped line if and only if the point lies +inside the clipping region and the point would be touched by the line +when drawn unclipped. + + +Note that a wide line drawn from [x1,y1] to [x2,y2] always draws the +same pixels as a wide line drawn from [x2,y2] to [x1,y1], not counting +cap-style and join-style. +Implementors are encouraged to make this property true for thin lines, +but it is not required. +A line-width of zero may differ from a line-width of one in which pixels +are drawn. +In general, +drawing a thin line will be faster than drawing a wide line of width one, +but thin lines may not mix well aesthetically with wide lines +because of the different drawing algorithms. +If it is desirable to obtain precise and uniform results across all displays, +a client should always use a line-width of one, rather than a line-width of +zero. + + +The line-style defines which sections of a line are drawn: + + + + + + + + + + +Solid + + +The full path of the line is drawn. + + + + +DoubleDash + + +The full path of the line is drawn, +but the even dashes are filled differently than the odd dashes +(see fill-style), with +Butt +cap-style used where even and odd dashes meet. + + + + +OnOffDash + + +Only the even dashes are drawn, +and cap-style applies to all internal ends of the individual dashes +(except +NotLast +is treated as +Butt). + + + + + + + +The cap-style defines how the endpoints of a path are drawn: + + + + + + + + + + +NotLast + + +The result is equivalent to +Butt, +except that for a line-width of zero the final endpoint is not drawn. + + + + +Butt + + +The result is square at the endpoint (perpendicular to the slope of the +line) with no projection beyond. + + + + +Round + + +The result is a circular arc with its diameter equal to the line-width, +centered on the endpoint; it is equivalent to +Butt +for line-width zero. + + + + +Projecting + + +The result is square at the end, but the path continues beyond the +endpoint for a distance equal to half the line-width; +it is equivalent to +Butt +for line-width zero. + + + + + + + + + +The join-style defines how corners are drawn for wide lines: + + + + + + + + + + +Miter + + +The outer edges of the two lines extend to meet at an angle. +However, if the angle is less than 11 degrees, a +Bevel +join-style is used instead. + + + + +Round + + +The result is a circular arc with a diameter equal to the line-width, +centered on the joinpoint. + + + + +Bevel + + +The result is +Butt +endpoint styles, and then the triangular notch is filled. + + + + + + + + +For a line with coincident endpoints (x1=x2, y1=y2), when the cap-style +is applied to both endpoints, the semantics depends on the line-width +and the cap-style: + + + + + + + + + + + +NotLast + + thin + +This is device-dependent, but the desired effect is that nothing is drawn. + + + + +Butt + + thin + +This is device-dependent, but the desired effect is that +a single pixel is drawn. + + + + +Round + + thin + +This is the same as +Butt/thin. + + + + +Projecting + + thin + +This is the same as +Butt/thin. + + + + +Butt + + wide + +Nothing is drawn. + + + + +Round + + wide + +The closed path is a circle, centered at the endpoint and +with a diameter equal to the line-width. + + + + +Projecting + + wide + +The closed path is a square, aligned with the coordinate axes, +centered at the endpoint and with sides equal to the line-width. + + + + + + + +For a line with coincident endpoints (x1=x2, y1=y2), +when the join-style is applied at one or both endpoints, +the effect is as if the line was removed from the overall path. +However, if the total path consists of (or is reduced to) a single point +joined with itself, +the effect is the same as when the cap-style is applied at both endpoints. + + +The tile/stipple represents an infinite two-dimensional plane +with the tile/stipple +replicated in all dimensions. When that plane is superimposed on +the drawable for use in a graphics operation, the upper-left corner +of some instance of the tile/stipple is at the coordinates within +the drawable specified by the tile/stipple origin. +The tile/stipple and clip origins are interpreted relative to the +origin of whatever destination drawable is specified in a graphics +request. + + +The tile pixmap must have the same root and depth as the gcontext (or a +Match +error results). +The stipple pixmap must have depth one and must have the same root +as the gcontext (or a +Match +error results). +For fill-style +Stippled +(but not fill-style +OpaqueStippled), +the stipple pattern is tiled in a single plane +and acts as an additional clip mask to be ANDed with the clip-mask. +Any size pixmap can be used for tiling or stippling, +although some sizes may be faster to use than others. + + +The fill-style defines the contents of the source for line, text, and +fill requests. +For all text and fill requests (for example, +PolyText8, +PolyText16, +PolyFillRectangle, +FillPoly, +and +PolyFillArc) +as well as for line requests with line-style +Solid, +(for example, +PolyLine, +PolySegment, +PolyRectangle, +PolyArc ) +and for the even dashes for line requests with line-style +OnOffDash +or +DoubleDash: + + + + + + + + + + +Solid + + Foreground + + + +Tiled + + Tile + + + +OpaqueStippled + + +A tile with the same width and height as stipple +but with background everywhere stipple has a zero +and with foreground everywhere stipple has a one + + + + +Stippled + + +Foreground masked by stipple + + + + + + + +For the odd dashes for line requests with line-style +DoubleDash: + + + + + + + + + + +Solid + + Background + + + +Tiled + + Same as for even dashes + + + +OpaqueStippled + + Same as for even dashes + + + +Stippled + + Background masked by stipple + + + + + + + +The dashes value allowed here is actually a simplified form of the more +general patterns that can be set with +SetDashes. +Specifying a value of N here is equivalent to specifying +the two element list [N, N] in +SetDashes. +The value must be nonzero (or a +Value +error results). +The meaning of dash-offset and dashes are explained in the +SetDashes +request. + + +Clipping region +The clip-mask restricts writes to the destination drawable. +Only pixels where the clip-mask has bits set to 1 are drawn. +Pixels are not drawn outside the area covered by the clip-mask +or where the clip-mask has bits set to 0. +The clip-mask affects all graphics requests, +but it does not clip sources. +The clip-mask origin is interpreted relative to the origin of whatever +destination drawable is specified in a graphics request. +If a pixmap is specified as the clip-mask, +it must have depth 1 and have the same root as the gcontext (or a +Match +error results). +If clip-mask is +None, +then pixels are always drawn, regardless of the clip origin. +The clip-mask can also be set with the +SetClipRectangles +request. + + +For +ClipByChildren, +both source and destination windows are additionally clipped by all viewable +InputOutput +children. +For +IncludeInferiors, +neither source nor destination window is clipped by inferiors. +This will result in including subwindow contents in the +source and drawing through subwindow boundaries of the destination. +The use of +IncludeInferiors +with a source or destination window of one depth with mapped inferiors +of differing depth is not illegal, +but the semantics is undefined by the core protocol. + + +Winding rule +Fill rule +The fill-rule defines what pixels are inside (that is, are drawn) for +paths given in +FillPoly +requests. +EvenOdd +means a point is inside if an infinite ray with the point as origin crosses +the path an odd number of times. +For +Winding, +a point is inside if an infinite ray with the point as origin crosses an +unequal number of clockwise and counterclockwise directed path segments. +A clockwise directed path segment is one that crosses the ray from left +to right as observed from the point. +A counter-clockwise segment is one that crosses the ray from right to left +as observed from the point. +The case where a directed line segment is coincident with the ray is +uninteresting because one can simply choose a different ray that is not +coincident with a segment. + + +For both fill rules, +a point is infinitely small and the path is an infinitely thin line. +A pixel is inside if the center point of the pixel is inside +and the center point is not on the boundary. +If the center point is on the boundary, +the pixel is inside if and only if the polygon interior is immediately +to its right (x increasing direction). +Pixels with centers along a horizontal edge are a special case +and are inside if and only if the polygon interior is immediately below +(y increasing direction). + + +The arc-mode controls filling in the +PolyFillArc +request. + + +The graphics-exposures flag controls +GraphicsExposure +event generation for +CopyArea +and +CopyPlane +requests (and any similar requests defined by extensions). + + +The default component values are: + + + + + + + + + + Component + Default + + + + + function + +Copy + + + + plane-mask + all ones + + + foreground + 0 + + + background + 1 + + + line-width + 0 + + + line-style + Solid + + + cap-style + Butt + + + join-style + Miter + + + fill-style + Solid + + + fill-rule + EvenOdd + + + arc-mode + PieSlice + + + tile + + +Pixmap of unspecified size filled with foreground pixel + + +(that is, client specified pixel if any, else 0) + + +(subsequent changes to foreground do not affect this pixmap) + + + + + stipple + +Pixmap of unspecified size filled with ones + + + + tile-stipple-x-origin + 0 + + + tile-stipple-y-origin + 0 + + + font + <server-dependent-font> + + + subwindow-mode + +ClipByChildren + + + + graphics-exposures + +True + + + + clip-x-origin + 0 + + + clip-y-origin + 0 + + + clip-mask + +None + + + + dash-offset + 0 + + + dashes + 4 (that is, the list [4, 4]) + + + + + + +Storing a pixmap in a gcontext might or might not result in a copy +being made. +If the pixmap is later used as the destination for a graphics request, +the change might or might not be reflected in the gcontext. +If the pixmap is used simultaneously in a graphics request +as both a destination and as a tile or stipple, +the results are not defined. + + +It is quite likely that some amount of gcontext information will be +cached in display hardware and that such hardware can only cache a +small number of gcontexts. +Given the number and complexity of components, +clients should view switching between gcontexts with nearly +identical state as significantly more expensive than making minor +changes to a single gcontext. + + +
+
+ ChangeGC + ChangeGC + + + + + + + + +gc: GCONTEXT + + + + +value-mask: BITMASK + + + + +value-list: LISTofVALUE + + + + + + +Errors: +Alloc, +Font, +GContext, +Match, +Pixmap, +Value + + + + + + + + + +This request changes components in gc. +The value-mask and value-list specify which components are to be changed. +The values and restrictions are the same +as for +CreateGC. + + +Changing the clip-mask also overrides any previous +SetClipRectangles +request on the context. +Changing dash-offset or dashes overrides any previous +SetDashes +request on the context. + + +The order in which components are verified and altered is server-dependent. +If an error is generated, +a subset of the components may have been altered. + + +
+
+ CopyGC + CopyGC + + + + + + + + +src-gc, dst-gc: GCONTEXT + + + + +value-mask: BITMASK + + + + + + +Errors: +Alloc, +GContext, +Match, +Value + + + + + + + + + +This request copies components from src-gc to dst-gc. +The value-mask specifies which components to copy, as for +CreateGC. +The two gcontexts must have the same root and the same depth (or a +Match +error results). + + +
+
+ SetDashes + SetDashes + + + + + + + + +gc: GCONTEXT + + + + +dash-offset: CARD16 + + + + +dashes: LISTofCARD8 + + + + + + +Errors: +Alloc, +GContext, +Value + + + + + + + + + +This request sets dash-offset and dashes in gc for dashed line styles. +Dashes cannot be empty (or a +Value +error results). +Specifying an odd-length list is equivalent to specifying the same list +concatenated with itself to produce an even-length list. +The initial and alternating elements of dashes are the even dashes; +the others are the odd dashes. +Each element specifies a dash length in pixels. +All of the elements must be nonzero (or a +Value +error results). +The dash-offset defines the phase of the pattern, +specifying how many pixels into dashes the pattern should actually begin in +any single graphics request. +Dashing is continuous through path elements combined with a join-style +but is reset to the dash-offset between each sequence of joined lines. + + +The unit of measure for dashes is the same as in the ordinary +coordinate system. +Ideally, a dash length is measured along the slope of the line, +but implementations are only required to match this ideal +for horizontal and vertical lines. +Failing the ideal semantics, +it is suggested that the length be measured along the major axis of the line. +The major axis is defined as the x axis for lines drawn at an angle of +between -45 and +45 degrees or between 135 and 225 degrees from the x axis. +For all other lines, the major axis is the y axis. + + +For any graphics primitive, the computation of the endpoint of an individual +dash only depends on the geometry of the primitive, the start position +of the dash, the direction of the dash, and the dash length. + + +For any graphics primitive, the total set of pixels used to render the +primitive (both even and odd numbered dash elements) with +DoubleDash +line-style is the same as the set of pixels used to render the +primitive with +Solid +line-style. + + +For any graphics primitive, if the primitive is drawn with +OnOffDash +or +DoubleDash +line-style unclipped at position [x,y] and again at position +[x+dx,y+dy], then a point [x1,y1] is included in a dash in the first +instance if and only if the point [x1+dx,y1+dy] is included in the dash in +the second instance. In addition, the effective set of points comprising a +dash cannot be affected by clipping. A point is included in a clipped dash +if and only if the point lies inside the clipping region and the point +would be included in the dash when drawn unclipped. + + +
+
+ SetClipRectangles + SetClipRectangles + + + + + + + + +gc: GCONTEXT + + + + +clip-x-origin, clip-y-origin: INT16 + + + + +rectangles: LISTofRECTANGLE + + + + +ordering: +{ UnSorted, +YSorted, +YXSorted, +YXBanded} + + + + + + +Errors: +Alloc, +GContext, +Match, +Value + + + + + + + + + +This request changes clip-mask in gc to the specified list of rectangles +and sets the clip origin. +Output will be clipped to remain contained within the rectangles. +The clip origin is interpreted relative to the origin of +whatever destination drawable is specified in a graphics request. +The rectangle coordinates are interpreted relative to the clip origin. +The rectangles should be nonintersecting, or graphics results will be +undefined. +Note that the list of rectangles can be empty, +which effectively disables output. +This is the opposite of passing +None +as the clip-mask in +CreateGC +and +ChangeGC. + + +If known by the client, +ordering relations on the rectangles can be specified with the ordering +argument. +This may provide faster operation by the server. +If an incorrect ordering is specified, +the server may generate a +Match +error, but it is not required to do so. +If no error is generated, +the graphics results are undefined. +UnSorted +means that the rectangles are in arbitrary order. +YSorted +means that the rectangles are nondecreasing in their Y origin. +YXSorted +additionally constrains +YSorted +order in that all rectangles with an equal Y origin are +nondecreasing in their X origin. +YXBanded +additionally constrains +YXSorted +by requiring that, for every possible Y scanline, +all rectangles that include that scanline have identical Y origins and Y +extents. + + +
+
+ FreeGC + FreeGC + + + + + + + + +gc: GCONTEXT + + + + + + +Errors: +GContext + + + + + + + + + +This request deletes the association between the resource ID and the gcontext +and destroys the gcontext. + + +
+
+ ClearArea + ClearArea + Background + + + + + + + +window: WINDOW + + + + +x, y: INT16 + + + + +width, height: CARD16 + + + + +exposures: BOOL + + + + + + +Errors: +Match, +Value, +Window + + + + + + + + + +The x and y coordinates are relative to the window's origin +and specify the upper-left corner of the rectangle. +If width is zero, +it is replaced with the current width of the window minus x. +If height is zero, +it is replaced with the current height of the window minus y. +If the window has a defined background tile, +the rectangle is tiled with a plane-mask of all ones and function of +Copy +and a subwindow-mode of +ClipByChildren. +If the window has background +None, +the contents of the window are not changed. +In either case, +if exposures is +True, +then one or more exposure events are generated for regions of the rectangle +that are either visible or are being retained in a backing store. + + +It is a +Match +error to use an +InputOnly +window in this request. + + +
+
+ CopyArea + CopyArea + + + + + + + + +src-drawable, dst-drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +src-x, src-y: INT16 + + + + +width, height: CARD16 + + + + +dst-x, dst-y: INT16 + + + + + + +Errors: +Drawable, +GContext, +Match + + + + + + + + + +This request combines the specified rectangle of src-drawable with the +specified rectangle of dst-drawable. +The src-x and src-y coordinates are relative to src-drawable's origin. +The dst-x and dst-y are relative to dst-drawable's origin, +each pair specifying the upper-left corner of the rectangle. +The src-drawable must have the same root and the same depth +as dst-drawable (or a +Match +error results). + + +If regions of the source rectangle are obscured and have not been retained +in backing store +or if regions outside the boundaries of the source drawable are specified, +then those regions are not copied, +but the following occurs on all corresponding destination regions that are +either visible or are retained in backing-store. +If the dst-drawable is a window with a background other than +None, +these corresponding destination regions are tiled +(with plane-mask of all ones and function +Copy) +with that background. +Regardless of tiling and whether the destination is a window or a pixmap, +if graphics-exposures in gc is +True, +then +GraphicsExposure +events for all corresponding destination regions are generated. + + +If graphics-exposures is +True +but no +GraphicsExposure +events are generated, +then a +NoExposure +event is generated. + + +GC components: function, plane-mask, subwindow-mode, +graphics-exposures, clip-x-origin, clip-y-origin, clip-mask + + +
+
+ CopyPlane + CopyPlane + + + + + + + + +src-drawable, dst-drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +src-x, src-y: INT16 + + + + +width, height: CARD16 + + + + +dst-x, dst-y: INT16 + + + + +bit-plane: CARD32 + + + + + + +Errors: +Drawable, +GContext, +Match, +Value + + + + + + + + + +The src-drawable must have the same root as dst-drawable (or a +Match +error results), but it need not have the same depth. +The bit-plane must have exactly one bit set to 1 and the value of bit-plane +must be less than %2 sup n% where n is the depth of src-drawable (or a +Value +error results). +Effectively, a pixmap of the same depth as dst-drawable and with size specified +by the source region is formed using the foreground/background pixels in gc +(foreground everywhere the bit-plane in src-drawable contains a bit set to 1, +background everywhere the bit-plane contains a bit set to 0), +and the equivalent of a +CopyArea +is performed, with all the same exposure semantics. +This can also be thought of as using the specified region of the source +bit-plane as a stipple with a fill-style of +OpaqueStippled +for filling a rectangular area of the destination. + + +GC components: function, plane-mask, foreground, background, +subwindow-mode, graphics-exposures, clip-x-origin, clip-y-origin, +clip-mask + + +
+
+ PolyPoint + PolyPoint + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +coordinate-mode: +{ Origin, +Previous} + + + + +points: LISTofPOINT + + + + + + +Errors: +Drawable, +GContext, +Match, +Value + + + + + + + + + +This request combines the foreground pixel in gc with the pixel +at each point in the drawable. +The points are drawn in the order listed. + + +The first point is always relative to the drawable's origin. +The rest are relative either to that origin or the previous point, +depending on the coordinate-mode. + + +GC components: function, plane-mask, foreground, subwindow-mode, +clip-x-origin, clip-y-origin, clip-mask + + +
+
+ PolyLine + PolyLine + Linedrawing + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +coordinate-mode: +{ Origin, +Previous} + + + + +points: LISTofPOINT + + + + + + +Errors: +Drawable, +GContext, +Match, +Value + + + + + + + + + +This request draws lines between each pair of points (point[i], point[i+1]). +The lines are drawn in the order listed. +The lines join correctly at all intermediate points, +and if the first and last points coincide, +the first and last lines also join correctly. + + +For any given line, +no pixel is drawn more than once. +If thin (zero line-width) lines intersect, +the intersecting pixels are drawn multiple times. +If wide lines intersect, +the intersecting pixels are drawn only once, as though the entire +PolyLine +were a single filled shape. + + +The first point is always relative to the drawable's origin. +The rest are relative either to that origin or the previous point, +depending on the coordinate-mode. + + +When either of the two lines involved in a +Bevel +join is neither vertical +nor horizontal, then the slope and position of the line segment defining +the bevel join edge is implementation dependent. However, the computation +of the slope and distance (relative to the join point) only depends on +the line width and the slopes of the two lines. + + +GC components: function, plane-mask, line-width, line-style, +cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, +clip-y-origin, clip-mask + + +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, dashes + + +
+
+ PolySegment + PolySegment + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +segments: LISTofSEGMENT + + + + + + +where: + + + + + + +SEGMENT: [x1, y1, x2, y2: INT16] + + + + + + +Errors: +Drawable, +GContext, +Match + + + + + + + + + +For each segment, +this request draws a line between [x1, y1] and [x2, y2]. +The lines are drawn in the order listed. +No joining is performed at coincident endpoints. +For any given line, +no pixel is drawn more than once. +If lines intersect, +the intersecting pixels are drawn multiple times. + + +GC components: function, plane-mask, line-width, line-style, +cap-style, fill-style, subwindow-mode, clip-x-origin, clip-y-origin, +clip-mask + + +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, dashes + + +
+
+ PolyRectangle + PolyRectangle + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +rectangles: LISTofRECTANGLE + + + + + + +Errors: +Drawable, +GContext, +Match + + + + + + + + + +This request draws the outlines of the specified rectangles, as if a five-point +PolyLine +were specified for each rectangle: + + + + [x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y] + + + +The x and y coordinates of each rectangle are relative to the drawable's origin +and define the upper-left corner of the rectangle. + + +The rectangles are drawn in the order listed. +For any given rectangle, +no pixel is drawn more than once. +If rectangles intersect, +the intersecting pixels are drawn multiple times. + + +GC components: function, plane-mask, line-width, line-style, +cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, +clip-y-origin, clip-mask + + +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, dashes + + +
+
+ PolyArc + PolyArc + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +arcs: LISTofARC + + + + + + +Errors: +Drawable, +GContext, +Match + + + + + + + + + +This request draws circular or elliptical arcs. +Each arc is specified by a rectangle and two angles. +The angles are signed integers in degrees scaled by 64, +with positive indicating counterclockwise motion and +negative indicating clockwise motion. +The start of the arc is specified by angle1 relative to the three-o'clock +position from the center of the rectangle, +and the path and extent of the arc is specified by angle2 relative to the +start of the arc. +If the magnitude of angle2 is greater than 360 degrees, +it is truncated to 360 degrees. +The x and y coordinates of the rectangle are relative to the origin of +the drawable. +For an arc specified as [x,y,w,h,a1,a2], +the origin of the major and minor axes is at [x+(w/2),y+(h/2)], +and the infinitely thin path describing the entire circle/ellipse intersects +the horizontal axis at [x,y+(h/2)] and [x+w,y+(h/2)] and intersects the +vertical axis at [x+(w/2),y] and [x+(w/2),y+h]. +These coordinates are not necessarily integral; that is, +they are not truncated to discrete coordinates. + + +For a wide line with line-width lw, the ideal bounding outlines for filling +are given by the two infinitely thin paths consisting of all points whose +perpendicular distance from a tangent to the path of the circle/ellipse is +equal to lw/2 (which may be a fractional value). When the width and height +of the arc are not equal and both are nonzero, then the actual bounding +outlines are implementation dependent. However, the computation of the +shape and position of the bounding outlines (relative to the center of the +arc) only depends on the width and height of the arc and the +line-width. + + +The cap-style is applied the same as for a line corresponding to the +tangent of the circle/ellipse at the endpoint. When the angle of an arc +face is not an integral multiple of 90 degrees, and the width and height of +the arc are both are nonzero, then the shape and position of the cap at +that face is implementation dependent. However, for a +Butt +cap, the face +is defined by a straight line, and the computation of the position +(relative to the center of the arc) and the slope of the line only +depends on the width and height of the arc and the angle of the arc face. +For other cap styles, the computation of the position (relative to the +center of the arc) and the shape of the cap only depends on the width +and height of the arc, the line-width, the angle of the arc face, and the +direction (clockwise or counter clockwise) of the arc from the endpoint. + + +The join-style is applied the same as for two lines corresponding to the +tangents of the circles/ellipses at the join point. When the width and +height of both arcs are nonzero, and the angle of either arc face is not an +integral multiple of 90 degrees, then the shape of the join is +implementation dependent. However, the computation of the shape only +depends on the width and height of each arc, the line-width, the angles of +the two arc faces, the direction (clockwise or counter clockwise) of the +arcs from the join point, and the relative orientation of the two arc +center points. + + +For an arc specified as [x,y,w,h,a1,a2], +the angles must be specified in the effectively skewed coordinate system of +the ellipse (for a circle, the angles and coordinate systems are identical). +The relationship between these angles and angles expressed in the normal +coordinate system of the screen (as measured with a protractor) is as +follows: + + skewed-angle = atan(tan(normal-angle) * w/h) + adjust + + + +The skewed-angle and normal-angle are expressed in radians (rather +than in degrees scaled by 64) in the range [0,2*PI). +The atan returns a value in the range [-PI/2,PI/2]. +The adjust is: + + + + + + + + 0 + for normal-angle in the range [0,PI/2) + + + PI + for normal-angle in the range [PI/2,(3*PI)/2) + + + 2*PI + for normal-angle in the range [(3*PI)/2,2*PI) + + + + + + +The arcs are drawn in the order listed. +If the last point in one arc coincides with the first point in the following +arc, +the two arcs will join correctly. +If the first point in the first arc coincides with the last point +in the last arc, +the two arcs will join correctly. +For any given arc, +no pixel is drawn more than once. +If two arcs join correctly and the line-width is greater than zero +and the arcs intersect, +no pixel is drawn more than once. +Otherwise, the intersecting pixels of intersecting arcs are drawn multiple +times. +Specifying an arc with one endpoint and a clockwise extent draws the +same pixels as specifying the other endpoint and an equivalent +counterclockwise extent, except as it affects joins. + + +By specifying one axis to be zero, +a horizontal or vertical line can be drawn. + + +Angles are computed based solely on the coordinate system, +ignoring the aspect ratio. + + +GC components: function, plane-mask, line-width, line-style, +cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, +clip-y-origin, clip-mask + + +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, dashes + + +
+
+ FillPoly + FillPoly + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +shape: +{ Complex, +Nonconvex, +Convex} + + + + +coordinate-mode: +{ Origin, +Previous} + + + + +points: LISTofPOINT + + + + + + +Errors: +Drawable, +GContext, +Match, +Value + + + + + + + + + +This request fills the region closed by the specified path. +The path is closed automatically if the last point in the list does not +coincide with the first point. +No pixel of the region is drawn more than once. + + +The first point is always relative to the drawable's origin. +The rest are relative either to that origin or the previous point, +depending on the coordinate-mode. + + +The shape parameter may be used by the server to improve performance. +Complex +means the path may self-intersect. +Contiguous coincident points in the path are not treated +as self-intersection. + + +Nonconvex +means the path does not self-intersect, +but the shape is not wholly convex. +If known by the client, +specifying +Nonconvex +over +Complex +may improve performance. +If +Nonconvex +is specified for a self-intersecting path, +the graphics results are undefined. + + +Convex +means that for every pair of points inside the polygon, +the line segment connecting them does not intersect the path. +If known by the client, +specifying +Convex +can improve performance. +If +Convex +is specified for a path that is not convex, +the graphics results are undefined. + + +GC components: function, plane-mask, fill-style, fill-rule, +subwindow-mode, clip-x-origin, clip-y-origin, clip-mask + + +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin + + +
+
+ PolyFillRectangle + PolyFillRectangle + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +rectangles: LISTofRECTANGLE + + + + + + +Errors: +Drawable, +GContext, +Match + + + + + + + + + +This request fills the specified rectangles, as if a four-point +FillPoly +were specified for each rectangle: + + [x,y] [x+width,y] [x+width,y+height] [x,y+height] + + + +The x and y coordinates of each rectangle are relative to the drawable's origin +and define the upper-left corner of the rectangle. + + +The rectangles are drawn in the order listed. +For any given rectangle, +no pixel is drawn more than once. +If rectangles intersect, +the intersecting pixels are drawn multiple times. + + +GC components: function, plane-mask, fill-style, subwindow-mode, +clip-x-origin, clip-y-origin, clip-mask + + +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin + + +
+
+ PolyFillArc + PolyFillArc + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +arcs: LISTofARC + + + + + + +Errors: +Drawable, +GContext, +Match + + + + + + + + + +For each arc, +this request fills the region closed by the infinitely thin path +described by the specified arc and one or two line segments, +depending on the arc-mode. +For +Chord, +the single line segment joining the endpoints of the arc is used. +For +PieSlice, +the two line segments joining the endpoints of the arc with the center point +are used. + + +For an arc specified as [x,y,w,h,a1,a2], the origin of the major and minor +axes is at [x+(w/2),y+(h/2)], and the infinitely thin path describing the +entire circle/ellipse intersects the horizontal axis at [x,y+(h/2)] and +[x+w,y+(h/2)] and intersects the vertical axis at [x+(w/2),y] and +[x+(w/2),y+h]. These coordinates are not necessarily integral; that is, +they are not truncated to discrete coordinates. + + +The arc angles are interpreted as specified in the +PolyArc +request. When +the angle of an arc face is not an integral multiple of 90 degrees, then +the precise endpoint on the arc is implementation dependent. However, for +Chord +arc-mode, the computation of the pair of endpoints (relative to the +center of the arc) only depends on the width and height of the arc and +the angles of the two arc faces. For +PieSlice +arc-mode, the computation of +an endpoint only depends on the angle of the arc face for that +endpoint and the ratio of the arc width to arc height. + + +The arcs are filled in the order listed. +For any given arc, +no pixel is drawn more than once. +If regions intersect, +the intersecting pixels are drawn multiple times. + + +GC components: function, plane-mask, fill-style, arc-mode, +subwindow-mode, clip-x-origin, clip-y-origin, clip-mask + + +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin + + +
+
+ PutImage + PutImage + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +depth: CARD8 + + + + +width, height: CARD16 + + + + +dst-x, dst-y: INT16 + + + + +left-pad: CARD8 + + + + +format: +{ Bitmap, +XYPixmap, +ZPixmap} + + + + +data: LISTofBYTE + + + + + + +Errors: +Drawable, +GContext, +Match, +Value + + + + + + + + + +This request combines an image with a rectangle of the drawable. +The dst-x and dst-y coordinates are relative to the drawable's origin. + + +If +Bitmap +format is used, +then depth must be one (or a +Match +error results), and the image must be in XY format. +The foreground pixel in gc defines the source for bits set to 1 in the image, +and the background pixel defines the source for the bits set to 0. + + +For +XYPixmap +and +ZPixmap, +the depth must match the depth of the drawable (or a +Match +error results). +For +XYPixmap, +the image must be sent in XY format. +For +ZPixmap, +the image must be sent in the Z format defined for the given depth. + + +The left-pad must be zero for +ZPixmap +format (or a +Match +error results). +For +Bitmap +and +XYPixmap +format, +left-pad must be less than bitmap-scanline-pad as given in the server +connection setup information (or a +Match +error results). +The first left-pad bits in every scanline are to be ignored by the server. +The actual image begins that many bits into the data. +The width argument defines the width of the actual image +and does not include left-pad. + + +GC components: function, plane-mask, subwindow-mode, clip-x-origin, +clip-y-origin, clip-mask + + +GC mode-dependent components: foreground, background + + +
+
+ GetImage + GetImage + + + + + + + + +drawable: DRAWABLE + + + + +x, y: INT16 + + + + +width, height: CARD16 + + + + +plane-mask: CARD32 + + + + +format: +{ XYPixmap, +ZPixmap} + + + + + + ▶ + + + + + +depth: CARD8 + + + + +visual: VISUALID or +None + + + + +data: LISTofBYTE + + + + + + +Errors: +Drawable, +Match, +Value + + + + + + + + + +This request returns the contents of the given rectangle of the drawable in the +given format. +The x and y coordinates are relative to the drawable's origin +and define the upper-left corner of the rectangle. +If +XYPixmap +is specified, +only the bit planes specified in plane-mask are transmitted, +with the planes appearing from most significant to least significant +in bit order. +If +ZPixmap +is specified, then bits in all planes not specified in plane-mask are +transmitted as zero. +Range checking is not performed on plane-mask; +extraneous bits are simply ignored. +The returned depth is as specified when the drawable was created +and is the same as a depth component in a FORMAT structure (in the connection +setup), not a bits-per-pixel component. +If the drawable is a window, +its visual type is returned. +If the drawable is a pixmap, +the visual is +None. + + +If the drawable is a pixmap, +then the given rectangle must be wholly contained within the pixmap (or a +Match +error results). +If the drawable is a window, +the window must be viewable, +and it must be the case that, +if there were no inferiors or overlapping windows, +the specified rectangle of the window would be fully visible on the screen +and wholly contained within the outside edges of the window (or a +Match +error results). +Note that the borders of the window can be included and read with this request. +If the window has a backing store, +then the backing-store contents are returned for regions of the window +that are obscured by noninferior windows; +otherwise, the returned contents of such obscured regions are undefined. +Also undefined are the returned contents of visible +regions of inferiors of different depth than the specified window. +The pointer cursor image is not included in the contents returned. + + +This request is not general-purpose in the same sense as other +graphics-related requests. +It is intended specifically for rudimentary hardcopy support. + + +
+
+ PolyText8 + PolyText8 + + + + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +x, y: INT16 + + + + +items: LISTofTEXTITEM8 + + + + + + +where: + + + + +TEXTITEM8: + + +TEXTELT8 or FONT + + + + +TEXTELT8: + + +[delta: INT8 + + + + +string: STRING8] + + + + + + +Errors: +Drawable, +Font, +GContext, +Match + + + + + + + + + +The x and y coordinates are relative to the drawable's origin +and specify the baseline starting position (the initial character origin). +Each text item is processed in turn. +A font item causes the font to be stored in gc +and to be used for subsequent text. +Switching among fonts does not affect the next character origin. +A text element delta specifies an additional change in the position +along the x axis before the string is drawn; +the delta is always added to the character origin. +Each character image, as defined by the font in gc, +is treated as an additional mask for a fill operation on the drawable. + + +All contained FONTs are always transmitted most significant byte first. + + +If a +Font +error is generated for an item, +the previous items may have been drawn. + + +For fonts defined with 2-byte matrix indexing, +each STRING8 byte is interpreted as a byte2 value of a CHAR2B with a byte1 +value of zero. + + +GC components: function, plane-mask, fill-style, font, +subwindow-mode, clip-x-origin, clip-y-origin, clip-mask + + +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin + + +
+
+ PolyText16 + PolyText16 + + + + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +x, y: INT16 + + + + +items: LISTofTEXTITEM16 + + + + + + +where: + + + + +TEXTITEM16: + + +TEXTELT16 or FONT + + + + +TEXTELT16: + + +[delta: INT8 + + + + +string: STRING16] + + + + + + +Errors: +Drawable, +Font, +GContext, +Match + + + + + + + + + +This request is similar to +PolyText8, +except 2-byte (or 16-bit) characters are used. +For fonts defined with linear indexing rather than 2-byte matrix indexing, +the server will interpret each CHAR2B as a 16-bit number that +has been transmitted most significant byte first (that is, byte1 of the +CHAR2B is taken as the most significant byte). + + +
+
+ ImageText8 + ImageText8 + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +x, y: INT16 + + + + +string: STRING8 + + + + + + +Errors: +Drawable, +GContext, +Match + + + + + + + + + +The x and y coordinates are relative to the drawable's origin +and specify the baseline starting position (the initial character origin). +The effect is first to fill a destination rectangle with the background +pixel defined in gc and then to paint the text with the foreground pixel. +The upper-left corner of the filled rectangle is at: + + [x, y - font-ascent] + + + +the width is: + + overall-width + + + +and the height is: + + font-ascent + font-descent + + + +The overall-width, font-ascent, and font-descent are as +they would be returned by a +QueryTextExtents +call using gc and string. + + +The function and fill-style defined in gc are ignored for this request. +The effective function is +Copy, +and the effective fill-style +Solid. + + +For fonts defined with 2-byte matrix indexing, +each STRING8 byte is interpreted as a byte2 value of a CHAR2B with a byte1 +value of zero. + + +GC components: plane-mask, foreground, background, font, +subwindow-mode, clip-x-origin, clip-y-origin, clip-mask + + +
+
+ ImageText16 + ImageText16 + + + + + + + + +drawable: DRAWABLE + + + + +gc: GCONTEXT + + + + +x, y: INT16 + + + + +string: STRING16 + + + + + + +Errors: +Drawable, +GContext, +Match + + + + + + + + + +This request is similar to +ImageText8, +except 2-byte (or 16-bit) characters are used. +For fonts defined with linear indexing rather than 2-byte matrix indexing, +the server will interpret each CHAR2B as a 16-bit number that +has been transmitted most significant byte first (that is, byte1 of the +CHAR2B is taken as the most significant byte). + + +
+
+ CreateColormap + CreateColormap + Colormap + + + + + + + + +mid: COLORMAP + + + + +visual: VISUALID + + + + +window: WINDOW + + + + +alloc: +{ None, +All} + + + + + + +Errors: +Alloc, +IDChoice, +Match, +Value, +Window + + + + + + + + + +This request creates a colormap of the specified visual type for the screen +on which the window resides and associates the identifier mid with it. +The visual type must be one supported by the screen (or a +Match +error results). +The initial values of the colormap entries are undefined for classes +GrayScale, +PseudoColor, +and +DirectColor. +For +StaticGray, +StaticColor, +and +TrueColor, +the entries will have defined values, +but those values are specific to the visual and are not defined +by the core protocol. +For +StaticGray, +StaticColor, +and +TrueColor, +alloc must be specified as +None +(or a +Match +error results). +For the other classes, if alloc is +None, +the colormap initially has no allocated entries, +and clients can allocate entries. + + +If alloc is +All, +then the entire colormap is allocated writable. +The initial values of all allocated entries are undefined. +For +GrayScale +and +PseudoColor, +the effect is as if an +AllocColorCells +request returned all pixel values from zero to N - 1, +where N is the colormap-entries value in the specified visual. +For +DirectColor, +the effect is as if an +AllocColorPlanes +request returned a pixel value of zero and red-mask, +green-mask, and blue-mask values containing the same bits as the +corresponding masks in the specified visual. +However, +in all cases, none of these entries can be freed with +FreeColors. + + +
+
+ FreeColormap + FreeColormap + + + + + + + + +cmap: COLORMAP + + + + + + +Errors: +Colormap + + + + + + + + + +This request deletes the association between the resource ID and the colormap +and frees the colormap storage. +If the colormap is an installed map for a screen, +it is uninstalled (see +UninstallColormap +request). +If the colormap is defined as the colormap for a window (by means of +CreateWindow +or +ChangeWindowAttributes), +the colormap for the window is changed to +None, +and a +ColormapNotify +event is generated. +The protocol does not define the colors displayed for a window with a colormap of +None. + + +This request has no effect on a default colormap for a screen. + + +
+
+ CopyColormapAndFree + CopyColormapAndFree + + + + + + + + +mid, src-cmap: COLORMAP + + + + + + +Errors: +Alloc, +Colormap, +IDChoice + + + + + + + + + +This request creates a colormap of the same visual type +and for the same screen as src-cmap, +and it associates identifier mid with it. +It also moves all of the client's existing allocations from src-cmap +to the new colormap with their color values intact +and their read-only or writable characteristics intact, +and it frees those entries in src-cmap. +Color values in other entries in the new colormap are undefined. +If src-cmap was created by the client with alloc +All +(see +CreateColormap +request), +then the new colormap is also created with alloc +All, +all color values for all entries are copied from src-cmap, +and then all entries in src-cmap are freed. +If src-cmap was not created by the client with alloc +All, +then the allocations to be moved are all those pixels and planes that have +been allocated by the client using either +AllocColor, +AllocNamedColor, +AllocColorCells, +or +AllocColorPlanes +and that have not been freed since they were allocated. + + +
+
+ InstallColormap + InstallColormap + + + + + + + + +cmap: COLORMAP + + + + + + +Errors: +Colormap + + + + + + + + + +This request makes this colormap an installed map for its screen. +All windows associated with this colormap immediately display with true colors. +As a side effect, +additional colormaps might be implicitly installed +or uninstalled by the server. +Which other colormaps get installed or uninstalled is server-dependent +except that the required list must remain installed. + + +If cmap is not already an installed map, a +ColormapNotify +event is generated on every window having cmap as an attribute. +In addition, +for every other colormap that is installed or uninstalled as a result +of the request, a +ColormapNotify +event is generated on every window having that colormap as an attribute. + + +At any time, there is a subset of the installed maps that are viewed as an +ordered list and are called the required list. +The length of the required list is at most M, +where M is the min-installed-maps specified for the screen in the +connection setup. +The required list is maintained as follows. +When a colormap is an explicit argument to +InstallColormap, +it is added to the head of the list; the list is truncated at the +tail, if necessary, to keep the length of the list to at most M. +When a colormap is an explicit argument to +UninstallColormap +and it is in the required list, it is removed from the list. +A colormap is not added to the required list when it is installed implicitly +by the server, and the server cannot implicitly uninstall a colormap that is +in the required list. + + +Initially the default colormap for a screen is installed (but is not in +the required list). + + +
+
+ UninstallColormap + UninstallColormap + + + + + + + + +cmap: COLORMAP + + + + + + +Errors: +Colormap + + + + + + + + + +If cmap is on the required list for its screen (see +InstallColormap +request), +it is removed from the list. +As a side effect, +cmap might be uninstalled, +and additional colormaps might be implicitly installed or uninstalled. +Which colormaps get installed or uninstalled is server-dependent +except that the required list must remain installed. + + +If cmap becomes uninstalled, a +ColormapNotify +event is generated on every window having cmap as an attribute. +In addition, +for every other colormap that is installed or uninstalled as a result of +the request, a +ColormapNotify +event is generated on every window having that colormap as an attribute. + + +
+
+ ListInstalledColormaps + ListInstalledColormaps + + + + + + + + +window: WINDOW + + + + + + ▶ + + + + + +cmaps: LISTofCOLORMAP + + + + + + +Errors: +Window + + + + + + + + + +This request returns a list of the currently installed colormaps for the +screen of the specified window. +The order of colormaps is not significant, +and there is no explicit indication of the required list (see +InstallColormap +request). + + +
+
+ AllocColor + AllocColor + + + + + + + + +cmap: COLORMAP + + + + +red, green, blue: CARD16 + + + + + + ▶ + + + + + +pixel: CARD32 + + + + +red, green, blue: CARD16 + + + + + + +Errors: +Alloc, +Colormap + + + + + + + + + +This request allocates a read-only colormap entry corresponding to the closest +RGB values provided by the hardware. +It also returns the pixel and the RGB values actually used. +Multiple clients requesting the same effective RGB values can be assigned +the same read-only entry, allowing entries to be shared. + + +
+
+ AllocNamedColor + AllocNamedColor + + + + + + + + +cmap: COLORMAP + + + + +name: STRING8 + + + + + + ▶ + + + + + +pixel: CARD32 + + + + +exact-red, exact-green, exact-blue: CARD16 + + + + +visual-red, visual-green, visual-blue: CARD16 + + + + + + +Errors: +Alloc, +Colormap, +Name + + + + + + + + + +This request looks up the named color with respect to the screen associated +with the colormap. +Then, it does an +AllocColor +on cmap. +The name should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +The exact RGB values specify the true values for the color, +and the visual values specify the values actually used in the colormap. + + +
+
+ AllocColorCells + AllocColorCells + + + + + + + + +cmap: COLORMAP + + + + +colors, planes: CARD16 + + + + +contiguous: BOOL + + + + + + ▶ + + + + + +pixels, masks: LISTofCARD32 + + + + + + +Errors: +Alloc, +Colormap, +Value + + + + + + + + + +The number of colors must be positive, +and the number of planes must be nonnegative (or a +Value +error results). +If C colors and P planes are requested, +then C pixels and P masks are returned. +No mask will have any bits in common with any other mask +or with any of the pixels. +By ORing together masks and pixels, +C*%2 sup P% distinct pixels can be produced; +all of these are allocated writable by the request. +For +GrayScale +or +PseudoColor, +each mask will have exactly one bit set to 1; for +DirectColor, +each will have exactly three bits set to 1. +If contiguous is +True +and if all masks are ORed together, +a single contiguous set of bits will be formed for +GrayScale +or +PseudoColor, +and three contiguous sets of bits (one within each pixel subfield) for +DirectColor. +The RGB values of the allocated entries are undefined. + + +
+
+ AllocColorPlanes + AllocColorPlanes + + + + + + + + +cmap: COLORMAP + + + + +colors, reds, greens, blues: CARD16 + + + + +contiguous: BOOL + + + + + + ▶ + + + + + +pixels: LISTofCARD32 + + + + +red-mask, green-mask, blue-mask: CARD32 + + + + + + +Errors: +Alloc, +Colormap, +Value + + + + + + + + + +The number of colors must be positive, +and the reds, greens, and blues must be nonnegative (or a +Value +error results). +If C colors, R reds, G greens, and B blues are requested, +then C pixels are returned, and the masks have R, G, and B bits set, +respectively. +If contiguous is +True, +then each mask will have a contiguous set of bits. +No mask will have any bits in common with any other mask +or with any of the pixels. +For +DirectColor, +each mask will lie within the corresponding pixel subfield. +By ORing together subsets of masks with pixels, +C*%2 sup R+G+B% distinct pixels can be produced; +all of these are allocated writable by the request. +The initial RGB values of the allocated entries are undefined. +In the colormap, +there are only C*%2 sup R% independent red entries, +C*%2 sup G% independent green entries, +and C*%2 sup B% independent blue entries. +This is true even for +PseudoColor. +When the colormap entry for a pixel value is changed using +StoreColors +or +StoreNamedColor, +the pixel is decomposed according to the masks and the +corresponding independent entries are updated. + + +
+
+ FreeColors + FreeColors + + + + + + + + +cmap: COLORMAP + + + + +pixels: LISTofCARD32 + + + + +plane-mask: CARD32 + + + + + + +Errors: +Access, +Colormap, +Value + + + + + + + + + +The plane-mask should not have any bits in common with any of the +pixels. +The set of all pixels is produced by ORing together subsets of +plane-mask with the pixels. +The request frees all of these pixels that +were allocated by the client (using +AllocColor, +AllocNamedColor, +AllocColorCells, +and +AllocColorPlanes). +Note that freeing an +individual pixel obtained from +AllocColorPlanes +may not actually allow it to be reused until all of its related pixels +are also freed. +Similarly, a read-only entry is not actually freed until it has been +freed by all clients, and if a client allocates the same read-only entry +multiple times, it must free the entry that many times before the +entry is actually freed. + + +All specified pixels that are allocated by the client in cmap are freed, +even if one or more pixels produce an error. +A +Value +error is generated if a specified pixel is not a valid index into cmap. +An +Access +error is generated if a specified pixel is not allocated by the +client (that is, is unallocated or is only allocated by another client) +or if the colormap was created with all entries writable (using an alloc +value of +All +in +CreateColormap). +If more than one pixel is in error, +it is arbitrary as to which pixel is reported. + + +
+
+ StoreColors + StoreColors + + + + + + + + +cmap: COLORMAP + + + + +items: LISTofCOLORITEM + + + + +where: + + + + + + + + + + + + + COLORITEM: + [pixel: CARD32 + + + + +do-red, do-green, do-blue: BOOL + + + + + +red, green, blue: CARD16] + + + + + + + + + + +Errors: +Access, +Colormap, +Value + + + + + + + +This request changes the colormap entries of the specified pixels. +The do-red, do-green, and do-blue fields indicate which components +should actually be changed. +If the colormap is an installed map for its screen, +the changes are visible immediately. + + +All specified pixels that are allocated writable in cmap (by any client) +are changed, even if one or more pixels produce an error. +A +Value +error is generated if a specified pixel is not a valid index into cmap, and an +Access +error is generated if a specified pixel is unallocated or is allocated +read-only. +If more than one pixel is in error, +it is arbitrary as to which pixel is reported. + + +
+
+ StoreNamedColor + StoreNamedColor + + + + + + + + +cmap: COLORMAP + + + + +pixel: CARD32 + + + + +name: STRING8 + + + + +do-red, do-green, do-blue: BOOL + + + + + + +Errors: +Access, +Colormap, +Name, +Value + + + + + + + + + +This request looks up the named color with respect to the screen associated +with cmap and then does a +StoreColors +in cmap. +The name should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +The +Access +and +Value +errors are the same as in +StoreColors. + + +
+
+ QueryColors + QueryColors + + + + + + + + +cmap: COLORMAP + + + + +pixels: LISTofCARD32 + + + + + + ▶ + + + + + +colors: LISTofRGB + + + + + + +where: + + + + + + +RGB: [red, green, blue: CARD16] + + + + + + +Errors: +Colormap, +Value + + + + + + + + + +This request returns the hardware-specific color values stored in cmap for +the specified pixels. +The values returned for an unallocated entry are undefined. +A +Value +error is generated if a pixel is not a valid index into cmap. +If more than one pixel is in error, +it is arbitrary as to which pixel is reported. + + +
+
+ LookupColor + LookupColor + + + + + + + + +cmap: COLORMAP + + + + +name: STRING8 + + + + + + ▶ + + + + + +exact-red, exact-green, exact-blue: CARD16 + + + + +visual-red, visual-green, visual-blue: CARD16 + + + + + + +Errors: +Colormap, +Name + + + + + + + + + +This request looks up the string name of a color with respect to the screen +associated with cmap and returns both the exact color values and +the closest values provided by the hardware with respect to the visual +type of cmap. +The name should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. + + +
+
+ CreateCursor + CreateCursor + Cursor + + + + + + + + +cid: CURSOR + + + + +source: PIXMAP + + + + +mask: PIXMAP or +None + + + + +fore-red, fore-green, fore-blue: CARD16 + + + + +back-red, back-green, back-blue: CARD16 + + + + +x, y: CARD16 + + + + + + +Errors: +Alloc, +IDChoice, +Match, +Pixmap + + + + + + + + + +This request creates a cursor and associates identifier cid with it. +The foreground and background RGB values must be specified, +even if the server only has a +StaticGray +or +GrayScale +screen. +The foreground is used for the bits set to 1 in the source, +and the background is used for the bits set to 0. +Both source and mask (if specified) must have depth one (or a +Match +error results), but they can have any root. +The mask pixmap defines the shape of the cursor. +That is, +the bits set to 1 in the mask define which source pixels will be displayed, +and where the mask has bits set to 0, +the corresponding bits of the source pixmap are ignored. +If no mask is given, +all pixels of the source are displayed. +The mask, if present, must be the same size as the source (or a +Match +error results). +The x and y coordinates define the hotspot relative to the source's origin +and must be a point within the source (or a +Match +error results). + + +The components of the cursor may be transformed arbitrarily to meet +display limitations. + + +The pixmaps can be freed immediately if no further explicit references +to them are to be made. + + +Subsequent drawing in the source or mask pixmap has an undefined effect +on the cursor. +The server might or might not make a copy of the pixmap. + + +
+
+ CreateGlyphCursor + CreateGlyphCursor + + + + + + + + +cid: CURSOR + + + + +source-font: FONT + + + + +mask-font: FONT or +None + + + + +source-char, mask-char: CARD16 + + + + +fore-red, fore-green, fore-blue: CARD16 + + + + +back-red, back-green, back-blue: CARD16 + + + + + + +Errors: +Alloc, +Font, +IDChoice, +Value + + + + + + + + + +This request is similar to +CreateCursor, +except the source and mask bitmaps are obtained from the specified font glyphs. +The source-char must be a defined glyph in source-font, +and if mask-font is given, mask-char must be a defined glyph in mask-font +(or a +Value +error results). +The mask font and character are optional. +The origins of the source and mask (if it is defined) glyphs +are positioned coincidently and define the hotspot. +The source and mask need not have the same bounding box metrics, +and there is no restriction on the placement of the hotspot relative +to the bounding boxes. +If no mask is given, +all pixels of the source are displayed. +Note that source-char and mask-char are CARD16, not CHAR2B. +For 2-byte matrix fonts, +the 16-bit value should be formed with byte1 in the most significant byte +and byte2 in the least significant byte. + + +The components of the cursor may be transformed arbitrarily to meet +display limitations. + + +The fonts can be freed immediately if no further explicit references to +them are to be made. + + +
+
+ FreeCursor + FreeCursor + + + + + + + + +cursor: CURSOR + + + + + + +Errors: +Cursor + + + + + + + + + +This request deletes the association between the resource ID and the cursor. +The cursor storage will be freed when no other resource references it. + + +
+
+ RecolorCursor + RecolorCursor + + + + + + + + +cursor: CURSOR + + + + +fore-red, fore-green, fore-blue: CARD16 + + + + +back-red, back-green, back-blue: CARD16 + + + + + + +Errors: +Cursor + + + + + + + + + +This request changes the color of a cursor. +If the cursor is being displayed on a screen, +the change is visible immediately. + + +
+
+ QueryBestSize + QueryBestSize + + + + + + + + +class: +{ Cursor, +Tile, +Stipple} + + + + +drawable: DRAWABLE + + + + +width, height: CARD16 + + + + + + ▶ + + + + + +width, height: CARD16 + + + + + + +Errors: +Drawable, +Match, +Value + + + + + + + + + +This request returns the best size that is closest to the argument size. +For +Cursor, +this is the largest size that can be fully displayed. +For +Tile, +this is the size that can be tiled fastest. +For +Stipple, +this is the size that can be stippled fastest. + + +For +Cursor, +the drawable indicates the desired screen. +For +Tile +and +Stipple, +the drawable indicates the screen and also possibly the window class and depth. +An +InputOnly +window cannot be used as the drawable for +Tile +or +Stipple +(or a +Match +error results). + + +
+
+ QueryExtension + QueryExtension + Extensionquerying + + + + + + + + +name: STRING8 + + + + + + ▶ + + + + + +present: BOOL + + + + +major-opcode: CARD8 + + + + +first-event: CARD8 + + + + +first-error: CARD8 + + + + + + + + + +This request determines if the named extension is present. +If so, +the major opcode for the extension is returned, if it has one. +Otherwise, zero is returned. +Any minor opcode and the request formats are specific to the extension. +If the extension involves additional event types, +the base event type code is returned. +Otherwise, zero is returned. +The format of the events is specific to the extension. +If the extension involves additional error codes, +the base error code is returned. +Otherwise, zero is returned. +The format of additional data in the errors is specific to the extension. + + +The extension name should use the ISO Latin-1 encoding, +and uppercase and lowercase matter. + + +
+
+ ListExtensions + ListExtensions + Extensionlisting + + + + + + + + ▶ + + + + + +names: LISTofSTRING8 + + + + + + + + + +This request returns a list of all extensions supported by the server. + +
+
+ SetModifierMapping + SetModifierMapping + Modifier keys + + + + + + + + +keycodes-per-modifier: CARD8 + + + + +keycodes: LISTofKEYCODE + + + + + + ▶ + + + + + +status: +{ Success, +Busy, +Failed} + + + + + + +Errors: +Alloc, +Value + + + + + + + + + +This request specifies the keycodes (if any) of the keys to be used as +modifiers. +The number of keycodes in the list must be 8*keycodes-per-modifier (or a +Length +error results). +The keycodes are divided into eight sets, +with each set containing keycodes-per-modifier elements. +The sets are assigned to the modifiers +Shift, +Lock, +Control, +Mod1, +Mod2, +Mod3, +Mod4, +and +Mod5, +in order. +Only nonzero keycode values are used within each set; +zero values are ignored. +All of the nonzero keycodes must be in the range specified by min-keycode +and max-keycode in the connection setup (or a +Value +error results). +The order of keycodes within a set does not matter. +If no nonzero values are specified in a set, +the use of the corresponding modifier is disabled, +and the modifier bit will always be zero. +Otherwise, the modifier bit will be one whenever +at least one of the keys in the corresponding set is in the down +position. + + +A server can impose restrictions on how modifiers can be changed (for example, +if certain keys do not generate up transitions in hardware, +if auto-repeat cannot be disabled on certain keys, +or if multiple keys per modifier are not supported). +The status reply is +Failed +if some such restriction is violated, +and none of the modifiers is changed. + + +If the new nonzero keycodes specified for a modifier differ from those +currently defined and any (current or new) keys for that modifier are +logically in the down state, then the status reply is +Busy, +and none of the modifiers is changed. + + +This request generates a +MappingNotify +event on a +Success +status. + + +
+
+ GetModifierMapping + GetModifierMapping + Modifier keys + + + + + + + + ▶ + + + + + +keycodes-per-modifier: CARD8 + + + + +keycodes: LISTofKEYCODE + + + + + + + + + +This request returns the keycodes of the keys being used as modifiers. +The number of keycodes in the list is 8*keycodes-per-modifier. +The keycodes are divided into eight sets, +with each set containing keycodes-per-modifier elements. +The sets are assigned to the modifiers +Shift, +Lock, +Control, +Mod1, +Mod2, +Mod3, +Mod4, +and +Mod5, +in order. +The keycodes-per-modifier value is chosen arbitrarily by the server; +zeroes are used to fill in unused elements within each set. +If only zero values are given in a set, +the use of the corresponding modifier has been disabled. +The order of keycodes within each set is chosen arbitrarily by the server. + + +
+
+ ChangeKeyboardMapping + ChangeKeyboardMapping + Keysym + + + + + + + + +first-keycode: KEYCODE + + + + +keysyms-per-keycode: CARD8 + + + + +keysyms: LISTofKEYSYM + + + + + + +Errors: +Alloc, +Value + + + + + + + + + +This request defines the symbols for the specified number of keycodes, +starting with the specified keycode. +The symbols for keycodes outside this range remained unchanged. +The number of elements in the keysyms list must be a multiple of +keysyms-per-keycode (or a +Length +error results). +The first-keycode must be greater than or equal to min-keycode as returned +in the connection setup (or a +Value +error results) and: + + first-keycode + (keysyms-length / keysyms-per-keycode) - 1 + + + +must be less than or equal to max-keycode as returned in the connection +setup (or a +Value +error results). +KEYSYM number N (counting from zero) for keycode K has an index +(counting from zero) of: + + (K - first-keycode) * keysyms-per-keycode + N + + + +in keysyms. +The keysyms-per-keycode can be chosen arbitrarily by the client +to be large enough to hold all desired symbols. +A special KEYSYM value of +NoSymbol +should be used to fill in unused elements for individual keycodes. +It is legal for +NoSymbol +to appear in nontrailing positions of the effective list for a keycode. + + +This request generates a +MappingNotify +event. + + +There is no requirement that the server interpret this mapping; +it is merely stored for reading and writing by clients +(see section 5). + + +
+
+ GetKeyboardMapping + GetKeyboardMapping + Keysym + + + + + + + + +first-keycode: KEYCODE + + + + +count: CARD8 + + + + + + ▶ + + + + + +keysyms-per-keycode: CARD8 + + + + +keysyms: LISTofKEYSYM + + + + + + +Errors: +Value + + + + + + + + + +This request returns the symbols for the specified number of keycodes, +starting with the specified keycode. +The first-keycode must be greater than or equal to +min-keycode as returned in the connection setup (or a +Value +error results), and: + + first-keycode + count - 1 + + + +must be less than or equal to max-keycode as returned in the connection setup +(or a +Value +error results). +The number of elements in the keysyms list is: + + count * keysyms-per-keycode + + + +and KEYSYM number N (counting from zero) for keycode K has an index +(counting from zero) of: + + (K - first-keycode) * keysyms-per-keycode + N + + + +in keysyms. +The keysyms-per-keycode value is chosen arbitrarily by the server +to be large enough to report all requested symbols. +A special KEYSYM value of +NoSymbol +is used to fill in unused elements for individual keycodes. + + +
+
+ ChangeKeyboardControl + ChangeKeyboardControl + + + + + + + + +value-mask: BITMASK + + + + +value-list: LISTofVALUE + + + + + +Errors: +Match, +Value + + + + + + + +This request controls various aspects of the keyboard. +The value-mask and value-list specify which controls are to be changed. +The possible values are: + + + + + + + + + + Control + Type + + + + + key-click-percent + INT8 + + + bell-percent + INT8 + + + bell-pitch + INT16 + + + bell-duration + INT16 + + + led + CARD8 + + + led-mode + +{ On, +Off } + + + + key + KEYCODE + + + auto-repeat-mode + +{ On, +Off, +Default } + + + + + + + +The key-click-percent sets the volume for key clicks between 0 (off) and +100 (loud) inclusive, if possible. +Setting to -1 restores the default. +Other negative values generate a +Value +error. + + +The bell-percent sets the base volume for the bell between 0 (off) and 100 +(loud) inclusive, if possible. +Setting to -1 restores the default. +Other negative values generate a +Value +error. + + +The bell-pitch sets the pitch (specified in Hz) of the bell, if possible. +Setting to -1 restores the default. +Other negative values generate a +Value +error. + + +The bell-duration sets the duration of the bell (specified in milliseconds), +if possible. +Setting to -1 restores the default. +Other negative values generate a +Value +error. + + +If both led-mode and led are specified, +then the state of that LED is changed, if possible. +If only led-mode is specified, +then the state of all LEDs are changed, if possible. +At most 32 LEDs, numbered from one, are supported. +No standard interpretation of LEDs is defined. +It is a +Match +error if an led is specified without an led-mode. + + +If both auto-repeat-mode and key are specified, +then the auto-repeat mode of that key is changed, if possible. +If only auto-repeat-mode is specified, +then the global auto-repeat mode for the entire keyboard is changed, +if possible, without affecting the per-key settings. +It is a +Match +error if a key is specified without an auto-repeat-mode. +Each key has an individual mode of whether or not it should auto-repeat +and a default setting for that mode. +In addition, there is a global mode of whether auto-repeat should be +enabled or not and a default setting for that mode. +When the global mode is +On, +keys should obey their individual auto-repeat modes. +When the global mode is +Off, +no keys should auto-repeat. +An auto-repeating key generates alternating +KeyPress +and +KeyRelease +events. +When a key is used as a modifier, +it is desirable for the key not to auto-repeat, +regardless of the auto-repeat setting for that key. + + +A bell generator connected with the console but not directly on the +keyboard is treated as if it were part of the keyboard. + + +The order in which controls are verified and altered is server-dependent. +If an error is generated, +a subset of the controls may have been altered. + + +
+
+ GetKeyboardControl + GetKeyboardControl + + + + + + + + ▶ + + + + + +key-click-percent: CARD8 + + + + +bell-percent: CARD8 + + + + +bell-pitch: CARD16 + + + + +bell-duration: CARD16 + + + + +led-mask: CARD32 + + + + +global-auto-repeat: +{ On, +Off} + + + + +auto-repeats: LISTofCARD8 + + + + + + + + + +This request returns the current control values for the keyboard. +For the LEDs, +the least significant bit of led-mask corresponds to LED one, +and each one bit in led-mask indicates an LED that is lit. +The auto-repeats is a bit vector; +each one bit indicates that auto-repeat is enabled for the corresponding key. +The vector is represented as 32 bytes. +Byte N (from 0) contains the bits for keys 8N to 8N + 7, +with the least significant bit in the byte representing key 8N. + + +
+
+ Bell + Bell + + + + + + + + +percent: INT8 + + + + + + +Errors: +Value + + + + + + + + + +This request rings the bell on the keyboard at a volume relative to the +base volume for the keyboard, if possible. +Percent can range from -100 to 100 inclusive (or a +Value +error results). +The volume at which the bell is rung when percent is nonnegative is: + + base - [(base * percent) / 100] + percent + + + +When percent is negative, it is: + + base + [(base * percent) / 100] + + + +
+
+ SetPointerMapping + SetPointerMapping + + + + + + + + +map: LISTofCARD8 + + + + + + ▶ + + + + + +status: +{ Success, +Busy} + + + + + + +Errors: +Value + + + + + + + + + +This request sets the mapping of the pointer. +Elements of the list are indexed starting from one. +The length of the list must be the same as +GetPointerMapping +would return (or a +Value +error results). +The index is a core button number, +and the element of the list defines the effective number. + + +A zero element disables a button. +Elements are not restricted in value by the number of physical buttons, +but no two elements can have the same nonzero value (or a +Value +error results). + + +If any of the buttons to be altered are logically in the down state, +the status reply is +Busy, +and the mapping is not changed. + + +This request generates a +MappingNotify +event on a +Success +status. + + +
+
+ GetPointerMapping + GetPointerMapping + + + + + + + + ▶ + + + + + +map: LISTofCARD8 + + + + + + + + + +This request returns the current mapping of the pointer. +Elements of the list are indexed starting from one. +The length of the list indicates the number of physical buttons. + + +The nominal mapping for a pointer is the identity mapping: map[i]=i. + + +
+
+ ChangePointerControl + ChangePointerControl + + + + + + + + +do-acceleration, do-threshold: BOOL + + + + +acceleration-numerator, acceleration-denominator: INT16 + + + + +threshold: INT16 + + + + + + +Errors: +Value + + + + + + + + + +This request defines how the pointer moves. +The acceleration is a multiplier for movement expressed as a fraction. +For example, +specifying 3/1 means the pointer moves three times as fast as normal. +The fraction can be rounded arbitrarily by the server. +Acceleration only takes effect if the pointer moves more than threshold +number of pixels at once and only applies to the amount beyond the threshold. +Setting a value to -1 restores the default. +Other negative values generate a +Value +error, as does a zero value for acceleration-denominator. + + +
+
+ GetPointerControl + GetPointerControl + + + + + + + + ▶ + + + + + +acceleration-numerator, acceleration-denominator: CARD16 + + + + +threshold: CARD16 + + + + + + + + + +This request returns the current acceleration and threshold for the pointer. + + +
+
+ SetScreenSaver + SetScreenSaver + + + + + + + + +timeout, interval: INT16 + + + + +prefer-blanking: +{ Yes, +No, +Default} + + + + +allow-exposures: +{ Yes, +No, +Default} + + + + + + +Errors: +Value + + + + + + + + + +The timeout and interval are specified in seconds; +setting a value to -1 restores the default. +Other negative values generate a +Value +error. +If the timeout value is zero, +screen-saver is disabled (but an activated screen-saver is not deactivated). +If the timeout value is nonzero, +screen-saver is enabled. +Once screen-saver is enabled, +if no input from the keyboard or pointer is generated for timeout seconds, +screen-saver is activated. +For each screen, +if blanking is preferred and the hardware supports video blanking, +the screen will simply go blank. +Otherwise, +if either exposures are allowed or the screen can be regenerated without +sending exposure events to clients, +the screen is changed in a server-dependent fashion to avoid phosphor burn. +Otherwise, +the state of the screens does not change, and screen-saver is not activated. +At the next keyboard or pointer input or at the next +ForceScreenSaver +with mode +Reset, +screen-saver is deactivated, and all screen states are restored. + + +If the server-dependent screen-saver method is amenable to periodic change, +interval serves as a hint about how long the change period should be, +with zero hinting that no periodic change should be made. +Examples of ways to change the screen include scrambling the color map +periodically, moving an icon image about the screen periodically, or +tiling the screen with the root window background tile, +randomly reorigined periodically. + + +
+
+ GetScreenSaver + GetScreenSaver + + + + + + + + ▶ + + + + + +timeout, interval: CARD16 + + + + +prefer-blanking: +{ Yes, +No} + + + + +allow-exposures: +{ Yes, +No} + + + + + + + + + +This request returns the current screen-saver control values. + + +
+
+ ForceScreenSaver + ForceScreenSaver + + + + + + + + +mode: +{ Activate, +Reset} + + + + + + +Errors: +Value + + + + + + + + + +If the mode is +Activate +and screen-saver is currently deactivated, +then screen-saver is activated (even if screen-saver has been disabled with +a timeout value of zero). +If the mode is +Reset +and screen-saver is currently enabled, +then screen-saver is deactivated (if it was activated), +and the activation timer is reset to its initial state +as if device input had just been received. + + +
+
+ ChangeHosts + ChangeHosts + + + + + + + + +mode: +{ Insert, +Delete} + + + + +host: HOST + + + + + + +Errors: +Access, +Value + + + + + + + + + +This request adds or removes the specified host from the access control list. +Access control list +When the access control mechanism is enabled and a client attempts to +establish a connection to the server, +the host on which the client resides must be in the access control list, +or the client must have been granted permission by a server-dependent +method, or the server will refuse the connection. + + +The client must reside on the same host as the server and/or have been granted +permission by a server-dependent method to execute this request (or an +Access +error results). + + +An initial access control list can usually be specified, +typically by naming a file that the server reads at startup and reset. + + +The following address families are defined. +TypesHOST +A server is not required to support these families +and may support families not listed here. +Use of an unsupported family, an improper address format, +or an improper address length within a supported family results in a +Value +error. + + +For the Internet family, +the address must be four bytes long. +The address bytes are in standard IP order; +the server performs no automatic swapping on the address bytes. +The Internet family supports IP version 4 addresses only. + + +For the InternetV6 family, the address must be sixteen bytes +long. The address bytes are in standard IP order; the +server performs no automatic swapping on the address bytes. +The InternetV6 family supports IP version 6 addresses only. + + +For the DECnet family, +the server performs no automatic swapping on the address bytes. +A Phase IV address is two bytes long: +the first byte contains the least significant eight bits of the node number, +and the second byte contains the most significant two bits of the node number in +the least significant two bits of the byte and the area in the most +significant six bits of the byte. + + +For the Chaos family, +the address must be two bytes long. +The host number is always the first byte in the address, +and the subnet number is always the second byte. +The server performs no automatic swapping on the address bytes. + + +For the ServerInterpreted family, the address may be of any +length up to 65535 bytes. The address consists of two strings +of ASCII characters, separated by a byte with a value of 0. +The first string represents the type of address, and the second +string contains the address value. Address types and the syntax +for their associated values will be registered via the X.Org Registry. +Implementors who wish to add implementation specific types may register +a unique prefix with the X.Org registry to prevent namespace +collisions. + + +Use of a host address in the ChangeHosts request is deprecated. It is +only useful when a host has a unique, constant address, a requirement +that is increasingly unmet as sites adopt dynamically assigned +addresses, network address translation gateways, IPv6 link local +addresses, and various other technologies. It also assumes all users of +a host share equivalent access rights, and as such has never been +suitable for many multi-user machine environments. Instead, more +secure forms of authentication, such as those based on shared secrets +or public key encryption, are recommended. + + +
+
+ ListHosts + ListHosts + + + + + + + + ▶ + + + + + +mode: +{ Enabled, +Disabled} + + + + +hosts: LISTofHOST + + + + + + + + + +This request returns the hosts on the access control list +and whether use of the list at connection setup is currently +enabled or disabled. + + +Each HOST is padded to a multiple of four bytes. + + +
+
+ SetAccessControl + SetAccessControl + + + + + + + + +mode: +{ Enable, +Disable} + + + + + + +Errors: +Access, +Value + + + + + + + + + +This request enables or disables the use of the access control list +at connection setups. + + +The client must reside on the same host as the server +and/or have been granted permission by a server-dependent method +to execute this request (or an +Access +error results). + + +
+
+ SetCloseDownMode + SetCloseDownMode + + + + + + + + +mode: +{ Destroy, +RetainPermanent, +RetainTemporary} + + + + + + +Errors: +Value + + + + + + + + + +This request defines what will happen to the client's resources +at connection close. +A connection starts in +Destroy +mode. +The meaning of the close-down mode is described +in section 10. + + +
+
+ KillClient + KillClient + + + + + + + + +resource: CARD32 or +AllTemporary + + + + + + +Errors: +Value + + + + + + + + + +If a valid resource is specified, +KillClient +forces a close-down of the client that created the resource. +If the client has already terminated in either +RetainPermanent +or +RetainTemporary +mode, all of the client's resources are destroyed +(see section 10). +If +AllTemporary +is specified, +then the resources of all clients that have terminated in +RetainTemporary +are destroyed. + + +
+
+ NoOperation + NoOperation + +This request has no arguments and no results, +but the request length field +allows the request to be any multiple of four bytes in length. +The bytes contained in the request are uninterpreted by the server. + + +This request can be used in its minimum four byte form as padding where +necessary by client libraries that find it convenient to force requests +to begin on 64-bit boundaries. + +
+ + + +Connection Close + Connectionclosing + + + + +At connection close, +all event selections made by the client are discarded. +If the client has the pointer actively grabbed, an +UngrabPointer +is performed. +If the client has the keyboard actively grabbed, an +UngrabKeyboard +is performed. +All passive grabs by the client are released. +If the client has the server grabbed, an +UngrabServer +is performed. +All selections (see +SetSelectionOwner +request) +owned by the client are disowned. +If close-down mode (see +SetCloseDownMode +request) is +RetainPermanent +or +RetainTemporary, +then all resources (including colormap entries) +allocated by the client are marked as permanent or temporary, +respectively (but this does not prevent other clients from explicitly +destroying them). +If the mode is +Destroy, +all of the client's resources are destroyed. + + +When a client's resources are destroyed, +for each window in the client's save-set, +if the window is an inferior of a window created by the client, +the save-set window is reparented to the closest ancestor such that +the save-set window is not an inferior of a window created by the client. +If the save-set window is unmapped, a +MapWindow +request is performed on it (even if it was not an inferior +of a window created by the client). +The reparenting leaves unchanged the absolute coordinates +(with respect to the root window) of the upper-left outer corner of the +save-set window. +After save-set processing, +all windows created by the client are destroyed. +For each nonwindow resource created by the client, +the appropriate +Free +request is performed. +All colors and colormap entries allocated by the client are freed. + + +A server goes through a cycle of having no connections and having some +connections. +At every transition to the state of having no connections +as a result of a connection closing with a +Destroy +close-down mode, +the server resets its state as if it had just been started. +This starts by destroying all lingering resources from clients +that have terminated in +RetainPermanent +or +RetainTemporary +mode. +It additionally includes deleting all but the predefined atom identifiers, +deleting all properties on all root windows, resetting all device maps and +attributes (key click, bell volume, acceleration), resetting the access +control list, restoring the standard root tiles and cursors, restoring +the default font path, and restoring the input focus to state +PointerRoot. + + +Note that closing a connection with a close-down mode of +RetainPermanent +or +RetainTemporary +will not cause the server to reset. + + + + +Events + + + + +Event +When a button press is processed with the pointer in some window W +and no active pointer grab is in progress, +the ancestors of W are searched from the root down, +looking for a passive grab to activate. +If no matching passive grab on the button exists, +then an active grab is started automatically for the client receiving the event, +and the last-pointer-grab time is set to the current server time. +The effect is essentially equivalent to a +GrabButton +with arguments: + + + + + + + + + + Argument + Value + + + + + event-window + Event window + + + event-mask + +Client's selected pointer events on the event window + + + + pointer-mode and keyboard-mode + +Asynchronous + + + + owner-events + +True +if the client has +OwnerGrabButton +selected on the event window, otherwise +False + + + + confine-to + +None + + + + cursor + +None + + + + + + + + + +The grab is terminated automatically when the logical state of the pointer +has all buttons released. +UngrabPointer +and +ChangeActivePointerGrab +can both be used to modify the active grab. + + + +
+ Input Device events + Input deviceevents + + + + + + + + +KeyPress +KeyPress + + + + +KeyRelease +KeyRelease + + + + +ButtonPress +ButtonPress + + + + +ButtonRelease +ButtonRelease + + + + +MotionNotify +MotionNotify + + + + + +root, event: WINDOW + + + + +child: WINDOW or +None + + + + +same-screen: BOOL + + + + +root-x, root-y, event-x, event-y: INT16 + + + + +detail: <see below> + + + + +state: SETofKEYBUTMASK + + + + +time: TIMESTAMP + + + + + + + + + +These events are generated either when a key or button logically changes state +or when the pointer logically moves. +The generation of these logical changes may lag the physical changes +if device event processing is frozen. +Note that +KeyPress +and +KeyRelease +are generated for all keys, even those mapped to modifier bits. + +The source of the event is the window the pointer is in. + +Eventsource +The window the event is reported with respect to is called the event window. +The event window is found by starting with the source window and +looking up the hierarchy for the first window on which any client has selected +interest in the event (provided no intervening window prohibits event +generation by including the event type in its do-not-propagate-mask). +The actual window used for reporting can be modified by active grabs and, +in the case of keyboard events, can be modified by the focus window. + + +The root is the root window of the source window, +and root-x and root-y are the pointer coordinates relative to root's origin +at the time of the event. +Event is the event window. +If the event window is on the same screen as root, +then event-x and event-y are the pointer coordinates relative to the +event window's origin. +Otherwise, event-x and event-y are zero. +If the source window is an inferior of the event window, +then child is set to the child of the event window that is an +ancestor of (or is) the source window. +Otherwise, it is set to +None. +The state component gives the logical state of the buttons and modifier keys +just before the event. +The detail component type varies with the event type: + + + + + + + + + + Event + Component + + + + + +KeyPress, +KeyRelease + + KEYCODE + + + +ButtonPress, +ButtonRelease + + BUTTON + + + +MotionNotify + + +{ Normal +Hint } + + + + + + + +MotionNotify +events are only generated when the motion begins and ends in the window. +The granularity of motion events is not guaranteed, +but a client selecting for motion events is guaranteed to get at least one +event when the pointer moves and comes to rest. +Selecting +PointerMotion +receives events independent of the state of the pointer buttons. +By selecting some subset of +Button[1-5]Motion +instead, +MotionNotify +events will only be received when one or more of the +specified buttons are pressed. +By selecting +ButtonMotion, +MotionNotify +events will be received only when at least one button is pressed. +The events are always of type +MotionNotify, +independent of the selection. +If +PointerMotionHint +is selected, +the server is free to send only one +MotionNotify +event (with detail +Hint) +to the client for the event window until +either the key or button state changes, +the pointer leaves the event window, +or the client issues a +QueryPointer +or +GetMotionEvents +request. + + +
+
+ Pointer Window events + + + + + + + +EnterNotify +EnterNotify + + + + +LeaveNotify +LeaveNotify + + + + + +root, event: WINDOW + + + + +child: WINDOW or +None + + + + +same-screen: BOOL + + + + +root-x, root-y, event-x, event-y: INT16 + + + + +mode: +{ Normal, +Grab, +Ungrab} + + + + +detail: +{ Ancestor, +Virtual, +Inferior, +Nonlinear, +NonlinearVirtual} + + + + +focus: BOOL + + + + +state: SETofKEYBUTMASK + + + + +time: TIMESTAMP + + + + + + + + + +If pointer motion or window hierarchy change causes the pointer to be +in a different window than before, +EnterNotify +and +LeaveNotify +events are generated instead of a +MotionNotify +event. +Only clients selecting +EnterWindow +on a window receive +EnterNotify +events, and only clients selecting +LeaveWindow +receive +LeaveNotify +events. +The pointer position reported in the event is always the final position, +not the initial position of the pointer. +The root is the root window for this position, +and root-x and root-y are the pointer coordinates relative to root's +origin at the time of the event. +Event is the event window. +If the event window is on the same screen as root, +then event-x and event-y are the pointer coordinates relative +to the event window's origin. +Otherwise, event-x and event-y are zero. +In a +LeaveNotify +event, if a child of the event window contains the initial position of the +pointer, then the child component is set to that child. +Otherwise, it is +None. +For an +EnterNotify +event, if a child of the event window contains the final pointer position, +then the child component is set to that child. +Otherwise, it is +None. +If the event window is the focus window or an inferior of the focus window, +then focus is +True. +Otherwise, focus is +False. + + +Normal pointer motion events have mode +Normal. +Pseudo-motion events when a grab activates have mode +Grab, +and pseudo-motion events when a grab deactivates have mode +Ungrab. + + +All +EnterNotify +and +LeaveNotify +events caused by a hierarchy change are generated after any hierarchy event +caused by that change (that is, +UnmapNotify, +MapNotify, +ConfigureNotify, +GravityNotify, +CirculateNotify), +but the ordering of +EnterNotify +and +LeaveNotify +events with respect to +FocusOut, +VisibilityNotify, +and +Expose +events is not constrained. + + +Normal events are generated as follows: + + + +When the pointer moves from window A to window B and A is an inferior +of B: + + + + + +LeaveNotify +with detail +Ancestor +is generated on A. + + + + +LeaveNotify +with detail +Virtual +is generated on each window between A and B exclusive (in that order). + + + + +EnterNotify +with detail +Inferior +is generated on B. + + + + + +When the pointer moves from window A to window B and B is an inferior +of A: + + + + + + +LeaveNotify +with detail +Inferior +is generated on A. + + + + +EnterNotify +with detail +Virtual +is generated on each window between A and B exclusive (in that order). + + + + +EnterNotify +with detail +Ancestor +is generated on B. + + + + + +When the pointer moves from window A to window B and window C is +their least common ancestor: + + + + + +LeaveNotify +with detail +Nonlinear +is generated on A. + + + + +LeaveNotify +with detail +NonlinearVirtual +is generated on each window between A and C exclusive (in that order). + + + + +EnterNotify +with detail +NonlinearVirtual +is generated on each window between C and B exclusive (in that order). + + + + +EnterNotify +with detail +Nonlinear +is generated on B. + + + + + +When the pointer moves from window A to window B on different screens: + + + + + +LeaveNotify +with detail +Nonlinear +is generated on A. + + + + +If A is not a root window, +LeaveNotify +with detail +NonlinearVirtual +is generated on each window above A up to and including its root (in order). + + + + +If B is not a root window, +EnterNotify +with detail +NonlinearVirtual +is generated on each window from B's root down to but not including B +(in order). + + + + +EnterNotify +with detail +Nonlinear +is generated on B. + + + + + +When a pointer grab activates (but after any initial warp into a confine-to +window and before generating any actual +ButtonPress +event that activates the grab), +G is the grab-window for the grab, and P is the window the pointer is in: + + + + + +EnterNotify +and +LeaveNotify +events with mode +Grab +are generated (as for +Normal +above) as if the pointer were to suddenly warp from its current +position in P to some position in G. +However, the pointer does not warp, +and the pointer position is used as both the initial +and final positions for the events. + + + + + +When a pointer grab deactivates (but after generating any actual +ButtonRelease +event that deactivates the grab), G is the grab-window for +the grab, and P is the window the pointer is in: + + + + + +EnterNotify +and +LeaveNotify +events with mode +Ungrab +are generated (as for +Normal +above) as if the pointer were to suddenly warp from +some position in G to its current position in P. +However, the pointer does not warp, +and the current pointer position is used as both the initial +and final positions for the events. + + + + +
+
+ Input Focus events + Input focusevents + + + + + + + + +FocusIn +FocusIn + + + + +FocusOut +FocusOut + + + + + +event: WINDOW + + + + +mode: +{ Normal, +WhileGrabbed, +Grab, +Ungrab} + + + + +detail: +{ Ancestor, +Virtual, +Inferior, +Nonlinear, +NonlinearVirtual, +Pointer, + + + + +PointerRoot, +None } + + + + + + + + + +These events are generated when the input focus changes +and are reported to clients selecting +FocusChange +on the window. +Events generated by +SetInputFocus +when the keyboard is not grabbed have mode +Normal. +Events generated by +SetInputFocus +when the keyboard is grabbed have mode +WhileGrabbed. +Events generated when a keyboard grab activates have mode +Grab, +and events generated when a keyboard grab deactivates have mode +Ungrab. + + +All +FocusOut +events caused by a window unmap are generated after any +UnmapNotify +event, but the ordering of +FocusOut +with respect to generated +EnterNotify, +LeaveNotify, +VisibilityNotify, +and +Expose +events is not constrained. + + +Normal +and +WhileGrabbed +events are generated as follows: + + +When the focus moves from window A to window B, A is an inferior of B, +and the pointer is in window P: + + + + + +FocusOut +with detail +Ancestor +is generated on A. + + + + +FocusOut +with detail +Virtual +is generated on each window between A and B exclusive (in order). + + + + +FocusIn +with detail +Inferior +is generated on B. + + + + +If P is an inferior of B +but P is not A or an inferior of A or an ancestor of A, +FocusIn +with detail +Pointer +is generated on each window below B down to and including P (in order). + + + + + + +When the focus moves from window A to window B, B is an inferior of A, +and the pointer is in window P: + + + + + +If P is an inferior of A +but P is not an inferior of B or an ancestor of B, +FocusOut +with detail +Pointer +is generated on each window from P up to but not including A (in order). + + + + +FocusOut +with detail +Inferior +is generated on A. + + + + +FocusIn +with detail +Virtual +is generated on each window between A and B exclusive (in order). + + + + +FocusIn +with detail +Ancestor +is generated on B. + + + + + +When the focus moves from window A to window B, window C is their +least common ancestor, and the pointer is in window P: + + + + + +If P is an inferior of A, +FocusOut +with detail +Pointer +is generated on each window from P up to but not including A (in order). + + + + +FocusOut +with detail +Nonlinear +is generated on A. + + + + +FocusOut +with detail +NonlinearVirtual +is generated on each window between A and C exclusive (in order). + + + + +FocusIn +with detail +NonlinearVirtual +is generated on each window between C and B exclusive (in order). + + + + +FocusIn +with detail +Nonlinear +is generated on B. + + + + +If P is an inferior of B, +FocusIn +with detail +Pointer +is generated on each window below B down to and including P (in order). + + + + + +When the focus moves from window A to window B on different screens +and the pointer is in window P: + + + + + + +If P is an inferior of A, +FocusOut +with detail +Pointer +is generated on each window from P up to but not including A (in order). + + + + +FocusOut +with detail +Nonlinear +is generated on A. + + + + +If A is not a root window, +FocusOut +with detail +NonlinearVirtual +is generated on each window above A up to and including its root (in order). + + + + +If B is not a root window, +FocusIn +with detail +NonlinearVirtual +is generated on each window from B's root down to but not including B +(in order). + + + + +FocusIn +with detail +Nonlinear +is generated on B. + + + + +If P is an inferior of B, +FocusIn +with detail +Pointer +is generated on each window below B down to and including P (in order). + + + + + +When the focus moves from window A to +PointerRoot +(or +None) +and the pointer is in window P: + + + + + + +If P is an inferior of A, +FocusOut +with detail +Pointer +is generated on each window from P up to but not including A (in order). + + + + +FocusOut +with detail +Nonlinear +is generated on A. + + + + +If A is not a root window, +FocusOut +with detail +NonlinearVirtual +is generated on each window above A up to and including its root (in order). + + + + +FocusIn +with detail +PointerRoot +(or +None) +is generated on all root windows. + + + + +If the new focus is +PointerRoot, +FocusIn +with detail +Pointer +is generated on each window from P's root down to and including P (in order). + + + + + +When the focus moves from +PointerRoot +(or +None) +to window A and the pointer is in window P: + + + + + + +If the old focus is +PointerRoot, +FocusOut +with detail +Pointer +is generated on each window from P up to and including P's root (in order). + + + + +FocusOut +with detail +PointerRoot +(or +None) +is generated on all root windows. + + + + +If A is not a root window, +FocusIn +with detail +NonlinearVirtual +is generated on each window from A's root down to but not including A +(in order). + + + + +FocusIn +with detail +Nonlinear +is generated on A. + + + + +If P is an inferior of A, +FocusIn +with detail +Pointer +is generated on each window below A down to and including P (in order). + + + + + +When the focus moves from +PointerRoot +to +None +(or vice versa) and the pointer is in window P: + + + + + +If the old focus is +PointerRoot, +FocusOut +with detail +Pointer +is generated on each window from P up to and including P's root (in order). + + + + +FocusOut +with detail +PointerRoot +(or +None) +is generated on all root windows. + + + + +FocusIn +with detail +None +(or +PointerRoot) +is generated on all root windows. + + + + +If the new focus is +PointerRoot, +FocusIn +with detail +Pointer +is generated on each window from P's root down to and including P (in order). + + + + + + +When a keyboard grab activates (but before generating any actual +KeyPress +event that activates the grab), G is the grab-window for the grab, +and F is the current focus: + + + + + +FocusIn +and +FocusOut +events with mode +Grab +are generated (as for +Normal +above) as if the focus were to change from F to G. + + + + + +When a keyboard grab deactivates (but after generating any actual +KeyRelease +event that deactivates the grab), G is the grab-window for the grab, +and F is the current focus: + + + + + +FocusIn +and +FocusOut +events with mode +Ungrab +are generated (as for +Normal +above) as if the focus were to change from G to F. + + + + +
+
+ KeymapNotify + KeymapNotify + + + + + + + + + KeymapNotify + + + + +keys: LISTofCARD8 + + + + + + + +The value is a bit vector as described in +QueryKeymap. +This event is reported to clients selecting +KeymapState +on a window and is generated immediately after every +EnterNotify +and +FocusIn. + + +
+
+ Expose + Expose + EventExposure + + + + + + + + Expose + + + + + +window: WINDOW + + + + +x, +y, +width, +height: CARD16 + + + + +count: CARD16 + + + + + + + + +This event is reported to clients selecting +Exposure +on the window. +It is generated when no valid contents are available for regions of a window, +and either the regions are visible, the regions are viewable +and the server is (perhaps newly) maintaining backing store on the window, +or the window is not viewable but the server is (perhaps newly) honoring +window's backing-store attribute of +Always +or +WhenMapped. +The regions are decomposed into an arbitrary set of rectangles, +and an +Expose +event is generated for each rectangle. + + +For a given action causing exposure events, +the set of events for a given window are guaranteed to be reported contiguously. +If count is zero, +then no more +Expose +events for this window follow. +If count is nonzero, +then at least that many more +Expose +events for this window follow (and possibly more). + + +The x and y coordinates are relative to window's origin +and specify the upper-left corner of a rectangle. +The width and height specify the extent of the rectangle. + + +Expose +events are never generated on +InputOnly +windows. + + +All +Expose +events caused by a hierarchy change are generated after any +hierarchy event caused by that change (for example, +UnmapNotify, +MapNotify, +ConfigureNotify, +GravityNotify, +CirculateNotify). +All +Expose +events on a given window are generated after any +VisibilityNotify +event on that window, +but it is not required that all +Expose +events on all windows be generated after all +Visibilitity +events on all windows. +The ordering of +Expose +events with respect to +FocusOut, +EnterNotify, +and +LeaveNotify +events is not constrained. + + +
+
+ GraphicsExposure + GraphicsExposure + + + + + + + + GraphicsExposure + + + + + +drawable: DRAWABLE + + + + +x, y, width, height: CARD16 + + + + +count: CARD16 + + + + +major-opcode: CARD8 + + + + +minor-opcode: CARD16 + + + + + + + + + +This event is reported to a client using a graphics context +with graphics-exposures selected +and is generated when a destination region could not be computed due +to an obscured or out-of-bounds source region. +All of the regions exposed by a given graphics request +are guaranteed to be reported contiguously. +If count is zero then no more +GraphicsExposure +events for this window follow. +If count is nonzero, +then at least that many more +GraphicsExposure +events for this window follow (and possibly more). + + +The x and y coordinates are relative to drawable's origin +and specify the upper-left corner of a rectangle. +The width and height specify the extent of the rectangle. + + +The major and minor opcodes identify the graphics request used. +For the core protocol, +major-opcode is always +CopyArea +or +CopyPlane, +and minor-opcode is always zero. + + +
+
+ NoExposure + NoExposure + + + + + + + + NoExposure + + + + + +drawable: DRAWABLE + + + + +major-opcode: CARD8 + + + + +minor-opcode: CARD16 + + + + + + + + + +This event is reported to a client using a graphics context +with graphics-exposures selected +and is generated when a graphics request +that might produce +GraphicsExposure +events does not produce any. +The drawable specifies the destination used for the graphics request. + + +The major and minor opcodes identify the graphics request used. +For the core protocol, +major-opcode is always +CopyArea +or +CopyPlane, +and the minor-opcode is always zero. + + +
+
+ VisibilityNotify + VisibilityNotify + + + + + + + + VisibilityNotify + + + + + +window: WINDOW + + + + +state: +{ Unobscured, +PartiallyObscured, +FullyObscured} + + + + + + + + + +This event is reported to clients selecting +VisibilityChange +on the window. +In the following, +the state of the window is calculated ignoring all of the window's subwindows. +When a window changes state from partially or fully obscured or +not viewable to viewable and completely unobscured, +an event with +Unobscured +is generated. +When a window changes state from viewable and completely unobscured, +from viewable and completely obscured, +or from not viewable, to viewable and partially obscured, +an event with +PartiallyObscured +is generated. +When a window changes state from viewable and completely unobscured, +from viewable and partially obscured, +or from not viewable to viewable and fully obscured, +an event with +FullyObscured +is generated. + + +VisibilityNotify +events are never generated on +InputOnly +windows. + + +All +VisibilityNotify +events caused by a hierarchy change are generated after any hierarchy event +caused by that change (for example, +UnmapNotify, +MapNotify, +ConfigureNotify, +GravityNotify, +CirculateNotify). +Any +VisibilityNotify +event on a given window is generated before any +Expose +events on that window, +but it is not required that all +VisibilityNotify +events on all windows be generated before all +Expose +events on all windows. +The ordering of +VisibilityNotify +events with respect to +FocusOut, +EnterNotify, +and +LeaveNotify +events is not constrained. + + +
+
+ CreateNotify + CreateNotify + + + + + + + + CreateNotify + + + + + +parent, window: WINDOW + + + + +x, y: INT16 + + + + +width, height, border-width: CARD16 + + + + +override-redirect: BOOL + + + + + + + + + +This event is reported to clients selecting +SubstructureNotify +on the parent +and is generated when the window is created. +The arguments are as in the +CreateWindow +request. + + +
+
+ DestroyNotify + DestroyNotify + + + + + + + + DestroyNotify + + + + + +event, window: WINDOW + + + + + + + + + +This event is reported to clients selecting +StructureNotify +on the window and to clients selecting +SubstructureNotify +on the parent. +It is generated when the window is destroyed. +The event is the window on which the event was generated, +and the window is the window that is destroyed. + + +The ordering of the +DestroyNotify +events is such that for any given window, +DestroyNotify +is generated on all inferiors of the window +before being generated on the window itself. +The ordering among siblings and across subhierarchies is not +otherwise constrained. + + +
+
+ UnmapNotify + UnmapNotify + + + + + + + + UnmapNotify + + + + + +event, window: WINDOW + + + + +from-configure: BOOL + + + + + + + + + +This event is reported to clients selecting +StructureNotify +on the window and to clients selecting +SubstructureNotify +on the parent. +It is generated when the window changes state from mapped to unmapped. +The event is the window on which the event was generated, +and the window is the window that is unmapped. +The from-configure flag is +True +if the event was generated as a result of the window's parent being resized +when the window itself had a win-gravity of +Unmap. + + +
+
+ MapNotify + MapNotify + Mapped window + + + + + + + + MapNotify + + + + + +event, window: WINDOW + + + + +override-redirect: BOOL + + + + + + + + + +This event is reported to clients selecting +StructureNotify +on the window and to clients selecting +SubstructureNotify +on the parent. +It is generated when the window changes state from unmapped to mapped. +The event is the window on which the event was generated, +and the window is the window that is mapped. +The override-redirect flag is from the window's attribute. + + +
+
+ MapRequest + MapRequest + + + + + + + + MapRequest + + + + + +parent, window: WINDOW + + + + + + + + + +This event is reported to the client selecting +SubstructureRedirect +on the parent and is generated when a +MapWindow +request is issued on an unmapped window with an override-redirect attribute of +False. + + +
+
+ ReparentNotify + ReparentNotify + + + + + + + + ReparentNotify + + + + + +event, window, parent: WINDOW + + + + +x, y: INT16 + + + + +override-redirect: BOOL + + + + + + + + + +This event is reported to clients selecting +SubstructureNotify +on either the old or the new parent and to clients selecting +StructureNotify +on the window. +It is generated when the window is reparented. +The event is the window on which the event was generated. +The window is the window that has been rerooted. +The parent specifies the new parent. +The x and y coordinates are relative to the new parent's origin +and specify the position of the upper-left outer corner of the window. +The override-redirect flag is from the window's attribute. + + +
+
+ ConfigureNotify + ConfigureNotify + + + + + + + + ConfigureNotify + + + + + +event, window: WINDOW + + + + +x, y: INT16 + + + + +width, height, border-width: CARD16 + + + + +above-sibling: WINDOW or +None + + + + +override-redirect: BOOL + + + + + + + + + +This event is reported to clients selecting +StructureNotify +on the window and to clients selecting +SubstructureNotify +on the parent. +It is generated when a +ConfigureWindow +request actually changes the state of the window. +The event is the window on which the event was generated, +and the window is the window that is changed. +The x and y coordinates are relative to the new parent's origin +and specify the position of the upper-left outer corner of the window. +The width and height specify the inside size, not including the border. +If above-sibling is +None, +then the window is on the bottom of the stack with respect to siblings. +Otherwise, the window is immediately on top of the specified sibling. +The override-redirect flag is from the window's attribute. + + +
+
+ GravityNotify + GravityNotify + + + + + + + + GravityNotify + + + + + +event, window: WINDOW + + + + +x, y: INT16 + + + + + + + + + +This event is reported to clients selecting +SubstructureNotify +on the parent and to clients selecting +StructureNotify +on the window. +It is generated when a window is moved because of a change in size +of the parent. +The event is the window on which the event was generated, +and the window is the window that is moved. +The x and y coordinates are relative to the new parent's origin +and specify the position of the upper-left outer corner of the window. + + +
+
+ ResizeRequest + ResizeRequest + + + + + + + + ResizeRequest + + + + + +window: WINDOW + + + + +width, height: CARD16 + + + + + + + + + +This event is reported to the client selecting +ResizeRedirect +on the window and is generated when a +ConfigureWindow +request by some other client on the window attempts to change the size +of the window. +The width and height are the requested inside size, not including the border. + + +
+
+ ConfigureRequest + ConfigureRequest + + + + + + + + ConfigureRequest + + + + + +parent, window: WINDOW + + + + +x, y: INT16 + + + + +width, height, border-width: CARD16 + + + + +sibling: WINDOW or +None + + + + +stack-mode: +{ Above, +Below, +TopIf, +BottomIf, +Opposite} + + + + +value-mask: BITMASK + + + + + + + + + +This event is reported to the client selecting +SubstructureRedirect +on the parent and is generated when a +ConfigureWindow +request is issued on the window by some other client. +The value-mask indicates which components were specified in the request. +The value-mask and the corresponding values are reported as given +in the request. +The remaining values are filled in from the current geometry of the window, +except in the case of sibling and stack-mode, +which are reported as +None +and +Above +(respectively) if not given in the request. + + +
+
+ CirculateNotify + CirculateNotify + + + + + + + + CirculateNotify + + + + + +event, window: WINDOW + + + + +place: +{ Top, +Bottom} + + + + + + + + + +This event is reported to clients selecting +StructureNotify +on the window and to clients selecting +SubstructureNotify +on the parent. +It is generated when the window is actually restacked from a +CirculateWindow +request. +The event is the window on which the event was generated, +and the window is the window that is restacked. +If place is +Top, +the window is now on top of all siblings. +Otherwise, it is below all siblings. + + +
+
+ CirculateRequest + CirculateRequest + + + + + + + + CirculateRequest + + + + + +parent, window: WINDOW + + + + +place: +{ Top, +Bottom} + + + + + + + + + +This event is reported to the client selecting +SubstructureRedirect +on the parent and is generated when a +CirculateWindow +request is issued on the parent and a window actually needs to be restacked. +The window specifies the window to be restacked, +and the place specifies what the new position in the stacking order should be. + + +
+
+ PropertyNotify + PropertyNotify + + + + + + + + PropertyNotify + + + + + +window: WINDOW + + + + +atom: ATOM + + + + +state: +{ NewValue, +Deleted} + + + + +time: TIMESTAMP + + + + + + + + + +This event is reported to clients selecting +PropertyChange +on the window and is generated with state +NewValue +when a property of the window is changed using +ChangeProperty +or +RotateProperties, +even when adding zero-length data using +ChangeProperty +and when replacing all or part of a property with identical data using +ChangeProperty +or +RotateProperties. +It is generated with state +Deleted +when a property of the +window is deleted using request +DeleteProperty +or +GetProperty. +The timestamp indicates the server time when the property was changed. + + +
+
+ SelectionClear + SelectionClear + + + + + + + + SelectionClear + + + + + +owner: WINDOW + + + + +selection: ATOM + + + + +time: TIMESTAMP + + + + + + + + + +This event is reported to the current owner of a selection +and is generated when a new owner is being defined by means of +SetSelectionOwner. +The timestamp is the last-change time recorded for the selection. +The owner argument is the window that was specified by the current owner in its +SetSelectionOwner +request. + + +
+
+ SelectionRequest + SelectionRequest + + + + + + + + SelectionRequest + + + + + +owner: WINDOW + + + + +selection: ATOM + + + + +target: ATOM + + + + +property: ATOM or +None + + + + +requestor: WINDOW + + + + +time: TIMESTAMP or +CurrentTime + + + + + + + + + +This event is reported to the owner of a selection +and is generated when a client issues a +ConvertSelection +request. +The owner argument is the window that was specified in the +SetSelectionOwner +request. +The remaining arguments are as in the +ConvertSelection +request. + + +The owner should convert the selection based on the specified target type +and send a +SelectionNotify +back to the requestor. +A complete specification for using selections is given in the X.Org +standard Inter-Client Communication Conventions Manual. + + +
+
+ SelectionNotify + SelectionNotify + + + + + + + + SelectionNotify + + + + + +requestor: WINDOW + + + + +selection, target: ATOM + + + + +property: ATOM or +None + + + + +time: TIMESTAMP or +CurrentTime + + + + + + + + + +This event is generated by the server in response to a +ConvertSelection +request when there is no owner for the selection. +When there is an owner, +it should be generated by the owner using +SendEvent. +The owner of a selection should send this event to a requestor either +when a selection has been converted and stored as a property +or when a selection conversion could not be performed (indicated with property +None). + + +
+
+ ColormapNotify + ColormapNotify + + + + + + + + ColormapNotify + + + + + +window: WINDOW + + + + +colormap: COLORMAP or +None + + + + +new: BOOL + + + + +state: +{ Installed, +Uninstalled} + + + + + + + + + +This event is reported to clients selecting +ColormapChange +on the window. +It is generated with value +True +for new when the colormap attribute of the window is changed +and is generated with value +False +for new when the colormap of a window is installed or uninstalled. +In either case, +the state indicates whether the colormap is currently installed. + + +
+
+ MappingNotify + MappingNotify + + + + + + + + MappingNotify + + + + + +request: +{ Modifier, +Keyboard, +Pointer} + + + + +first-keycode, count: CARD8 + + + + + + + + + +This event is sent to all clients. +There is no mechanism to express disinterest in this event. +The detail indicates the kind of change that occurred: +Modifiers +for a successful +SetModifierMapping, +Keyboard +for a successful +ChangeKeyboardMapping, +and +Pointer +for a successful +SetPointerMapping. +If the detail is +Keyboard, +then first-keycode and count indicate the range of altered keycodes. + + +
+
+ ClientMessage + ClientMessage + + + + + + + + ClientMessage + + + + + +window: WINDOW + + + + +type: ATOM + + + + +format: {8, 16, 32} + + + + +data: LISTofINT8 or LISTofINT16 or LISTofINT32 + + + + + + + + + +This event is only generated by clients using +SendEvent. +The type specifies how the data is to be interpreted by the receiving client; +the server places no interpretation on the type or the data. +The format specifies whether the data should be viewed as a list of 8-bit, +16-bit, or 32-bit quantities, so that the server can correctly +byte-swap, as necessary. +The data always consists of either 20 8-bit values or 10 16-bit values +or 5 32-bit values, although particular message types might not make use +of all of these values. + +
+ + +Flow Control and Concurrency + + + + +Whenever the server is writing to a given connection, +it is permissible for the server to stop reading from that connection +(but if the writing would block, it must continue to service other connections). +The server is not required to buffer more than a single request per connection +at one time. +For a given connection to the server, +a client can block while reading from the connection +but should undertake to read (events and errors) when writing would block. +Failure on the part of a client to obey this rule could result +in a deadlocked connection, +although deadlock is probably unlikely unless either +the transport layer has very little buffering or the client attempts to +send large numbers of requests without ever reading replies or checking for +errors and events. + + +Whether or not a server is implemented with internal concurrency, +the overall effect must be as if individual requests are executed to completion +in some serial order, +and requests from a given connection must be executed in delivery order +(that is, the total execution order is a shuffle of the individual streams). +The execution of a request includes validating all arguments, +collecting all data for any reply, +and generating and queueing all required events. +However, +it does not include the actual transmission of the reply and the events. +In addition, the effect of any other cause that can generate multiple events +(for example, activation of a grab or pointer motion) must effectively generate +and queue all required events indivisibly with respect to all other causes +and requests. +For a request from a given client, +any events destined for that client that are caused by executing the request +must be sent to the client before any reply or error is sent. + + + diff --git a/miniconda3/envs/ladir/share/doc/xproto/x11protocol.xml b/miniconda3/envs/ladir/share/doc/xproto/x11protocol.xml new file mode 100644 index 0000000000000000000000000000000000000000..87ac55545cc889ccf89cd9e0da0ab99746e74202 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xproto/x11protocol.xml @@ -0,0 +1,64 @@ + + %defs; +]> + + + + + + X Window System Protocol + X Consortium Standard + + Robert + W. + Scheifler + X Consortium, Inc. + + X Version 11, Release &fullrelvers; + Version 1.0 + 19861987198819942004 + The Open Group + + + + + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +Except as contained in this notice, the name of the Open Group shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the Open Group. + +X Window System is a trademark of The Open Group. + + + + + + + + + + diff --git a/miniconda3/envs/ladir/share/doc/xz/AUTHORS b/miniconda3/envs/ladir/share/doc/xz/AUTHORS new file mode 100644 index 0000000000000000000000000000000000000000..f805a204ecb75ca7245e3488101740ec013870c1 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/AUTHORS @@ -0,0 +1,58 @@ + +Authors of XZ Utils +=================== + + XZ Utils is developed and maintained by + Lasse Collin . + + Major parts of liblzma are based on code written by Igor Pavlov, + specifically the LZMA SDK . Without + this code, XZ Utils wouldn't exist. + + The SHA-256 implementation in liblzma is based on code written by + Wei Dai in Crypto++ Library . + + A few scripts have been adapted from GNU gzip. The original + versions were written by Jean-loup Gailly, Charles Levert, and + Paul Eggert. Andrew Dudman helped adapting the scripts and their + man pages for XZ Utils. + + The initial version of the threaded .xz decompressor was written + by Sebastian Andrzej Siewior. + + The initial version of the .lz (lzip) decoder was written + by Michał Górny. + + Architecture-specific CRC optimizations were contributed by + Ilya Kurdyukov, Chenxi Mao, and Xi Ruoyao. + + Other authors: + - Jonathan Nieder + - Joachim Henke + + Special author: Jia Tan was a co-maintainer in 2022-2024. He and + the team behind him inserted a backdoor (CVE-2024-3094) into + XZ Utils 5.6.0 and 5.6.1 releases. He suddenly disappeared when + this was discovered. + + Many people have contributed improvements or reported bugs. + Most of these people are mentioned in the file THANKS. + + The translations of the command line tools and man pages have been + contributed by many people via the Translation Project: + + - https://translationproject.org/domain/xz.html + - https://translationproject.org/domain/xz-man.html + + The authors of the translated man pages are in the header comments + of the man page files. In the source package, the authors of the + translations are in po/*.po and po4a/*.po files. + + Third-party code whose authors aren't listed here: + + - GNU getopt_long() in the 'lib' directory is included for + platforms that don't have a usable getopt_long(). + + - The build system files from GNU Autoconf, GNU Automake, + GNU Libtool, GNU Gettext, Autoconf Archive, and related files. + diff --git a/miniconda3/envs/ladir/share/doc/xz/COPYING b/miniconda3/envs/ladir/share/doc/xz/COPYING new file mode 100644 index 0000000000000000000000000000000000000000..ef3371389d7d45db6593a146fd9e027347f3122c --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/COPYING @@ -0,0 +1,70 @@ + +XZ Utils Licensing +================== + + Different licenses apply to different files in this package. Here + is a summary of which licenses apply to which parts of this package: + + - liblzma is under the BSD Zero Clause License (0BSD). + + - The command line tools xz, xzdec, lzmadec, and lzmainfo are + under 0BSD except that, on systems that don't have a usable + getopt_long, GNU getopt_long is compiled and linked in from the + 'lib' directory. The getopt_long code is under GNU LGPLv2.1+. + + - The scripts to grep, diff, and view compressed files have been + adapted from GNU gzip. These scripts (xzgrep, xzdiff, xzless, + and xzmore) are under GNU GPLv2+. The man pages of the scripts + are under 0BSD; they aren't based on the man pages of GNU gzip. + + - Most of the XZ Utils specific documentation that is in + plain text files (like README, INSTALL, PACKAGERS, NEWS, + and ChangeLog) are under 0BSD unless stated otherwise in + the file itself. The files xz-file-format.txt and + lzma-file-format.xt are in the public domain but may + be distributed under the terms of 0BSD too. + + - Translated messages and man pages are under 0BSD except that + some old translations are in the public domain. + + - Test files and test code in the 'tests' directory, and + debugging utilities in the 'debug' directory are under + the BSD Zero Clause License (0BSD). + + - The GNU Autotools based build system contains files that are + under GNU GPLv2+, GNU GPLv3+, and a few permissive licenses. + These files don't affect the licensing of the binaries being + built. + + - The 'extra' directory contains files that are under various + free software licenses. These aren't built or installed as + part of XZ Utils. + + The following command may be helpful in finding per-file license + information. It works on xz.git and on a clean file tree extracted + from a release tarball. + + sh build-aux/license-check.sh -v + + For the files under the BSD Zero Clause License (0BSD), if + a copyright notice is needed, the following is sufficient: + + Copyright (C) The XZ Utils authors and contributors + + If you copy significant amounts of 0BSD-licensed code from XZ Utils + into your project, acknowledging this somewhere in your software is + polite (especially if it is proprietary, non-free software), but + it is not legally required by the license terms. Here is an example + of a good notice to put into "about box" or into documentation: + + This software includes code from XZ Utils . + + The following license texts are included in the following files: + - COPYING.0BSD: BSD Zero Clause License + - COPYING.LGPLv2.1: GNU Lesser General Public License version 2.1 + - COPYING.GPLv2: GNU General Public License version 2 + - COPYING.GPLv3: GNU General Public License version 3 + + If you have questions, don't hesitate to ask for more information. + The contact information is in the README file. + diff --git a/miniconda3/envs/ladir/share/doc/xz/COPYING.0BSD b/miniconda3/envs/ladir/share/doc/xz/COPYING.0BSD new file mode 100644 index 0000000000000000000000000000000000000000..4322122aecf1aecff317bd50334ba206dcb9ac41 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/COPYING.0BSD @@ -0,0 +1,11 @@ +Permission to use, copy, modify, and/or distribute this +software for any purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL +WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL +THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR +CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN +CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/miniconda3/envs/ladir/share/doc/xz/COPYING.GPLv2 b/miniconda3/envs/ladir/share/doc/xz/COPYING.GPLv2 new file mode 100644 index 0000000000000000000000000000000000000000..9efa6fbc962836e243e20f7f23db062e2c077d28 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/COPYING.GPLv2 @@ -0,0 +1,338 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Moe Ghoul, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/miniconda3/envs/ladir/share/doc/xz/NEWS b/miniconda3/envs/ladir/share/doc/xz/NEWS new file mode 100644 index 0000000000000000000000000000000000000000..73ff8558da08fca0bee21fb60922891f7de0e828 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/NEWS @@ -0,0 +1,2992 @@ + +XZ Utils Release Notes +====================== + +5.8.2 (2025-12-17) + + * liblzma: + + - Fix the build on ARM64 on glibc versions older than + 2.24 (2016). They don't have HWCAP_CRC32 in . + + - Disable CLMUL CRC code when building for 32-bit x86 with + old MSVC versions. This avoids a compiler bug. The exact + compiler version in which the issue was fixed is unknown, + but VS 2022 17.13 (MSVC 19.43.34808) is known to work, so + CLMUL CRC on 32-bit x86 is disabled with MSVC versions + older than that. + + * xz: + + - Add a workaround for Red Hat Enterprise Linux 9 kernel bug + which made xz fail with "xz: Failed to enable the sandbox". + It only occurs with xz 5.8.0 and 5.8.1 binaries built for + other distros. For example, running Debian 13 in a container + on RHEL/CentOS 9 would trigger the issue. + + The bug was introduced in RHEL 9 kernel 5.14.0-603.el9 + (2025-07-30) and fixed in 5.14.0-648.el9 (2025-12-05). + However, as of writing, the fixed kernel isn't available + to RHEL 9 users yet, so including the workaround in this + xz release seems reasonable. The workaround will be removed + when it's no longer needed. + + xzdec was also affected by this issue. + + - On AIX, don't use fsync() on directories because it fails. + + - Fix the build on Emscripten. + + - Fix the build on clang-cl on Windows. + + - Take resource limits (RLIMIT_DATA, RLIMIT_AS, and RLIMIT_VMEM) + into account when determining the default memory usage limit + for multithreaded mode. This should prevent xz from failing + when a resource limit has been set to a value that is less + than 1/4 of total RAM. Other memory limits can still trigger + the same issue, for example, Linux cgroup v2 memory.max. + + * Build systems: + + - When symbol versioning is enabled, pass --undefined-version + to the linker if the option is supported. This fixes the + build when using LLVM's lld and some liblzma features have + been disabled at build time. + + - ARM64: Fix autodetection of fast unaligned memory access when + using GCC and -mstrict-align is in effect. Previously the + build systems would incorrectly guess that unaligned access + is fast, which would result in much slower binaries than + needed. The fix is a workaround for GCC bug 111555; + autodetection already worked with Clang. + + - LoongArch: Autodetect if fast unaligned memory access is + supported. This can improve compression speed by 15 % (but + not decompression speed). + + * Translations: + + - Update the Spanish translation. + + - Add Swedish man page translations. + + - Update Italian, Korean, Romanian, Serbian, and Ukrainian + man page translations. + + +5.8.1 (2025-04-03) + + IMPORTANT: This includes a security fix for CVE-2025-31115 which + affects XZ Utils from 5.3.3alpha to 5.8.0. No new 5.4.x or 5.6.x + releases will be made, but the fix is in the v5.4 and v5.6 branches + in the xz Git repository. A standalone patch for all affected + versions is available as well. + + * Multithreaded .xz decoder (lzma_stream_decoder_mt()): + + - Fix a bug that could at least result in a crash with + invalid input. (CVE-2025-31115) + + - Fix a performance bug: Only one thread was used if the whole + input file was provided at once to lzma_code(), the output + buffer was big enough, timeout was disabled, and LZMA_FINISH + was used. There are no bug reports about this, thus it's + possible that no real-world application was affected. + + * Avoid even with C11/C17 compilers. This fixes the + build with Oracle Developer Studio 12.6 on Solaris 10 when the + compiler is in C11 mode (the header doesn't exist). + + * Autotools: Restore compatibility with GNU make versions older + than 4.0 by creating the package using GNU gettext 0.23.1 + infrastructure instead of 0.24. + + * Update Croatian translation. + + +5.8.0 (2025-03-25) + + This bumps the minor version of liblzma because new features were + added. The API and ABI are still backward compatible with liblzma + 5.6.x, 5.4.x, 5.2.x, and 5.0.x. + + * liblzma on 32/64-bit x86: When possible, use SSE2 intrinsics + instead of memcpy() in the LZMA/LZMA2 decoder. In typical cases, + this may reduce decompression time by 0-5 %. However, when built + against musl libc, over 15 % time reduction was observed with + highly compressed files. + + * CMake: Make the feature test macros match the Autotools-based + build on NetBSD, Darwin, and mingw-w64. + + * Update the Croatian, Italian, Portuguese, and Romanian + translations. + + * Update the German, Italian, Korean, Romanian, Serbian, and + Ukrainian man page translations. + + Summary of changes in the 5.7.x development releases: + + * Mark the following LZMA Utils script aliases as deprecated: + lzcmp, lzdiff, lzless, lzmore, lzgrep, lzegrep, and lzfgrep. + + * liblzma: + + - Improve LZMA/LZMA2 encoder speed on 64-bit PowerPC (both + endiannesses) and those 64-bit RISC-V processors that + support fast unaligned access. + + - Add low-level APIs for RISC-V, ARM64, and x86 BCJ filters + to lzma/bcj.h. These are primarily for erofs-utils. + + - x86/x86-64/E2K CLMUL CRC code was rewritten. + + - Use the CRC32 instructions on LoongArch. + + * xz: + + - Synchronize the output file and its directory using fsync() + before deleting the input file. No syncing is done when xz + isn't going to delete the input file. + + - Add --no-sync to disable the sync-before-delete behavior. + + - Make --single-stream imply --keep. + + * xz, xzdec, lzmainfo: When printing messages, replace + non-printable characters with question marks. + + * xz and xzdec on Linux: Support Landlock ABI versions 5 and 6. + + * CMake: Revise the configuration variables and some of their + options, and document them in the file INSTALL. CMake support + is no longer experimental. (It was already not experimental + when building for native Windows.) + + * Add build-aux/license-check.sh. + + +5.7.2beta (2025-03-08) + + * On the man pages, mark the following LZMA Utils script aliases as + deprecated: lzcmp, lzdiff, lzless, lzmore, lzgrep, lzegrep, and + lzfgrep. The commands that start with xz* instead of lz* have + identical behavior. + + The LZMA Utils aliases lzma, unlzma, and lzcat aren't deprecated + because some of these aliases are still in common use. lzmadec + and lzmainfo aren't deprecated either. + + * xz: In the ENVIRONMENT section of the man page, warn about + problems that some uses of XZ_DEFAULTS and XZ_OPT may create. + + * Windows (native builds, not Cygwin): In xz, xzdec, and lzmadec, + avoid an error message on broken pipe. + + * Autotools: Fix out-of-tree builds when using the bundled + getopt_long. + + * Translations: + + - Updated: Chinese (traditional), Croatian, Finnish, Georgian, + German, Korean, Polish, Romanian, Serbian, Spanish, Swedish, + Turkish, and Ukrainian + + - Added: Dutch + + * Man page translations: + + - Updated: German, Korean, Romanian, and Ukrainian + + - Added: Italian and Serbian + + +5.7.1alpha (2025-01-23) + + * All fixes from 5.6.4. + + * liblzma: + + - Improve LZMA/LZMA2 encoder speed on 64-bit PowerPC (both + endiannesses) and those 64-bit RISC-V processors that + support fast unaligned access. + + - x86/x86-64/E2K CLMUL CRC code was rewritten. It's faster and + doesn't cause false positives from sanitizers. Attributes + like __attribute__((__no_sanitize_address__)) are no longer + present. + + - On 32-bit x86, CLMUL CRC and the old (but still good) + assembly versions now co-exist with runtime detection. + Both Autotools and CMake build systems handle this + automatically now. + + - Use the CRC32 instructions on LoongArch to make CRC32 + calculation faster. + + - Add low-level APIs for RISC-V, ARM64, and x86 BCJ filters + to lzma/bcj.h. These are primarily for erofs-utils. + + - Minor tweaks to ARM64 CRC32 code and BCJ filters were made. + + * xz: + + - Synchronize the output file and its directory before deleting + the input file using fsync(). This reduces the probability of + data loss after a system crash. However, it can be a major + performance hit if processing many small files. + + NOTE: No syncing is done when xz isn't going to delete + the input file. + + - Add a new option --no-sync to disable the sync-before-delete + behavior. It's useful when compressing many small files and + one doesn't worry about data loss in case of a system crash. + + - Make --single-stream imply --keep. + + - Use automatic word wrapping for the text in --help and + similar situations to hopefully make the strings easier for + majority of translators (no need to count spaces anymore). + + * xz, xzdec, lzmainfo: When printing messages, replace + non-printable characters with question marks. This way + malicious filenames cannot be used to send escape sequences + to a terminal. This change is also applied to filenames shown + in "xz --robot --list". + + * xz and xzdec on Linux: Add support for Landlock ABI versions 5 + and 6. + + * CMake updates: + + - Increase the minimum required CMake version to 3.20. + + - Revise the configuration variables and some of their options. + Document them in the file INSTALL. + + - Attempt to produce liblzma.pc so that the paths are based on + ${prefix}, which makes it simpler to override the paths + if the liblzma files have been moved. + + - To enable translations, gettext-tools is now required. The + CMake build no longer supports installing pre-compiled + message catalog binary files (po/*.gmo). + + - Apple: Use Mach-O shared library versioning that is + compatible with GNU Libtool. This should make it easier to + switch between the build systems on Apple OSes that enforce + the correct compatibility_version (macOS >= 12 doesn't?). + This change is backward compatible: binaries linked against + old CMake-built liblzma will run with liblzma that uses + Libtool style versioning. + + - Windows (not Cygwin): Document CMAKE_DLL_NAME_WITH_SOVERSION + (CMake >= 3.27) in the file INSTALL. This option should + usually be left to its default value (OFF). It can be set + to ON if the liblzma DLL filename must be compatible with + the versioned filename produced by GNU Libtool. For example, + binaries distributed in MSYS2 use a versioned DLL filename. + + - CMake support is no longer experimental. (It was already + not experimental when building for native Windows.) + + * Windows: Building liblzma with Visual Studio 2013 is no longer + supported. Visual Studio 2015 or later (with CMake) can be used + to build liblzma and the command line tools. + + * Add preliminary Georgian translation. This already contains + translations of most of the strings that are now automatically + word wrapped. + + * Add build-aux/license-check.sh. Without arguments, it checks that + no license information has been forgotten. With the -v argument, + it shows the license info (or the lack of it) for each file. + + If the .git directory is available, only the files in the + repository are checked. Without the .git directory, a clean tree + from an extracted release tarball is expected. + + +5.6.4 (2025-01-23) + + * liblzma: Fix LZMA/LZMA2 encoder on big endian ARM64. + + * xz: + + - Fix --filters= and --filters1= ... --filters9= options + parsing. They require an argument, thus "xz --filters lzma2" + should work in addition to "xz --filters=lzma2". + + - On the man page, note in the --compress and --decompress + options that the default behavior is to delete the input + file unless writing to standard output. It was already + documented in the DESCRIPTION section but new users in + a hurry might miss it. + + * Windows (native builds, not Cygwin): Fix regressions introduced + in XZ Utils 5.6.3 which caused non-ASCII characters to display + incorrectly. Only builds with translation support were affected + (--enable-nls or ENABLE_NLS=ON). The following changes affect + builds that have translations enabled: + + - Require UCRT because MSVCRT doesn't support UTF-8 + locales and thus translations won't be readable on + Windows 10 version 1903 and later. (MSVCRT builds + are still possible with --disable-nls or ENABLE_NLS=OFF.) + + - Require gettext-runtime >= 0.23.1 because older versions + don't autodetect the use of the UTF-8 code page. This + resulted in garbled non-ASCII characters even with UCRT. + + - Partially fix alignment issues in xz --verbose --list + with translated messages. Chinese (simplified), + Chinese (traditional), and Korean column headings + are misaligned still because Windows and MinGW-w64 + don't provide wcwidth() and XZ Utils doesn't include + a replacement function either. + + * CMake: Explicitly disable unity builds. This prevents build + failures when another project uses XZ Utils via CMake's + FetchContent module, and that project enables unity builds. + + * Update Chinese (traditional) and Serbian translations. + + +5.6.3 (2024-10-01) + + IMPORTANT: This includes a Windows-specific security fix to + the command line tools (CVE-2024-47611). liblzma isn't affected + by this issue. + + * liblzma: + + - Fix x86-64 inline assembly compatibility with GNU Binutils + older than 2.27. + + - Fix the build with GCC 4.2 on OpenBSD/sparc64. + + * xzdec: Display an error instead of failing silently if the + unsupported option -M is specified. + + * lzmainfo: Fix integer overflows when rounding the dictionary and + uncompressed sizes to the nearest mebibyte. + + * Windows (except Cygwin and MSYS2): Add an application manifest to + xz, xzdec, lzmadec, and lzmainfo executables: + + - Declare them compatible with Vista/7/8/8.1/10/11. This way + the programs won't needlessly use Operating System Context + of Vista when running on later Windows versions. This setting + doesn't mean that the executables cannot run on even older + versions if otherwise built that way. + + - Declare them as UAC-compliant. MSVC added this by default + already but it wasn't done with MinGW-w64, at least not + with all toolchain variants. + + - Declare them long path aware. This makes long path names + work on Windows 10 and 11 if the feature has been enabled + in the Windows registry. + + - Use the UTF-8 code page on Windows 10 version 1903 and later. + + * Now command line tools can access files whose names + contain characters that don't exist in the current + legacy code page. + + * The options --files and --files0 now expect file lists + to be in UTF-8 instead of the legacy code page. + + * This fixes a security issue: If a command line contains + Unicode characters (for example, filenames) that don't + exist in the current legacy code page, the characters are + converted to similar-looking characters with best-fit + mapping. Some best-fit mappings result in ASCII + characters that change the meaning of the command line, + which can be exploited with malicious filenames to do + argument injection or directory traversal attacks. + UTF-8 avoids best-fit mappings and thus fixes the issue. + (CVE-2024-47611) + + Forcing the process code page to UTF-8 is possible only + on Windows 10 version 1903 and later. The command line + tools remain vulnerable if used on an old older + version of Windows. + + This issue was discovered by Orange Tsai and splitline + from DEVCORE Research Team. + + A related smaller issue remains: Windows filenames may + contain unpaired surrogates (invalid UTF-16). These are + converted to the replacement character U+FFFD in the + UTF-8 code page. Thus, filenames with different unpaired + surrogates appear identical and aren't distinguishable + from filenames that contain the actual replacement + character U+FFFD. + + * When building with MinGW-w64, it is recommended to use + UCRT version instead of the old MSVCRT. For example, + non-ASCII characters from filenames won't print + correctly in messages to console with MSVCRT with + the UTF-8 code page (a cosmetic issue). liblzma-only + builds are still fine with MSVCRT. + + - Cygwin and MSYS2 process command line options differently and + the above issues don't exist. There is no need to replace the + default application manifest on Cygwin and MSYS2. + + * Autotools-based build: + + - Fix feature checks with link-time optimization (-flto). + + - Solaris: Fix a compatibility issue in version.sh. It matters + if one wants to regenerate configure by running autoconf. + + * CMake: + + - Use paths relative to ${prefix} in liblzma.pc when possible. + This is done only with CMake >= 3.20. + + - MSVC: Install liblzma.pc as it can be useful with MSVC too. + + - Windows: Fix liblzma filename prefix, for example: + + * Cygwin: The DLL was incorrectly named liblzma-5.dll. + Now it is cyglzma-5.dll. + + * MSVC: Rename import library from liblzma.lib to lzma.lib + while keeping liblzma.dll name as is. This helps with + "pkgconf --msvc-syntax --libs liblzma" because it mungles + "-llzma" in liblzma.pc to "lzma.lib". + + * MinGW-w64: No changes. + + - Windows: Use the correct resource file for lzmadec.exe. + Previously the resource file for xzdec.exe was used for both. + Autotools-based build isn't affected. + + - Prefer a C11 compiler over a C99 compiler but accept both. + + - Link Threads::Threads against liblzma using PRIVATE so that + -pthread and such flags won't unnecessarily get included in + the usage requirements of shared liblzma. That is, + target_link_libraries(foo PRIVATE liblzma::liblzma) no + longer adds -pthread if using POSIX threads and linking + against shared liblzma. The threading flags are still added + if linking against static liblzma. + + * Updated translations: Catalan, Chinese (simplified), and + Brazilian Portuguese. + + +5.6.2 (2024-05-29) + + * Remove the backdoor (CVE-2024-3094). + + * Not changed: Memory sanitizer (MSAN) has a false positive + in the CRC CLMUL code which also makes OSS Fuzz unhappy. + Valgrind is smarter and doesn't complain. + + A revision to the CLMUL code is coming anyway and this issue + will be cleaned up as part of it. It won't be backported to + 5.6.x or 5.4.x because the old code isn't wrong. There is + no reason to risk introducing regressions in old branches + just to silence a false positive. + + * liblzma: + + - lzma_index_decoder() and lzma_index_buffer_decode(): Fix + a missing output pointer initialization (*i = NULL) if the + functions are called with invalid arguments. The API docs + say that such an initialization is always done. In practice + this matters very little because the problem can only occur + if the calling application has a bug and these functions + return LZMA_PROG_ERROR. + + - lzma_str_to_filters(): Fix a missing output pointer + initialization (*error_pos = 0). This is very similar + to the fix above. + + - Fix C standard conformance with function pointer types. + + - Remove GNU indirect function (IFUNC) support. This is *NOT* + done for security reasons even though the backdoor relied on + this code. The performance benefits of IFUNC are too tiny in + this project to make the extra complexity worth it. + + - FreeBSD on ARM64: Add error checking to CRC32 instruction + support detection. + + - Fix building with NVIDIA HPC SDK. + + * xz: + + - Fix a C standard conformance issue in --block-list parsing + (arithmetic on a null pointer). + + - Fix a warning from GNU groff when processing the man page: + "warning: cannot select font 'CW'" + + * xzdec: Add support for Linux Landlock ABI version 4. xz already + had the v3-to-v4 change but it had been forgotten from xzdec. + + * Autotools-based build system (configure): + + - Symbol versioning variant can now be overridden with + --enable-symbol-versions. Documentation in INSTALL was + updated to match. + + - Add new configure option --enable-doxygen to enable + generation and installation of the liblzma API documentation + using Doxygen. Documentation in INSTALL and PACKAGERS was + updated to match. + + CMake: + + - Fix detection of Linux Landlock support. The detection code + in CMakeLists.txt had been sabotaged. + + - Disable symbol versioning on non-glibc Linux to match what + the Autotools build does. For example, symbol versioning + isn't enabled with musl. + + - Symbol versioning variant can now be overridden by setting + SYMBOL_VERSIONING to "OFF", "generic", or "linux". + + - Add support for all tests in typical build configurations. + Now the only difference to the tests coverage to Autotools + is that CMake-based build will skip more tests if features + are disabled. Such builds are only for special cases like + embedded systems. + + - Separate the CMake code for the tests into tests/tests.cmake. + It is used conditionally, thus it is possible to + + rm -rf tests + + and the CMake-based build will still work normally except + that no tests are then available. + + - Add a option ENABLE_DOXYGEN to enable generation and + installation of the liblzma API documentation using Doxygen. + + * Documentation: + + - Omit the Doxygen-generated liblzma API documentation from the + package. Instead, the generation and installation of the API + docs can be enabled with a configure or CMake option if + Doxygen is available. + + - Remove the XZ logo which was used in the API documentation. + The logo has been retired and isn't used by the project + anymore. However, it's OK to use it in contexts that refer + to the backdoor incident. + + - Remove the PDF versions of the man pages from the source + package. These existed primarily for users of operating + systems which don't come with tools to render man page + source files. The plain text versions are still included + in doc/man/txt. PDF files can still be generated to doc/man, + if the required tools are available, using "make pdf" after + running "configure". + + - Update home page URLs back to their old locations on + tukaani.org. + + - Update maintainer info. + + * Tests: + + - In tests/files/README, explain how to recreate the ARM64 + test files. + + - Remove two tests that used tiny x86 and SPARC object files + as the input files. The matching .c file was included but + the object files aren't easy to reproduce. The test cases + weren't great anyway; they were from the early days (2009) + of the project when the test suite had very few tests. + + - Improve a few tests. + + +5.6.1 (2024-03-09) + + IMPORTANT: This fixed bugs in the backdoor (CVE-2024-3094) (someone + had forgot to run Valgrind). + + * liblzma: Fixed two bugs relating to GNU indirect function (IFUNC) + with GCC. The more serious bug caused a program linked with + liblzma to crash on start up if the flag -fprofile-generate was + used to build liblzma. The second bug caused liblzma to falsely + report an invalid write to Valgrind when loading liblzma. + + * xz: Changed the messages for thread reduction due to memory + constraints to only appear under the highest verbosity level. + + * Build: + + - Fixed a build issue when the header file + was present on the system but the Landlock system calls were + not defined in . + + - The CMake build now warns and disables NLS if both gettext + tools and pre-created .gmo files are missing. Previously, + this caused the CMake build to fail. + + * Minor improvements to man pages. + + * Minor improvements to tests. + + +5.6.0 (2024-02-24) + + IMPORTANT: This added a backdoor (CVE-2024-3094). It's enabled only + in the release tarballs. + + This bumps the minor version of liblzma because new features were + added. The API and ABI are still backward compatible with liblzma + 5.4.x and 5.2.x and 5.0.x. + + NOTE: As described in the NEWS for 5.5.2beta, the core components + are now under the BSD Zero Clause License (0BSD). + + Since 5.5.2beta: + + * liblzma: + + - Disabled the branchless C variant in the LZMA decoder based + on the benchmark results from the community. + + - Disabled x86-64 inline assembly on x32 to fix the build. + + * Sandboxing support in xz: + + - Landlock is now used even when xz needs to create files. + In this case the sandbox has to be more permissive than + when no files need to be created. A similar thing was + already in use with pledge(2) since 5.3.4alpha. + + - Landlock and pledge(2) are now stricter when reading from + more than one input file and only writing to standard output. + + - Added support for Landlock ABI version 4. + + * CMake: + + - Default to -O2 instead of -O3 with CMAKE_BUILD_TYPE=Release. + -O3 is not useful for speed and makes the code larger. + + - Now builds lzmainfo and lzmadec. + + - xzdiff, xzgrep, xzless, xzmore, and their symlinks are now + installed. The scripts are also tested during "make test". + + - Added translation support for xz, lzmainfo, and the + man pages. + + - Applied the symbol versioning workaround for MicroBlaze that + is used in the Autotools build. + + - The general XZ Utils and liblzma API documentation is now + installed. + + - The CMake component names were changed a little and several + were added. liblzma_Runtime and liblzma_Development are + unchanged. + + - Minimum required CMake version is now 3.14. However, + translation support is disabled with CMake versions + older than 3.20. + + - The CMake-based build is now close to feature parity with the + Autotools-based build. Most importantly a few tests aren't + run yet. Testing the CMake-based build on different operating + systems would be welcome now. See the comment at the top of + CMakeLists.txt. + + * Fixed a bug in the Autotools feature test for ARM64 CRC32 + instruction support for old versions of Clang. This did not + affect the CMake build. + + * Windows: + + - The build instructions in INSTALL and windows/INSTALL*.txt + were revised completely. + + - windows/build-with-cmake.bat along with the instructions + in windows/INSTALL-MinGW-w64_with_CMake.txt should make + it very easy to build liblzma.dll and xz.exe on Windows + using CMake and MinGW-w64 with either GCC or Clang/LLVM. + + - windows/build.bash was updated. It now works on MSYS2 and + on GNU/Linux (cross-compiling) to create a .zip and .7z + package for 32-bit and 64-bit x86 using GCC + MinGW-w64. + + * The TODO file is no longer installed as part of the + documentation. The file is out of date and does not reflect + the actual tasks that will be completed in the future. + + * Translations: + + - Translated lzmainfo man pages are now installed. These + had been forgotten in earlier versions. + + - Updated Croatian, Esperanto, German, Hungarian, Korean, + Polish, Romanian, Spanish, Swedish, Vietnamese, and Ukrainian + translations. + + - Updated German, Korean, Romanian, and Ukrainian man page + translations. + + * Added a few tests. + + Summary of new features added in the 5.5.x development releases: + + * liblzma: + + - LZMA decoder: Speed optimizations to the C code and + added GCC & Clang compatible inline assembly for x86-64. + + - Added lzma_mt_block_size() to recommend a Block size for + multithreaded encoding. + + - Added CLMUL-based CRC32 on x86-64 and E2K with runtime + processor detection. Similar to CRC64, on 32-bit x86 it + isn't available unless --disable-assembler is used. + + - Optimized the CRC32 calculation on ARM64 platforms using the + CRC32 instructions. Runtime detection for the instruction is + used on GNU/Linux, FreeBSD, Windows, and macOS. If the + compiler flags indicate unconditional CRC32 instruction + support (+crc) then the generic version is not built. + + - Added definitions of mask values like + LZMA_INDEX_CHECK_MASK_CRC32 to . + + * xz: + + - Multithreaded mode is now the default. This improves + compression speed and creates .xz files that can be + decompressed in multithreaded mode. The downsides are + increased memory usage and slightly worse compression ratio. + + - Added a new command line option --filters to set the filter + chain using the liblzma filter string syntax. + + - Added new command line options --filters1 ... --filters9 to + set additional filter chains using the liblzma filter string + syntax. The --block-list option now allows specifying filter + chains that were set using these new options. + + - Ported the command line tools to Windows MSVC. + Visual Studio 2015 or later is required. + + * Added lz4 support to xzdiff/xzcmp and xzgrep. + + +5.5.2beta (2024-02-14) + + * Licensing change: The core components are now under the + BSD Zero Clause License (0BSD). In XZ Utils 5.4.6 and older + and 5.5.1alpha these components are in the public domain and + obviously remain so; the change affects the new releases only. + + 0BSD is an extremely permissive license which doesn't require + retaining or reproducing copyright or license notices when + distributing the code, thus in practice there is extremely + little difference to public domain. + + * liblzma + + - Significant speed optimizations to the LZMA decoder were + made. There are now three variants that can be chosen at + build time: + + * Basic C version: This is a few percent faster than + 5.4.x due to some new optimizations. + + * Branchless C: This is currently the default on platforms + for which there is no assembly code. This should be a few + percent faster than the basic C version. + + * x86-64 inline assembly. This works with GCC and Clang. + + The default choice can currently be overridden by setting + LZMA_RANGE_DECODER_CONFIG in CPPFLAGS: 0 means the basic + version and 3 means that branchless C version. + + - Optimized the CRC32 calculation on ARM64 platforms using the + CRC32 instructions. The instructions are optional in ARMv8.0 + and are required in ARMv8.1 and later. Runtime detection for + the instruction is used on GNU/Linux, FreeBSD, Windows, and + macOS. If the compiler flags indicate unconditional CRC32 + instruction support (+crc) then the generic version is not + built. + + * Added lz4 support to xzdiff/xzcmp and xzgrep. + + * Man pages of xzdiff/xzcmp, xzgrep, and xzmore were rewritten + to simplify licensing of the man page translations. + + * Translations: + + - Updated Chinese (simplified), German, Korean, Polish, + Romanian, Spanish, Swedish, and Ukrainian translations. + + - Updated German, Korean, Romanian, and Ukrainian man page + translations. + + * Small improvements to the tests. + + * Added doc/examples/11_file_info.c. It was added to the Git + repository in 2017 but forgotten to be added into distribution + tarballs. + + * Removed doc/examples_old. These were from 2012. + + * Removed the macos/build.sh script. It had not been updated + since 2013. + + +5.5.1alpha (2024-01-26) + + * Added a new filter for RISC-V binaries. The filter can be used + for 32-bit and 64-bit binaries with either little or big + endianness. In liblzma, the Filter ID is LZMA_FILTER_RISCV (0x0B) + and the xz option is --riscv. liblzma filter string syntax + recognizes this filter as "riscv". + + * liblzma: + + - Added lzma_mt_block_size() to recommend a Block size for + multithreaded encoding + + - Added CLMUL-based CRC32 on x86-64 and E2K with runtime + processor detection. Similar to CRC64, on 32-bit x86 it + isn't available unless --disable-assembler is used. + + - Implemented GNU indirect function (IFUNC) as a runtime + function dispatching method for CRC32 and CRC64 fast + implementations on x86. Only GNU/Linux (glibc) and FreeBSD + builds will use IFUNC, unless --enable-ifunc is specified to + configure. + + - Added definitions of mask values like + LZMA_INDEX_CHECK_MASK_CRC32 to . + + - The XZ logo is now included in the Doxygen generated + documentation. It is licensed under Creative Commons + Attribution-ShareAlike 4.0. + + * xz: + + - Multithreaded mode is now the default. This improves + compression speed and creates .xz files that can be + decompressed multithreaded at the cost of increased memory + usage and slightly worse compression ratio. + + - Added new command line option --filters to set the filter + chain using liblzma filter string syntax. + + - Added new command line options --filters1 ... --filters9 to + set additional filter chains using liblzma filter string + syntax. The --block-list option now allows specifying filter + chains that were set using these new options. + + - Added support for Linux Landlock as a sandboxing method. + + - xzdec now supports pledge(2), Capsicum, and Linux Landlock as + sandboxing methods. + + - Progress indicator time stats remain accurate after pausing + xz with SIGTSTP. + + - Ported xz and xzdec to Windows MSVC. Visual Studio 2015 or + later is required. + + * CMake Build: + + - Supports pledge(2), Capsicum, and Linux Landlock sandboxing + methods. + + - Replacement functions for getopt_long() are used on platforms + that do not have it. + + * Enabled unaligned access by default on PowerPC64LE and on RISC-V + targets that define __riscv_misaligned_fast. + + * Tests: + + - Added two new fuzz targets to OSS-Fuzz. + + - Implemented Continuous Integration (CI) testing using + GitHub Actions. + + * Changed quoting style from `...' to '...' in all messages, + scripts, and documentation. + + * Added basic Codespell support to help catch typo errors. + + +5.4.7 (2024-05-29) + + * Not changed: Memory sanitizer (MSAN) has a false positive + in the CRC CLMUL code which also makes OSS Fuzz unhappy. + Valgrind is smarter and doesn't complain. + + A revision to the CLMUL code is coming anyway and this issue + will be cleaned up as part of it. It won't be backported to + 5.6.x or 5.4.x because the old code isn't wrong. There is + no reason to risk introducing regressions in old branches + just to silence a false positive. + + * liblzma: + + - lzma_index_decoder() and lzma_index_buffer_decode(): Fix + a missing output pointer initialization (*i = NULL) if the + functions are called with invalid arguments. The API docs + say that such an initialization is always done. In practice + this matters very little because the problem can only occur + if the calling application has a bug and these functions + return LZMA_PROG_ERROR. + + - lzma_str_to_filters(): Fix a missing output pointer + initialization (*error_pos = 0). This is very similar + to the fix above. + + - Fix C standard conformance with function pointer types. + This newly showed up with Clang 17 with -fsanitize=undefined. + There are no bug reports about this. + + - Fix building with NVIDIA HPC SDK. + + * xz: + + - Fix a C standard conformance issue in --block-list parsing + (arithmetic on a null pointer). + + - Fix a warning from GNU groff when processing the man page: + "warning: cannot select font 'CW'" + + - Fix outdated threading related information on the man page. + + * xzless: + + - With "less" version 451 and later, use "||-" instead of "|-" + in the environment variable LESSOPEN. This way compressed + files that contain no uncompressed data are shown correctly + as empty. + + - With "less" version 632 and later, use --show-preproc-errors + to make "less" show a warning on decompression errors. + + * Autotools-based build system (configure): + + - Symbol versioning variant can now be overridden with + --enable-symbol-versions. Documentation in INSTALL was + updated to match. + + CMake: + + - Linux on MicroBlaze is handled specially now. This matches + the changes made to the Autotools-based build in XZ Utils + 5.4.2 and 5.2.11. + + - Disable symbol versioning on non-glibc Linux to match what + the Autotools build does. For example, symbol versioning + isn't enabled with musl. + + - Symbol versioning variant can now be overridden by setting + SYMBOL_VERSIONING to "OFF", "generic", or "linux". + + * Documentation: + + - Clarify the description of --disable-assembler in INSTALL. + The option only affects 32-bit x86 assembly usage. + + - Add doc/examples/11_file_info.c. It was added to the + Git repository in 2017 but forgotten to be added into + distribution tarballs. + + - Don't install the TODO file as part of the documentation. + The file is out of date. + + - Update home page URLs back to their old locations on + tukaani.org. + + - Update maintainer info. + + +5.4.6 (2024-01-26) + + * Fixed a bug involving internal function pointers in liblzma not + being initialized to NULL. The bug can only be triggered if + lzma_filters_update() is called on a LZMA1 encoder, so it does + not affect xz or any application known to us that uses liblzma. + + * xz: + + - Fixed a regression introduced in 5.4.2 that caused encoding + in the raw format to unnecessarily fail if --suffix was not + used. For instance, the following command no longer reports + that --suffix must be used: + + echo foo | xz --format=raw --lzma2 | wc -c + + - Fixed an issue on MinGW-w64 builds that prevented reading + from or writing to non-terminal character devices like NUL. + + * Added a new test. + + +5.4.5 (2023-11-01) + + * liblzma: + + - Use __attribute__((__no_sanitize_address__)) to avoid address + sanitization with CRC64 CLMUL. It uses 16-byte-aligned reads + which can extend past the bounds of the input buffer and + inherently trigger address sanitization errors. This isn't + a bug. + + - Fixed an assertion failure that could be triggered by a large + unpadded_size argument. It was verified that there was no + other bug than the assertion failure. + + - Fixed a bug that prevented building with Windows Vista + threading when __attribute__((__constructor__)) is not + supported. + + * xz now properly handles special files such as "con" or "nul" on + Windows. Before this fix, the following wrote "foo" to the + console and deleted the input file "con_xz": + + echo foo | xz > con_xz + xz --suffix=_xz --decompress con_xz + + * Build systems: + + - Allow builds with Windows win95 threading and small mode when + __attribute__((__constructor__)) is supported. + + - Added a new line to liblzma.pc for MSYS2 (Windows): + + Cflags.private: -DLZMA_API_STATIC + + When compiling code that will link against static liblzma, + the LZMA_API_STATIC macro needs to be defined on Windows. + + - CMake specific changes: + + * Fixed a bug that allowed CLOCK_MONOTONIC to be used even + if the check for it failed. + + * Fixed a bug where configuring CMake multiple times + resulted in HAVE_CLOCK_GETTIME and HAVE_CLOCK_MONOTONIC + not being set. + + * Fixed the build with MinGW-w64-based Clang/LLVM 17. + llvm-windres now has more accurate GNU windres emulation + so the GNU windres workaround from 5.4.1 is needed with + llvm-windres version 17 too. + + * The import library on Windows is now properly named + "liblzma.dll.a" instead of "libliblzma.dll.a" + + * Fixed a bug causing the Ninja Generator to fail on + UNIX-like systems. This bug was introduced in 5.4.0. + + * Added a new option to disable CLMUL CRC64. + + * A module-definition (.def) file is now created when + building liblzma.dll with MinGW-w64. + + * The pkg-config liblzma.pc file is now installed on all + builds except when using MSVC on Windows. + + * Added large file support by default for platforms that + need it to handle files larger than 2 GiB. This includes + MinGW-w64, even 64-bit builds. + + * Small fixes and improvements to the tests. + + * Updated translations: Chinese (simplified) and Esperanto. + + +5.4.4 (2023-08-02) + + * liblzma and xzdec can now build against WASI SDK when threading + support is disabled. xz and tests don't build yet. + + * CMake: + + - Fixed a bug preventing other projects from including liblzma + multiple times using find_package(). + + - Don't create broken symlinks in Cygwin and MSYS2 unless + supported by the environment. This prevented building for the + default MSYS2 environment. The problem was introduced in + xz 5.4.0. + + * Documentation: + + - Small improvements to man pages. + + - Small improvements and typo fixes for liblzma API + documentation. + + * Tests: + + - Added a new section to INSTALL to describe basic test usage + and address recent questions about building the tests when + cross compiling. + + - Small fixes and improvements to the tests. + + * Translations: + + - Fixed a mistake that caused one of the error messages to not + be translated. This only affected versions 5.4.2 and 5.4.3. + + - Updated the Chinese (simplified), Croatian, Esperanto, German, + Korean, Polish, Romanian, Spanish, Swedish, Ukrainian, and + Vietnamese translations. + + - Updated the German, Korean, Romanian, and Ukrainian man page + translations. + + +5.4.3 (2023-05-04) + + * All fixes from 5.2.12 + + * Features in the CMake build can now be disabled as CMake cache + variables, similar to the Autotools build. + + * Minor update to the Croatian translation. + + +5.4.2 (2023-03-18) + + * All fixes from 5.2.11 that were not included in 5.4.1. + + * If xz is built with support for the Capsicum sandbox but running + in an environment that doesn't support Capsicum, xz now runs + normally without sandboxing instead of exiting with an error. + + * liblzma: + + - Documentation was updated to improve the style, consistency, + and completeness of the liblzma API headers. + + - The Doxygen-generated HTML documentation for the liblzma API + header files is now included in the source release and is + installed as part of "make install". All JavaScript is + removed to simplify license compliance and to reduce the + install size. + + - Fixed a minor bug in lzma_str_from_filters() that produced + too many filters in the output string instead of reporting + an error if the input array had more than four filters. This + bug did not affect xz. + + * Build systems: + + - autogen.sh now invokes the doxygen tool via the new wrapper + script doxygen/update-doxygen, unless the command line option + --no-doxygen is used. + + - Added microlzma_encoder.c and microlzma_decoder.c to the + VS project files for Windows and to the CMake build. These + should have been included in 5.3.2alpha. + + * Tests: + + - Added a test to the CMake build that was forgotten in the + previous release. + + - Added and refactored a few tests. + + * Translations: + + - Updated the Brazilian Portuguese translation. + + - Added Brazilian Portuguese man page translation. + + +5.4.1 (2023-01-11) + + * liblzma: + + - Fixed the return value of lzma_microlzma_encoder() if the + LZMA options lc/lp/pb are invalid. Invalid lc/lp/pb options + made the function return LZMA_STREAM_END without encoding + anything instead of returning LZMA_OPTIONS_ERROR. + + - Windows / Visual Studio: Workaround a possible compiler bug + when targeting 32-bit x86 and compiling the CLMUL version of + the CRC64 code. The CLMUL code isn't enabled by the Windows + project files but it is in the CMake-based builds. + + * Build systems: + + - Windows-specific CMake changes: + + * Don't try to enable CLMUL CRC64 code if _mm_set_epi64x() + isn't available. This fixes CMake-based build with Visual + Studio 2013. + + * Created a workaround for a build failure with windres + from GNU binutils. It is used only when the C compiler + is GCC (not Clang). The workaround is incompatible + with llvm-windres, resulting in "XZx20Utils" instead + of "XZ Utils" in the resource file, but without the + workaround llvm-windres works correctly. See the + comment in CMakeLists.txt for details. + + * Included the resource files in the xz and xzdec build + rules. Building the command line tools is still + experimental but possible with MinGW-w64. + + - Visual Studio: Added stream_decoder_mt.c to the project + files. Now the threaded decompressor lzma_stream_decoder_mt() + gets built. CMake-based build wasn't affected. + + - Updated windows/INSTALL-MSVC.txt to mention that CMake-based + build is now the preferred method with Visual Studio. The + project files will probably be removed after 5.4.x releases. + + - Changes to #defines in config.h: + + * HAVE_DECL_CLOCK_MONOTONIC was replaced by + HAVE_CLOCK_MONOTONIC. The old macro was always defined + in configure-generated config.h to either 0 or 1. The + new macro is defined (to 1) only if the declaration of + CLOCK_MONOTONIC is available. This matches the way most + other config.h macros work and makes things simpler with + other build systems. + + * HAVE_DECL_PROGRAM_INVOCATION_NAME was replaced by + HAVE_PROGRAM_INVOCATION_NAME for the same reason. + + * Tests: + + - Fixed test script compatibility with ancient /bin/sh + versions. Now the five test_compress_* tests should + no longer fail on Solaris 10. + + - Added and refactored a few tests. + + * Translations: + + - Updated the Catalan and Esperanto translations. + + - Added Korean and Ukrainian man page translations. + + +5.4.0 (2022-12-13) + + This bumps the minor version of liblzma because new features were + added. The API and ABI are still backward compatible with liblzma + 5.2.x and 5.0.x. + + Since 5.3.5beta: + + * All fixes from 5.2.10. + + * The ARM64 filter is now stable. The xz option is now --arm64. + Decompression requires XZ Utils 5.4.0. In the future the ARM64 + filter will be supported by XZ for Java, XZ Embedded (including + the version in Linux), LZMA SDK, and 7-Zip. + + * Translations: + + - Updated Catalan, Croatian, German, Romanian, and Turkish + translations. + + - Updated German man page translations. + + - Added Romanian man page translations. + + Summary of new features added in the 5.3.x development releases: + + * liblzma: + + - Added threaded .xz decompressor lzma_stream_decoder_mt(). + It can use multiple threads with .xz files that have multiple + Blocks with size information in Block Headers. The threaded + encoder in xz has always created such files. + + Single-threaded encoder cannot store the size information in + Block Headers even if one used LZMA_FULL_FLUSH to create + multiple Blocks, so this threaded decoder cannot use multiple + threads with such files. + + If there are multiple Streams (concatenated .xz files), one + Stream will be decompressed completely before starting the + next Stream. + + - A new decoder flag LZMA_FAIL_FAST was added. It makes the + threaded decompressor report errors soon instead of first + flushing all pending data before the error location. + + - New Filter IDs: + * LZMA_FILTER_ARM64 is for ARM64 binaries. + * LZMA_FILTER_LZMA1EXT is for raw LZMA1 streams that don't + necessarily use the end marker. + + - Added lzma_str_to_filters(), lzma_str_from_filters(), and + lzma_str_list_filters() to convert a preset or a filter chain + string to a lzma_filter[] and vice versa. These should make + it easier to write applications that allow users to specify + custom compression options. + + - Added lzma_filters_free() which can be convenient for freeing + the filter options in a filter chain (an array of lzma_filter + structures). + + - lzma_file_info_decoder() to makes it a little easier to get + the Index field from .xz files. This helps in getting the + uncompressed file size but an easy-to-use random access + API is still missing which has existed in XZ for Java for + a long time. + + - Added lzma_microlzma_encoder() and lzma_microlzma_decoder(). + It is used by erofs-utils and may be used by others too. + + The MicroLZMA format is a raw LZMA stream (without end marker) + whose first byte (always 0x00) has been replaced with + bitwise-negation of the LZMA properties (lc/lp/pb). It was + created for use in EROFS but may be used in other contexts + as well where it is important to avoid wasting bytes for + stream headers or footers. The format is also supported by + XZ Embedded (the XZ Embedded version in Linux got MicroLZMA + support in Linux 5.16). + + The MicroLZMA encoder API in liblzma can compress into a + fixed-sized output buffer so that as much data is compressed + as can be fit into the buffer while still creating a valid + MicroLZMA stream. This is needed for EROFS. + + - Added lzma_lzip_decoder() to decompress the .lz (lzip) file + format version 0 and the original unextended version 1 files. + Also lzma_auto_decoder() supports .lz files. + + - lzma_filters_update() can now be used with the multi-threaded + encoder (lzma_stream_encoder_mt()) to change the filter chain + after LZMA_FULL_BARRIER or LZMA_FULL_FLUSH. + + - In lzma_options_lzma, allow nice_len = 2 and 3 with the match + finders that require at least 3 or 4. Now it is internally + rounded up if needed. + + - CLMUL-based CRC64 on x86-64 and E2K with runtime processor + detection. On 32-bit x86 it currently isn't available unless + --disable-assembler is used which can make the non-CLMUL + CRC64 slower; this might be fixed in the future. + + - Building with --disable-threads --enable-small + is now thread-safe if the compiler supports + __attribute__((__constructor__)). + + * xz: + + - Using -T0 (--threads=0) will now use multi-threaded encoder + even on a single-core system. This is to ensure that output + from the same xz binary is identical on both single-core and + multi-core systems. + + - --threads=+1 or -T+1 is now a way to put xz into + multi-threaded mode while using only one worker thread. + The + is ignored if the number is not 1. + + - A default soft memory usage limit is now used for compression + when -T0 is used and no explicit limit has been specified. + This soft limit is used to restrict the number of threads + but if the limit is exceeded with even one thread then xz + will continue with one thread using the multi-threaded + encoder and this limit is ignored. If the number of threads + is specified manually then no default limit will be used; + this affects only -T0. + + This change helps on systems that have very many cores and + using all of them for xz makes no sense. Previously xz -T0 + could run out of memory on such systems because it attempted + to reserve memory for too many threads. + + This also helps with 32-bit builds which don't have a large + amount of address space that would be required for many + threads. The default soft limit for -T0 is at most 1400 MiB + on all 32-bit platforms. + + - Previously a low value in --memlimit-compress wouldn't cause + xz to switch from multi-threaded mode to single-threaded mode + if the limit cannot otherwise be met; xz failed instead. Now + xz can switch to single-threaded mode and then, if needed, + scale down the LZMA2 dictionary size too just like it already + did when it was started in single-threaded mode. + + - The option --no-adjust no longer prevents xz from scaling down + the number of threads as that doesn't affect the compressed + output (only performance). Now --no-adjust only prevents + adjustments that affect compressed output, that is, with + --no-adjust xz won't switch from multi-threaded mode to + single-threaded mode and won't scale down the LZMA2 + dictionary size. + + - Added a new option --memlimit-mt-decompress=LIMIT. This is + used to limit the number of decompressor threads (possibly + falling back to single-threaded mode) but it will never make + xz refuse to decompress a file. This has a system-specific + default value because without any limit xz could end up + allocating memory for the whole compressed input file, the + whole uncompressed output file, multiple thread-specific + decompressor instances and so on. Basically xz could + attempt to use an insane amount of memory even with fairly + common files. The system-specific default value is currently + the same as the one used for compression with -T0. + + The new option works together with the existing option + --memlimit-decompress=LIMIT. The old option sets a hard limit + that must not be exceeded (xz will refuse to decompress) + while the new option only restricts the number of threads. + If the limit set with --memlimit-mt-decompress is greater + than the limit set with --memlimit-compress, then the latter + value is used also for --memlimit-mt-decompress. + + - Added new information to the output of xz --info-memory and + new fields to the output of xz --robot --info-memory. + + - In --lzma2=nice=NUMBER allow 2 and 3 with all match finders + now that liblzma handles it. + + - Don't mention endianness for ARM and ARM-Thumb filters in + --long-help. The filters only work for little endian + instruction encoding but modern ARM processors using + big endian data access still use little endian + instruction encoding. So the help text was misleading. + In contrast, the PowerPC filter is only for big endian + 32/64-bit PowerPC code. Little endian PowerPC would need + a separate filter. + + - Added decompression support for the .lz (lzip) file format + version 0 and the original unextended version 1. It is + autodetected by default. See also the option --format on + the xz man page. + + - Sandboxing enabled by default: + * Capsicum (FreeBSD) + * pledge(2) (OpenBSD) + + * Scripts now support the .lz format using xz. + + * A few new tests were added. + + * The liblzma-specific tests are now supported in CMake-based + builds too ("make test"). + + +5.3.5beta (2022-12-01) + + * All fixes from 5.2.9. + + * liblzma: + + - Added new LZMA_FILTER_LZMA1EXT for raw encoder and decoder to + handle raw LZMA1 streams that don't have end of payload marker + (EOPM) alias end of stream (EOS) marker. It can be used in + filter chains, for example, with the x86 BCJ filter. + + - Added lzma_str_to_filters(), lzma_str_from_filters(), and + lzma_str_list_filters() to make it easier for applications + to get custom compression options from a user and convert + it to an array of lzma_filter structures. + + - Added lzma_filters_free(). + + - lzma_filters_update() can now be used with the multi-threaded + encoder (lzma_stream_encoder_mt()) to change the filter chain + after LZMA_FULL_BARRIER or LZMA_FULL_FLUSH. + + - In lzma_options_lzma, allow nice_len = 2 and 3 with the match + finders that require at least 3 or 4. Now it is internally + rounded up if needed. + + - ARM64 filter was modified. It is still experimental. + + - Fixed LTO build with Clang if -fgnuc-version=10 or similar + was used to make Clang look like GCC >= 10. Now it uses + __has_attribute(__symver__) which should be reliable. + + * xz: + + - --threads=+1 or -T+1 is now a way to put xz into multi-threaded + mode while using only one worker thread. + + - In --lzma2=nice=NUMBER allow 2 and 3 with all match finders + now that liblzma handles it. + + * Updated translations: Chinese (simplified), Korean, and Turkish. + + +5.3.4alpha (2022-11-15) + + * All fixes from 5.2.7 and 5.2.8. + + * liblzma: + + - Minor improvements to the threaded decoder. + + - Added CRC64 implementation that uses SSSE3, SSE4.1, and CLMUL + instructions on 32/64-bit x86 and E2K. On 32-bit x86 it's + not enabled unless --disable-assembler is used but then + the non-CLMUL code might be slower. Processor support is + detected at runtime so this is built by default on x86-64 + and E2K. On these platforms, if compiler flags indicate + unconditional CLMUL support (-msse4.1 -mpclmul) then the + generic version is not built, making liblzma 8-9 KiB smaller + compared to having both versions included. + + With extremely compressible files this can make decompression + up to twice as fast but with typical files 5 % improvement + is a more realistic expectation. + + The CLMUL version is slower than the generic version with + tiny inputs (especially at 1-8 bytes per call, but up to + 16 bytes). In normal use in xz this doesn't matter at all. + + - Added an experimental ARM64 filter. This is *not* the final + version! Files created with this experimental version won't + be supported in the future versions! The filter design is + a compromise where improving one use case makes some other + cases worse. + + - Added decompression support for the .lz (lzip) file format + version 0 and the original unextended version 1. See the + API docs of lzma_lzip_decoder() for details. Also + lzma_auto_decoder() supports .lz files. + + - Building with --disable-threads --enable-small + is now thread-safe if the compiler supports + __attribute__((__constructor__)) + + * xz: + + - Added support for OpenBSD's pledge(2) as a sandboxing method. + + - Don't mention endianness for ARM and ARM-Thumb filters in + --long-help. The filters only work for little endian + instruction encoding but modern ARM processors using + big endian data access still use little endian + instruction encoding. So the help text was misleading. + In contrast, the PowerPC filter is only for big endian + 32/64-bit PowerPC code. Little endian PowerPC would need + a separate filter. + + - Added --experimental-arm64. This will be renamed once the + filter is finished. Files created with this experimental + filter will not be supported in the future! + + - Added new fields to the output of xz --robot --info-memory. + + - Added decompression support for the .lz (lzip) file format + version 0 and the original unextended version 1. It is + autodetected by default. See also the option --format on + the xz man page. + + * Scripts now support the .lz format using xz. + + * Build systems: + + - New #defines in config.h: HAVE_ENCODER_ARM64, + HAVE_DECODER_ARM64, HAVE_LZIP_DECODER, HAVE_CPUID_H, + HAVE_FUNC_ATTRIBUTE_CONSTRUCTOR, HAVE_USABLE_CLMUL + + - New configure options: --disable-clmul-crc, + --disable-microlzma, --disable-lzip-decoder, and + 'pledge' is now an option in --enable-sandbox (but + it's autodetected by default anyway). + + - INSTALL was updated to document the new configure options. + + - PACKAGERS now lists also --disable-microlzma and + --disable-lzip-decoder as configure options that must + not be used in builds for non-embedded use. + + * Tests: + + - Fix some of the tests so that they skip instead of fail if + certain features have been disabled with configure options. + It's still not perfect. + + - Other improvements to tests. + + * Updated translations: Croatian, Finnish, Hungarian, Polish, + Romanian, Spanish, Swedish, and Ukrainian. + + +5.3.3alpha (2022-08-22) + + * All fixes from 5.2.6. + + * liblzma: + + - Fixed 32-bit build. + + - Added threaded .xz decompressor lzma_stream_decoder_mt(). + It can use multiple threads with .xz files that have multiple + Blocks with size information in Block Headers. The threaded + encoder in xz has always created such files. + + Single-threaded encoder cannot store the size information in + Block Headers even if one used LZMA_FULL_FLUSH to create + multiple Blocks, so this threaded decoder cannot use multiple + threads with such files. + + If there are multiple Streams (concatenated .xz files), one + Stream will be decompressed completely before starting the + next Stream. + + - A new decoder flag LZMA_FAIL_FAST was added. It makes the + threaded decompressor report errors soon instead of first + flushing all pending data before the error location. + + * xz: + + - Using -T0 (--threads=0) will now use multi-threaded encoder + even on a single-core system. This is to ensure that output + from the same xz binary is identical on both single-core and + multi-core systems. + + - A default soft memory usage limit is now used for compression + when -T0 is used and no explicit limit has been specified. + This soft limit is used to restrict the number of threads + but if the limit is exceeded with even one thread then xz + will continue with one thread using the multi-threaded + encoder and this limit is ignored. If the number of threads + is specified manually then no default limit will be used; + this affects only -T0. + + This change helps on systems that have very many cores and + using all of them for xz makes no sense. Previously xz -T0 + could run out of memory on such systems because it attempted + to reserve memory for too many threads. + + This also helps with 32-bit builds which don't have a large + amount of address space that would be required for many + threads. The default limit is 1400 MiB on all 32-bit + platforms with -T0. + + Now xz -T0 should just work. It might use too few threads + in some cases but at least it shouldn't easily run out of + memory. It's possible that this will be tweaked before 5.4.0. + + - Changes to --memlimit-compress and --no-adjust: + + In single-threaded mode, --memlimit-compress can make xz + scale down the LZMA2 dictionary size to meet the memory usage + limit. This obviously affects the compressed output. However, + if xz was in threaded mode, --memlimit-compress could make xz + reduce the number of threads but it wouldn't make xz switch + from multi-threaded mode to single-threaded mode or scale + down the LZMA2 dictionary size. This seemed illogical. + + Now --memlimit-compress can make xz switch to single-threaded + mode if one thread in multi-threaded mode uses too much + memory. If memory usage is still too high, then the LZMA2 + dictionary size can be scaled down too. + + The option --no-adjust was also changed so that it no longer + prevents xz from scaling down the number of threads as that + doesn't affect compressed output (only performance). After + this commit --no-adjust only prevents adjustments that affect + compressed output, that is, with --no-adjust xz won't switch + from multithreaded mode to single-threaded mode and won't + scale down the LZMA2 dictionary size. + + - Added a new option --memlimit-mt-decompress=LIMIT. This is + used to limit the number of decompressor threads (possibly + falling back to single-threaded mode) but it will never make + xz refuse to decompress a file. This has a system-specific + default value because without any limit xz could end up + allocating memory for the whole compressed input file, the + whole uncompressed output file, multiple thread-specific + decompressor instances and so on. Basically xz could + attempt to use an insane amount of memory even with fairly + common files. + + The new option works together with the existing option + --memlimit-decompress=LIMIT. The old option sets a hard limit + that must not be exceeded (xz will refuse to decompress) + while the new option only restricts the number of threads. + If the limit set with --memlimit-mt-decompress is greater + than the limit set with --memlimit-compress, then the latter + value is used also for --memlimit-mt-decompress. + + * Tests: + + - Added a few more tests. + + - Added tests/code_coverage.sh to create a code coverage report + of the tests. + + * Build systems: + + - Automake's parallel test harness is now used to make tests + finish faster. + + - Added the CMake files to the distribution tarball. These were + supposed to be in 5.2.5 already. + + - Added liblzma tests to the CMake build. + + - Windows: Fix building of liblzma.dll with the included + Visual Studio project files. + + +5.3.2alpha (2021-10-28) + + This release was made on short notice so that recent erofs-utils can + be built with LZMA support without needing a snapshot from xz.git. + Thus many pending things were not included, not even updated + translations (which would need to be updated for the new --list + strings anyway). + + * All fixes from 5.2.5. + + * xz: + + - When copying metadata from the source file to the destination + file, don't try to set the group (GID) if it is already set + correctly. This avoids a failure on OpenBSD (and possibly on + a few other OSes) where files may get created so that their + group doesn't belong to the user, and fchown(2) can fail even + if it needs to do nothing. + + - The --keep option now accepts symlinks, hardlinks, and + setuid, setgid, and sticky files. Previously this required + using --force. + + - Split the long strings used in --list and --info-memory modes + to make them much easier for translators. + + - If built with sandbox support and enabling the sandbox fails, + xz will now immediately exit with exit status of 1. Previously + it would only display a warning if -vv was used. + + - Cap --memlimit-compress to 2000 MiB on MIPS32 because on + MIPS32 userspace processes are limited to 2 GiB of address + space. + + * liblzma: + + - Added lzma_microlzma_encoder() and lzma_microlzma_decoder(). + The API is in lzma/container.h. + + The MicroLZMA format is a raw LZMA stream (without end marker) + whose first byte (always 0x00) has been replaced with + bitwise-negation of the LZMA properties (lc/lp/pb). It was + created for use in EROFS but may be used in other contexts + as well where it is important to avoid wasting bytes for + stream headers or footers. The format is also supported by + XZ Embedded. + + The MicroLZMA encoder API in liblzma can compress into a + fixed-sized output buffer so that as much data is compressed + as can be fit into the buffer while still creating a valid + MicroLZMA stream. This is needed for EROFS. + + - Added fuzzing support. + + - Support Intel Control-flow Enforcement Technology (CET) in + 32-bit x86 assembly files. + + - Visual Studio: Use non-standard _MSVC_LANG to detect C++ + standard version in the lzma.h API header. It's used to + detect when "noexcept" can be used. + + * Scripts: + + - Fix exit status of xzdiff/xzcmp. Exit status could be 2 when + the correct value is 1. + + - Fix exit status of xzgrep. + + - Detect corrupt .bz2 files in xzgrep. + + - Add zstd support to xzgrep and xzdiff/xzcmp. + + - Fix less(1) version detection in xzless. It failed if the + version number from "less -V" contained a dot. + + * Fix typos and technical issues in man pages. + + * Build systems: + + - Windows: Fix building of resource files when config.h isn't + used. CMake + Visual Studio can now build liblzma.dll. + + - Various fixes to the CMake support. It might still need a few + more fixes even for liblzma-only builds. + + +5.3.1alpha (2018-04-29) + + * All fixes from 5.2.4. + + * Add lzma_file_info_decoder() into liblzma and use it in xz to + implement the --list feature. + + * Capsicum sandbox support is enabled by default where available + (FreeBSD >= 10). + + +5.2.13 (2024-05-29) + + * liblzma: + + - lzma_index_append(): Fix an assertion failure that could be + triggered by a large unpadded_size argument. It was verified + that there was no other bug than the assertion failure. + + - lzma_index_decoder() and lzma_index_buffer_decode(): Fix + a missing output pointer initialization (*i = NULL) if the + functions are called with invalid arguments. The API docs + say that such an initialization is always done. In practice + this matters very little because the problem can only occur + if the calling application has a bug and these functions + return LZMA_PROG_ERROR. + + - Fix C standard conformance with function pointer types. + This newly showed up with Clang 17 with -fsanitize=undefined. + There are no bug reports about this. + + - Fix building with NVIDIA HPC SDK. + + - Fix building with Windows Vista threads and --enable-small. + (CMake build doesn't support ENABLE_SMALL in XZ Utils 5.2.x.) + + * xz: + + - Fix a C standard conformance issue in --block-list parsing + (arithmetic on a null pointer). + + - Fix a warning from GNU groff when processing the man page: + "warning: cannot select font 'CW'" + + - Windows: Handle special files such as "con" or "nul". Earlier + the following wrote "foo" to the console and deleted the input + file "con_xz": + + echo foo | xz > con_xz + xz --suffix=_xz --decompress con_xz + + - Windows: Fix an issue that prevented reading from or writing + to non-terminal character devices like NUL. + + * xzless: + + - With "less" version 451 and later, use "||-" instead of "|-" + in the environment variable LESSOPEN. This way compressed + files that contain no uncompressed data are shown correctly + as empty. + + - With "less" version 632 and later, use --show-preproc-errors + to make "less" show a warning on decompression errors. + + * Build systems: + + - Add a new line to liblzma.pc for MSYS2 (Windows): + + Cflags.private: -DLZMA_API_STATIC + + When compiling code that will link against static liblzma, + the LZMA_API_STATIC macro needs to be defined on Windows. + + - Autotools (configure): + + * Symbol versioning variant can now be overridden with + --enable-symbol-versions. Documentation in INSTALL was + updated to match. + + - CMake: + + * Fix a bug that prevented other projects from including + liblzma multiple times using find_package(). + + * Fix a bug where configuring CMake multiple times resulted + in HAVE_CLOCK_GETTIME and HAVE_CLOCK_MONOTONIC not being + defined. + + * Fix the build with MinGW-w64-based Clang/LLVM 17. + llvm-windres now has more accurate GNU windres emulation + so the GNU windres workaround from 5.4.1 is needed with + llvm-windres version 17 too. + + * The import library on Windows is now properly named + "liblzma.dll.a" instead of "libliblzma.dll.a" + + * Add large file support by default for platforms that + need it to handle files larger than 2 GiB. This includes + MinGW-w64, even 64-bit builds. + + * Linux on MicroBlaze is handled specially now. This + matches the changes made to the Autotools-based build + in XZ Utils 5.4.2 and 5.2.11. + + * Disable symbol versioning on non-glibc Linux to match + what the Autotools build does. For example, symbol + versioning isn't enabled with musl. + + * Symbol versioning variant can now be overridden by + setting SYMBOL_VERSIONING to "OFF", "generic", or + "linux". + + * Documentation: + + - Clarify the description of --disable-assembler in INSTALL. + The option only affects 32-bit x86 assembly usage. + + - Don't install the TODO file as part of the documentation. + The file is out of date. + + - Update home page URLs back to their old locations on + tukaani.org. + + - Update maintainer info. + + +5.2.12 (2023-05-04) + + * Fixed a build system bug that prevented building liblzma as a + shared library when configured with --disable-threads. This bug + affected releases 5.2.6 to 5.2.11 and 5.4.0 to 5.4.2. + + * Include for Windows intrinsic functions where they are + needed. This fixed a bug that prevented building liblzma using + clang-cl on Windows. + + * Minor update to the Croatian translation. The small change + applies to a string in both 5.2 and 5.4 branches. + + +5.2.11 (2023-03-18) + + * Removed all possible cases of null pointer + 0. It is undefined + behavior in C99 and C17. This was detected by a sanitizer and had + not caused any known issues. + + * Build systems: + + - Added a workaround for building with GCC on MicroBlaze Linux. + GCC 12 on MicroBlaze doesn't support the __symver__ attribute + even though __has_attribute(__symver__) returns true. The + build is now done without the extra RHEL/CentOS 7 symbols + that were added in XZ Utils 5.2.7. The workaround only + applies to the Autotools build (not CMake). + + - CMake: Ensure that the C compiler language is set to C99 or + a newer standard. + + - CMake changes from XZ Utils 5.4.1: + + * Added a workaround for a build failure with + windres from GNU binutils. + + * Included the Windows resource files in the xz + and xzdec build rules. + + +5.2.10 (2022-12-13) + + * xz: Don't modify argv[] when parsing the --memlimit* and + --block-list command line options. This fixes confusing + arguments in process listing (like "ps auxf"). + + * GNU/Linux only: Use __has_attribute(__symver__) to detect if + that attribute is supported. This fixes build on Mandriva where + Clang is patched to define __GNUC__ to 11 by default (instead + of 4 as used by Clang upstream). + + +5.2.9 (2022-11-30) + + * liblzma: + + - Fixed an infinite loop in LZMA encoder initialization + if dict_size >= 2 GiB. (The encoder only supports up + to 1536 MiB.) + + - Fixed two cases of invalid free() that can happen if + a tiny allocation fails in encoder re-initialization + or in lzma_filters_update(). These bugs had some + similarities with the bug fixed in 5.2.7. + + - Fixed lzma_block_encoder() not allowing the use of + LZMA_SYNC_FLUSH with lzma_code() even though it was + documented to be supported. The sync-flush code in + the Block encoder was already used internally via + lzma_stream_encoder(), so this was just a missing flag + in the lzma_block_encoder() API function. + + - GNU/Linux only: Don't put symbol versions into static + liblzma as it breaks things in some cases (and even if + it didn't break anything, symbol versions in static + libraries are useless anyway). The downside of the fix + is that if the configure options --with-pic or --without-pic + are used then it's not possible to build both shared and + static liblzma at the same time on GNU/Linux anymore; + with those options --disable-static or --disable-shared + must be used too. + + * New email address for bug reports is which + forwards messages to Lasse Collin and Jia Tan. + + +5.2.8 (2022-11-13) + + * xz: + + - If xz cannot remove an input file when it should, this + is now treated as a warning (exit status 2) instead of + an error (exit status 1). This matches GNU gzip and it + is more logical as at that point the output file has + already been successfully closed. + + - Fix handling of .xz files with an unsupported check type. + Previously such printed a warning message but then xz + behaved as if an error had occurred (didn't decompress, + exit status 1). Now a warning is printed, decompression + is done anyway, and exit status is 2. This used to work + slightly before 5.0.0. In practice this bug matters only + if xz has been built with some check types disabled. As + instructed in PACKAGERS, such builds should be done in + special situations only. + + - Fix "xz -dc --single-stream tests/files/good-0-empty.xz" + which failed with "Internal error (bug)". That is, + --single-stream was broken if the first .xz stream in + the input file didn't contain any uncompressed data. + + - Fix displaying file sizes in the progress indicator when + working in passthru mode and there are multiple input files. + Just like "gzip -cdf", "xz -cdf" works like "cat" when the + input file isn't a supported compressed file format. In + this case the file size counters weren't reset between + files so with multiple input files the progress indicator + displayed an incorrect (too large) value. + + * liblzma: + + - API docs in lzma/container.h: + * Update the list of decoder flags in the decoder + function docs. + * Explain LZMA_CONCATENATED behavior with .lzma files + in lzma_auto_decoder() docs. + + - OpenBSD: Use HW_NCPUONLINE to detect the number of + available hardware threads in lzma_physmem(). + + - Fix use of wrong macro to detect x86 SSE2 support. + __SSE2_MATH__ was used with GCC/Clang but the correct + one is __SSE2__. The first one means that SSE2 is used + for floating point math which is irrelevant here. + The affected SSE2 code isn't used on x86-64 so this affects + only 32-bit x86 builds that use -msse2 without -mfpmath=sse + (there is no runtime detection for SSE2). It improves LZMA + compression speed (not decompression). + + - Fix the build with Intel C compiler 2021 (ICC, not ICX) + on Linux. It defines __GNUC__ to 10 but doesn't support + the __symver__ attribute introduced in GCC 10. + + * Scripts: Ignore warnings from xz by using --quiet --no-warn. + This is needed if the input .xz files use an unsupported + check type. + + * Translations: + + - Updated Croatian and Turkish translations. + + - One new translations wasn't included because it needed + technical fixes. It will be in upcoming 5.4.0. No new + translations will be added to the 5.2.x branch anymore. + + - Renamed the French man page translation file from + fr_FR.po to fr.po and thus also its install directory + (like /usr/share/man/fr_FR -> .../fr). + + - Man page translations for upcoming 5.4.0 are now handled + in the Translation Project. + + * Update doc/faq.txt a little so it's less out-of-date. + + +5.2.7 (2022-09-30) + + * liblzma: + + - Made lzma_filters_copy() to never modify the destination + array if an error occurs. lzma_stream_encoder() and + lzma_stream_encoder_mt() already assumed this. Before this + change, if a tiny memory allocation in lzma_filters_copy() + failed it would lead to a crash (invalid free() or invalid + memory reads) in the cleanup paths of these two encoder + initialization functions. + + - Added missing integer overflow check to lzma_index_append(). + This affects xz --list and other applications that decode + the Index field from .xz files using lzma_index_decoder(). + Normal decompression of .xz files doesn't call this code + and thus most applications using liblzma aren't affected + by this bug. + + - Single-threaded .xz decoder (lzma_stream_decoder()): If + lzma_code() returns LZMA_MEMLIMIT_ERROR it is now possible + to use lzma_memlimit_set() to increase the limit and continue + decoding. This was supposed to work from the beginning + but there was a bug. With other decoders (.lzma or + threaded .xz decoder) this already worked correctly. + + - Fixed accumulation of integrity check type statistics in + lzma_index_cat(). This bug made lzma_index_checks() return + only the type of the integrity check of the last Stream + when multiple lzma_indexes were concatenated. Most + applications don't use these APIs but in xz it made + xz --list not list all check types from concatenated .xz + files. In xz --list --verbose only the per-file "Check:" + lines were affected and in xz --robot --list only the "file" + line was affected. + + - Added ABI compatibility with executables that were linked + against liblzma in RHEL/CentOS 7 or other liblzma builds + that had copied the problematic patch from RHEL/CentOS 7 + (xz-5.2.2-compat-libs.patch). For the details, see the + comment at the top of src/liblzma/validate_map.sh. + + WARNING: This uses __symver__ attribute with GCC >= 10. + In other cases the traditional __asm__(".symver ...") + is used. Using link-time optimization (LTO, -flto) with + GCC versions older than 10 can silently result in + broken liblzma.so.5 (incorrect symbol versions)! If you + want to use -flto with GCC, you must use GCC >= 10. + LTO with Clang seems to work even with the traditional + __asm__(".symver ...") method. + + * xzgrep: Fixed compatibility with old shells that break if + comments inside command substitutions have apostrophes ('). + This problem was introduced in 5.2.6. + + * Build systems: + + - New #define in config.h: HAVE_SYMBOL_VERSIONS_LINUX + + - Windows: Fixed liblzma.dll build with Visual Studio project + files. It broke in 5.2.6 due to a change that was made to + improve CMake support. + + - Windows: Building liblzma with UNICODE defined should now + work. + + - CMake files are now actually included in the release tarball. + They should have been in 5.2.5 already. + + - Minor CMake fixes and improvements. + + * Added a new translation: Turkish + + +5.2.6 (2022-08-12) + + * xz: + + - The --keep option now accepts symlinks, hardlinks, and + setuid, setgid, and sticky files. Previously this required + using --force. + + - When copying metadata from the source file to the destination + file, don't try to set the group (GID) if it is already set + correctly. This avoids a failure on OpenBSD (and possibly on + a few other OSes) where files may get created so that their + group doesn't belong to the user, and fchown(2) can fail even + if it needs to do nothing. + + - Cap --memlimit-compress to 2000 MiB instead of 4020 MiB on + MIPS32 because on MIPS32 userspace processes are limited + to 2 GiB of address space. + + * liblzma: + + - Fixed a missing error-check in the threaded encoder. If a + small memory allocation fails, a .xz file with an invalid + Index field would be created. Decompressing such a file would + produce the correct output but result in an error at the end. + Thus this is a "mild" data corruption bug. Note that while + a failed memory allocation can trigger the bug, it cannot + cause invalid memory access. + + - The decoder for .lzma files now supports files that have + uncompressed size stored in the header and still use the + end of payload marker (end of stream marker) at the end + of the LZMA stream. Such files are rare but, according to + the documentation in LZMA SDK, they are valid. + doc/lzma-file-format.txt was updated too. + + - Improved 32-bit x86 assembly files: + * Support Intel Control-flow Enforcement Technology (CET) + * Use non-executable stack on FreeBSD. + + - Visual Studio: Use non-standard _MSVC_LANG to detect C++ + standard version in the lzma.h API header. It's used to + detect when "noexcept" can be used. + + * xzgrep: + + - Fixed arbitrary command injection via a malicious filename + (CVE-2022-1271, ZDI-CAN-16587). A standalone patch for + this was released to the public on 2022-04-07. A slight + robustness improvement has been made since then and, if + using GNU or *BSD grep, a new faster method is now used + that doesn't use the old sed-based construct at all. This + also fixes bad output with GNU grep >= 3.5 (2020-09-27) + when xzgrepping binary files. + + This vulnerability was discovered by: + cleemy desu wayo working with Trend Micro Zero Day Initiative + + - Fixed detection of corrupt .bz2 files. + + - Improved error handling to fix exit status in some situations + and to fix handling of signals: in some situations a signal + didn't make xzgrep exit when it clearly should have. It's + possible that the signal handling still isn't quite perfect + but hopefully it's good enough. + + - Documented exit statuses on the man page. + + - xzegrep and xzfgrep now use "grep -E" and "grep -F" instead + of the deprecated egrep and fgrep commands. + + - Fixed parsing of the options -E, -F, -G, -P, and -X. The + problem occurred when multiple options were specified in + a single argument, for example, + + echo foo | xzgrep -Fe foo + + treated foo as a filename because -Fe wasn't correctly + split into -F -e. + + - Added zstd support. + + * xzdiff/xzcmp: + + - Fixed wrong exit status. Exit status could be 2 when the + correct value is 1. + + - Documented on the man page that exit status of 2 is used + for decompression errors. + + - Added zstd support. + + * xzless: + + - Fix less(1) version detection. It failed if the version number + from "less -V" contained a dot. + + * Translations: + + - Added new translations: Catalan, Croatian, Esperanto, + Korean, Portuguese, Romanian, Serbian, Spanish, Swedish, + and Ukrainian + + - Updated the Brazilian Portuguese translation. + + - Added French man page translation. This and the existing + German translation aren't complete anymore because the + English man pages got a few updates and the translators + weren't reached so that they could update their work. + + * Build systems: + + - Windows: Fix building of resource files when config.h isn't + used. CMake + Visual Studio can now build liblzma.dll. + + - Various fixes to the CMake support. Building static or shared + liblzma should work fine in most cases. In contrast, building + the command line tools with CMake is still clearly incomplete + and experimental and should be used for testing only. + + +5.2.5 (2020-03-17) + + * liblzma: + + - Fixed several C99/C11 conformance bugs. Now the code is clean + under gcc/clang -fsanitize=undefined. Some of these changes + might have a negative effect on performance with old GCC + versions or compilers other than GCC and Clang. The configure + option --enable-unsafe-type-punning can be used to (mostly) + restore the old behavior but it shouldn't normally be used. + + - Improved API documentation of lzma_properties_decode(). + + - Added a very minor encoder speed optimization. + + * xz: + + - Fixed a crash in "xz -dcfv not_an_xz_file". All four options + were required to trigger it. The crash occurred in the + progress indicator code when xz was in passthru mode where + xz works like "cat". + + - Fixed an integer overflow with 32-bit off_t. It could happen + when decompressing a file that has a long run of zero bytes + which xz would try to write as a sparse file. Since the build + system enables large file support by default, off_t is + normally 64-bit even on 32-bit systems. + + - Fixes for --flush-timeout: + * Fix semi-busy-waiting. + * Avoid unneeded flushes when no new input has arrived + since the previous flush was completed. + + - Added a special case for 32-bit xz: If --memlimit-compress is + used to specify a limit that exceeds 4020 MiB, the limit will + be set to 4020 MiB. The values "0" and "max" aren't affected + by this and neither is decompression. This hack can be + helpful when a 32-bit xz has access to 4 GiB address space + but the specified memlimit exceeds 4 GiB. This can happen + e.g. with some scripts. + + - Capsicum sandbox is now enabled by default where available + (FreeBSD >= 10). The sandbox debug messages (xz -vv) were + removed since they seemed to be more annoying than useful. + + - DOS build now requires DJGPP 2.05 instead of 2.04beta. + A workaround for a locale problem with DJGPP 2.05 was added. + + * xzgrep and other scripts: + + - Added a configure option --enable-path-for-scripts=PREFIX. + It is disabled by default except on Solaris where the default + is /usr/xpg4/bin. See INSTALL for details. + + - Added a workaround for a POSIX shell detection problem on + Solaris. + + * Build systems: + + - Added preliminary build instructions for z/OS. See INSTALL + section 1.2.9. + + - Experimental CMake support was added. It should work to build + static liblzma on a few operating systems. It may or may not + work to build shared liblzma. On some platforms it can build + xz and xzdec too but those are only for testing. See the + comment in the beginning of CMakeLists.txt for details. + + - Visual Studio project files were updated. + WindowsTargetPlatformVersion was removed from VS2017 files + and set to "10.0" in the added VS2019 files. In the future + the VS project files will be removed when CMake support is + good enough. + + - New #defines in config.h: HAVE___BUILTIN_ASSUME_ALIGNED, + HAVE___BUILTIN_BSWAPXX, and TUKLIB_USE_UNSAFE_TYPE_PUNNING. + + - autogen.sh has a new optional dependency on po4a and a new + option --no-po4a to skip that step. This matters only if one + wants to remake the build files. po4a is used to update the + translated man pages but as long as the man pages haven't + been modified, there's nothing to update and one can use + --no-po4a to avoid the dependency on po4a. + + * Translations: + + - XZ Utils translations are now handled by the Translation + Project: https://translationproject.org/domain/xz.html + + - All man pages are now included in German too. + + - New xz translations: Brazilian Portuguese, Finnish, + Hungarian, Chinese (simplified), Chinese (traditional), + and Danish (partial translation) + + - Updated xz translations: French, German, Italian, and Polish + + - Unfortunately a few new xz translations weren't included due + to technical problems like too long lines in --help output or + misaligned column headings in tables. In the future, many of + these strings will be split and e.g. the table column + alignment will be handled in software. This should make the + strings easier to translate. + + +5.2.4 (2018-04-29) + + * liblzma: + + - Allow 0 as memory usage limit instead of returning + LZMA_PROG_ERROR. Now 0 is treated as if 1 byte was specified, + which effectively is the same as 0. + + - Use "noexcept" keyword instead of "throw()" in the public + headers when a C++11 (or newer standard) compiler is used. + + - Added a portability fix for recent Intel C Compilers. + + - Microsoft Visual Studio build files have been moved under + windows/vs2013 and windows/vs2017. + + * xz: + + - Fix "xz --list --robot missing_or_bad_file.xz" which would + try to print an uninitialized string and thus produce garbage + output. Since the exit status is non-zero, most uses of such + a command won't try to interpret the garbage output. + + - "xz --list foo.xz" could print "Internal error (bug)" in a + corner case where a specific memory usage limit had been set. + + +5.2.3 (2016-12-30) + + * xz: + + - Always close a file before trying to delete it to avoid + problems on some operating system and file system combinations. + + - Fixed copying of file timestamps on Windows. + + - Added experimental (disabled by default) sandbox support using + Capsicum (FreeBSD >= 10). See --enable-sandbox in INSTALL. + + * C99/C11 conformance fixes to liblzma. The issues affected at least + some builds using link-time optimizations. + + * Fixed bugs in the rarely-used function lzma_index_dup(). + + * Use of external SHA-256 code is now disabled by default. + It can still be enabled by passing --enable-external-sha256 + to configure. The reasons to disable it by default (see INSTALL + for more details): + + - Some OS-specific SHA-256 implementations conflict with + OpenSSL and cause problems in programs that link against both + liblzma and libcrypto. At least FreeBSD 10 and MINIX 3.3.0 + are affected. + + - The internal SHA-256 is faster than the SHA-256 code in + some operating systems. + + * Changed CPU core count detection to use sched_getaffinity() on + GNU/Linux and GNU/kFreeBSD. + + * Fixes to the build-system and xz to make xz buildable even when + encoders, decoders, or threading have been disabled from libilzma + using configure options. These fixes added two new #defines to + config.h: HAVE_ENCODERS and HAVE_DECODERS. + + +5.2.2 (2015-09-29) + + * Fixed bugs in QNX-specific code. + + * Omitted the use of pipe2() even if it is available to avoid + portability issues with some old Linux and glibc combinations. + + * Updated German translation. + + * Added project files to build static and shared liblzma (not the + whole XZ Utils) with Visual Studio 2013 update 2 or later. + + * Documented that threaded decompression hasn't been implemented + yet. A 5.2.0 NEWS entry describing multi-threading support had + incorrectly said "decompression" when it should have said + "compression". + + +5.2.1 (2015-02-26) + + * Fixed a compression-ratio regression in fast mode of LZMA1 and + LZMA2. The bug is present in 5.1.4beta and 5.2.0 releases. + + * Fixed a portability problem in xz that affected at least OpenBSD. + + * Fixed xzdiff to be compatible with FreeBSD's mktemp which differs + from most other mktemp implementations. + + * Changed CPU core count detection to use cpuset_getaffinity() on + FreeBSD. + + +5.2.0 (2014-12-21) + + Since 5.1.4beta: + + * All fixes from 5.0.8 + + * liblzma: Fixed lzma_stream_encoder_mt_memusage() when a preset + was used. + + * xzdiff: If mktemp isn't installed, mkdir will be used as + a fallback to create a temporary directory. Installing mktemp + is still recommended. + + * Updated French, German, Italian, Polish, and Vietnamese + translations. + + Summary of fixes and new features added in the 5.1.x development + releases: + + * liblzma: + + - Added support for multi-threaded compression. See the + lzma_mt structure, lzma_stream_encoder_mt(), and + lzma_stream_encoder_mt_memusage() in , + lzma_get_progress() in , and lzma_cputhreads() + in for details. + + - Made the uses of lzma_allocator const correct. + + - Added lzma_block_uncomp_encode() to create uncompressed + .xz Blocks using LZMA2 uncompressed chunks. + + - Added support for LZMA_IGNORE_CHECK. + + - A few speed optimizations were made. + + - Added support for symbol versioning. It is enabled by default + on GNU/Linux, other GNU-based systems, and FreeBSD. + + - liblzma (not the whole XZ Utils) should now be buildable + with MSVC 2013 update 2 or later using windows/config.h. + + * xz: + + - Fixed a race condition in the signal handling. It was + possible that e.g. the first SIGINT didn't make xz exit + if reading or writing blocked and one had bad luck. The fix + is non-trivial, so as of writing it is unknown if it will be + backported to the v5.0 branch. + + - Multi-threaded compression can be enabled with the + --threads (-T) option. + [Fixed: This originally said "decompression".] + + - New command line options in xz: --single-stream, + --block-size=SIZE, --block-list=SIZES, + --flush-timeout=TIMEOUT, and --ignore-check. + + - xz -lvv now shows the minimum xz version that is required to + decompress the file. Currently it is 5.0.0 for all supported + .xz files except files with empty LZMA2 streams require 5.0.2. + + * xzdiff and xzgrep now support .lzo files if lzop is installed. + The .tzo suffix is also recognized as a shorthand for .tar.lzo. + + +5.1.4beta (2014-09-14) + + * All fixes from 5.0.6 + + * liblzma: Fixed the use of presets in threaded encoder + initialization. + + * xz --block-list and --block-size can now be used together + in single-threaded mode. Previously the combination only + worked in multi-threaded mode. + + * Added support for LZMA_IGNORE_CHECK to liblzma and made it + available in xz as --ignore-check. + + * liblzma speed optimizations: + + - Initialization of a new LZMA1 or LZMA2 encoder has been + optimized. (The speed of reinitializing an already-allocated + encoder isn't affected.) This helps when compressing many + small buffers with lzma_stream_buffer_encode() and other + similar situations where an already-allocated encoder state + isn't reused. This speed-up is visible in xz too if one + compresses many small files one at a time instead running xz + once and giving all files as command-line arguments. + + - Buffer comparisons are now much faster when unaligned access + is allowed (configured with --enable-unaligned-access). This + speeds up encoding significantly. There is arch-specific code + for 32-bit and 64-bit x86 (32-bit needs SSE2 for the best + results and there's no run-time CPU detection for now). + For other archs there is only generic code which probably + isn't as optimal as arch-specific solutions could be. + + - A few speed optimizations were made to the SHA-256 code. + (Note that the builtin SHA-256 code isn't used on all + operating systems.) + + * liblzma can now be built with MSVC 2013 update 2 or later + using windows/config.h. + + * Vietnamese translation was added. + + +5.1.3alpha (2013-10-26) + + * All fixes from 5.0.5 + + * liblzma: + + - Fixed a deadlock in the threaded encoder. + + - Made the uses of lzma_allocator const correct. + + - Added lzma_block_uncomp_encode() to create uncompressed + .xz Blocks using LZMA2 uncompressed chunks. + + - Added support for native threads on Windows and the ability + to detect the number of CPU cores. + + * xz: + + - Fixed a race condition in the signal handling. It was + possible that e.g. the first SIGINT didn't make xz exit + if reading or writing blocked and one had bad luck. The fix + is non-trivial, so as of writing it is unknown if it will be + backported to the v5.0 branch. + + - Made the progress indicator work correctly in threaded mode. + + - Threaded encoder now works together with --block-list=SIZES. + + - Added preliminary support for --flush-timeout=TIMEOUT. + It can be useful for (somewhat) real-time streaming. For + now the decompression side has to be done with something + else than the xz tool due to how xz does buffering, but this + should be fixed. + + +5.1.2alpha (2012-07-04) + + * All fixes from 5.0.3 and 5.0.4 + + * liblzma: + + - Fixed a deadlock and an invalid free() in the threaded encoder. + + - Added support for symbol versioning. It is enabled by default + on GNU/Linux, other GNU-based systems, and FreeBSD. + + - Use SHA-256 implementation from the operating system if one is + available in libc, libmd, or libutil. liblzma won't use e.g. + OpenSSL or libgcrypt to avoid introducing new dependencies. + + - Fixed liblzma.pc for static linking. + + - Fixed a few portability bugs. + + * xz --decompress --single-stream now fixes the input position after + successful decompression. Now the following works: + + echo foo | xz > foo.xz + echo bar | xz >> foo.xz + ( xz -dc --single-stream ; xz -dc --single-stream ) < foo.xz + + Note that it doesn't work if the input is not seekable + or if there is Stream Padding between the concatenated + .xz Streams. + + * xz -lvv now shows the minimum xz version that is required to + decompress the file. Currently it is 5.0.0 for all supported .xz + files except files with empty LZMA2 streams require 5.0.2. + + * Added an *incomplete* implementation of --block-list=SIZES to xz. + It only works correctly in single-threaded mode and when + --block-size isn't used at the same time. --block-list allows + specifying the sizes of Blocks which can be useful e.g. when + creating files for random-access reading. + + +5.1.1alpha (2011-04-12) + + * All fixes from 5.0.2 + + * liblzma fixes that will also be included in 5.0.3: + + - A memory leak was fixed. + + - lzma_stream_buffer_encode() no longer creates an empty .xz + Block if encoding an empty buffer. Such an empty Block with + LZMA2 data would trigger a bug in 5.0.1 and older (see the + first bullet point in 5.0.2 notes). When releasing 5.0.2, + I thought that no encoder creates this kind of files but + I was wrong. + + - Validate function arguments better in a few functions. Most + importantly, specifying an unsupported integrity check to + lzma_stream_buffer_encode() no longer creates a corrupt .xz + file. Probably no application tries to do that, so this + shouldn't be a big problem in practice. + + - Document that lzma_block_buffer_encode(), + lzma_easy_buffer_encode(), lzma_stream_encoder(), and + lzma_stream_buffer_encode() may return LZMA_UNSUPPORTED_CHECK. + + - The return values of the _memusage() functions are now + documented better. + + * Support for multithreaded compression was added using the simplest + method, which splits the input data into blocks and compresses + them independently. Other methods will be added in the future. + The current method has room for improvement, e.g. it is possible + to reduce the memory usage. + + * Added the options --single-stream and --block-size=SIZE to xz. + + * xzdiff and xzgrep now support .lzo files if lzop is installed. + The .tzo suffix is also recognized as a shorthand for .tar.lzo. + + * Support for short 8.3 filenames under DOS was added to xz. It is + experimental and may change before it gets into a stable release. + + +5.0.8 (2014-12-21) + + * Fixed an old bug in xzgrep that affected OpenBSD and probably + a few other operating systems too. + + * Updated French and German translations. + + * Added support for detecting the amount of RAM on AmigaOS/AROS. + + * Minor build system updates. + + +5.0.7 (2014-09-20) + + * Fix regressions introduced in 5.0.6: + + - Fix building with non-GNU make. + + - Fix invalid Libs.private value in liblzma.pc which broke + static linking against liblzma if the linker flags were + taken from pkg-config. + + +5.0.6 (2014-09-14) + + * xzgrep now exits with status 0 if at least one file matched. + + * A few minor portability and build system fixes + + +5.0.5 (2013-06-30) + + * lzmadec and liblzma's lzma_alone_decoder(): Support decompressing + .lzma files that have less common settings in the headers + (dictionary size other than 2^n or 2^n + 2^(n-1), or uncompressed + size greater than 256 GiB). The limitations existed to avoid false + positives when detecting .lzma files. The lc + lp <= 4 limitation + still remains since liblzma's LZMA decoder has that limitation. + + NOTE: xz's .lzma support or liblzma's lzma_auto_decoder() are NOT + affected by this change. They still consider uncommon .lzma headers + as not being in the .lzma format. Changing this would give way too + many false positives. + + * xz: + + - Interaction of preset and custom filter chain options was + made less illogical. This affects only certain less typical + uses cases so few people are expected to notice this change. + + Now when a custom filter chain option (e.g. --lzma2) is + specified, all preset options (-0 ... -9, -e) earlier are on + the command line are completely forgotten. Similarly, when + a preset option is specified, all custom filter chain options + earlier on the command line are completely forgotten. + + Example 1: "xz -9 --lzma2=preset=5 -e" is equivalent to "xz -e" + which is equivalent to "xz -6e". Earlier -e didn't put xz back + into preset mode and thus the example command was equivalent + to "xz --lzma2=preset=5". + + Example 2: "xz -9e --lzma2=preset=5 -7" is equivalent to + "xz -7". Earlier a custom filter chain option didn't make + xz forget the -e option so the example was equivalent to + "xz -7e". + + - Fixes and improvements to error handling. + + - Various fixes to the man page. + + * xzless: Fixed to work with "less" versions 448 and later. + + * xzgrep: Made -h an alias for --no-filename. + + * Include the previously missing debug/translation.bash which can + be useful for translators. + + * Include a build script for Mac OS X. This has been in the Git + repository since 2010 but due to a mistake in Makefile.am the + script hasn't been included in a release tarball before. + + +5.0.4 (2012-06-22) + + * liblzma: + + - Fix lzma_index_init(). It could crash if memory allocation + failed. + + - Fix the possibility of an incorrect LZMA_BUF_ERROR when a BCJ + filter is used and the application only provides exactly as + much output space as is the uncompressed size of the file. + + - Fix a bug in doc/examples_old/xz_pipe_decompress.c. It didn't + check if the last call to lzma_code() really returned + LZMA_STREAM_END, which made the program think that truncated + files are valid. + + - New example programs in doc/examples (old programs are now in + doc/examples_old). These have more comments and more detailed + error handling. + + * Fix "xz -lvv foo.xz". It could crash on some corrupted files. + + * Fix output of "xz --robot -lv" and "xz --robot -lvv" which + incorrectly printed the filename also in the "foo (x/x)" format. + + * Fix exit status of "xzdiff foo.xz bar.xz". + + * Fix exit status of "xzgrep foo binary_file". + + * Fix portability to EBCDIC systems. + + * Fix a configure issue on AIX with the XL C compiler. See INSTALL + for details. + + * Update French, German, Italian, and Polish translations. + + +5.0.3 (2011-05-21) + + * liblzma fixes: + + - A memory leak was fixed. + + - lzma_stream_buffer_encode() no longer creates an empty .xz + Block if encoding an empty buffer. Such an empty Block with + LZMA2 data would trigger a bug in 5.0.1 and older (see the + first bullet point in 5.0.2 notes). When releasing 5.0.2, + I thought that no encoder creates this kind of files but + I was wrong. + + - Validate function arguments better in a few functions. Most + importantly, specifying an unsupported integrity check to + lzma_stream_buffer_encode() no longer creates a corrupt .xz + file. Probably no application tries to do that, so this + shouldn't be a big problem in practice. + + - Document that lzma_block_buffer_encode(), + lzma_easy_buffer_encode(), lzma_stream_encoder(), and + lzma_stream_buffer_encode() may return LZMA_UNSUPPORTED_CHECK. + + - The return values of the _memusage() functions are now + documented better. + + * Fix command name detection in xzgrep. xzegrep and xzfgrep now + correctly use egrep and fgrep instead of grep. + + * French translation was added. + + +5.0.2 (2011-04-01) + + * LZMA2 decompressor now correctly accepts LZMA2 streams with no + uncompressed data. Previously it considered them corrupt. The + bug can affect applications that use raw LZMA2 streams. It is + very unlikely to affect .xz files because no compressor creates + .xz files with empty LZMA2 streams. (Empty .xz files are a + different thing than empty LZMA2 streams.) + + * "xz --suffix=.foo filename.foo" now refuses to compress the + file due to it already having the suffix .foo. It was already + documented on the man page, but the code lacked the test. + + * "xzgrep -l foo bar.xz" works now. + + * Polish translation was added. + + +5.0.1 (2011-01-29) + + * xz --force now (de)compresses files that have setuid, setgid, + or sticky bit set and files that have multiple hard links. + The man page had it documented this way already, but the code + had a bug. + + * gzip and bzip2 support in xzdiff was fixed. + + * Portability fixes + + * Minor fix to Czech translation + + +5.0.0 (2010-10-23) + + Only the most important changes compared to 4.999.9beta are listed + here. One change is especially important: + + * The memory usage limit is now disabled by default. Some scripts + written before this change may have used --memory=max on xz command + line or in XZ_OPT. THESE USES OF --memory=max SHOULD BE REMOVED + NOW, because they interfere with user's ability to set the memory + usage limit himself. If user-specified limit causes problems to + your script, blame the user. + + Other significant changes: + + * Added support for XZ_DEFAULTS environment variable. This variable + allows users to set default options for xz, e.g. default memory + usage limit or default compression level. Scripts that use xz + must never set or unset XZ_DEFAULTS. Scripts should use XZ_OPT + instead if they need a way to pass options to xz via an + environment variable. + + * The compression settings associated with the preset levels + -0 ... -9 have been changed. --extreme was changed a little too. + It is now less likely to make compression worse, but with some + files the new --extreme may compress slightly worse than the old + --extreme. + + * If a preset level (-0 ... -9) is specified after a custom filter + chain options have been used (e.g. --lzma2), the custom filter + chain will be forgotten. Earlier the preset options were + completely ignored after custom filter chain options had been + seen. + + * xz will create sparse files when decompressing if the uncompressed + data contains long sequences of binary zeros. This is done even + when writing to standard output that is connected to a regular + file and certain additional conditions are met to make it safe. + + * Support for "xz --list" was added. Combine with --verbose or + --verbose --verbose (-vv) for detailed output. + + * I had hoped that liblzma API would have been stable after + 4.999.9beta, but there have been a couple of changes in the + advanced features, which don't affect most applications: + + - Index handling code was revised. If you were using the old + API, you will get a compiler error (so it's easy to notice). + + - A subtle but important change was made to the Block handling + API. lzma_block.version has to be initialized even for + lzma_block_header_decode(). Code that doesn't do it will work + for now, but might break in the future, which makes this API + change easy to miss. + + * The major soname has been bumped to 5.0.0. liblzma API and ABI + are now stable, so the need to recompile programs linking against + liblzma shouldn't arise soon. + diff --git a/miniconda3/envs/ladir/share/doc/xz/README b/miniconda3/envs/ladir/share/doc/xz/README new file mode 100644 index 0000000000000000000000000000000000000000..41671676a516e32c56c75c38c487f262dde4fa59 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/README @@ -0,0 +1,281 @@ + +XZ Utils +======== + + 0. Overview + 1. Documentation + 1.1. Overall documentation + 1.2. Documentation for command-line tools + 1.3. Documentation for liblzma + 2. Version numbering + 3. Reporting bugs + 4. Translations + 4.1. Testing translations + 5. Other implementations of the .xz format + 6. Contact information + + +0. Overview +----------- + + XZ Utils provide a general-purpose data-compression library plus + command-line tools. The native file format is the .xz format, but + also the legacy .lzma format is supported. The .xz format supports + multiple compression algorithms, which are called "filters" in the + context of XZ Utils. The primary filter is currently LZMA2. With + typical files, XZ Utils create about 30 % smaller files than gzip. + + To ease adapting support for the .xz format into existing applications + and scripts, the API of liblzma is somewhat similar to the API of the + popular zlib library. For the same reason, the command-line tool xz + has a command-line syntax similar to that of gzip. + + When aiming for the highest compression ratio, the LZMA2 encoder uses + a lot of CPU time and may use, depending on the settings, even + hundreds of megabytes of RAM. However, in fast modes, the LZMA2 encoder + competes with bzip2 in compression speed, RAM usage, and compression + ratio. + + LZMA2 is reasonably fast to decompress. It is a little slower than + gzip, but a lot faster than bzip2. Being fast to decompress means + that the .xz format is especially nice when the same file will be + decompressed very many times (usually on different computers), which + is the case e.g. when distributing software packages. In such + situations, it's not too bad if the compression takes some time, + since that needs to be done only once to benefit many people. + + With some file types, combining (or "chaining") LZMA2 with an + additional filter can improve the compression ratio. A filter chain may + contain up to four filters, although usually only one or two are used. + For example, putting a BCJ (Branch/Call/Jump) filter before LZMA2 + in the filter chain can improve compression ratio of executable files. + + Since the .xz format allows adding new filter IDs, it is possible that + some day there will be a filter that is, for example, much faster to + compress than LZMA2 (but probably with worse compression ratio). + Similarly, it is possible that some day there is a filter that will + compress better than LZMA2. + + XZ Utils supports multithreaded compression. XZ Utils doesn't support + multithreaded decompression yet. It has been planned though and taken + into account when designing the .xz file format. In the future, files + that were created in threaded mode can be decompressed in threaded + mode too. + + +1. Documentation +---------------- + +1.1. Overall documentation + + README This file + + INSTALL.generic Generic install instructions for those not + familiar with packages using GNU Autotools + INSTALL Installation instructions specific to XZ Utils + PACKAGERS Information to packagers of XZ Utils + + COPYING XZ Utils copyright and license information + COPYING.0BSD BSD Zero Clause License + COPYING.GPLv2 GNU General Public License version 2 + COPYING.GPLv3 GNU General Public License version 3 + COPYING.LGPLv2.1 GNU Lesser General Public License version 2.1 + + AUTHORS The main authors of XZ Utils + THANKS Incomplete list of people who have helped making + this software + NEWS User-visible changes between XZ Utils releases + ChangeLog Detailed list of changes (commit log) + TODO Known bugs and some sort of to-do list + + Note that only some of the above files are included in binary + packages. + + +1.2. Documentation for command-line tools + + The command-line tools are documented as man pages. In source code + releases (and possibly also in some binary packages), the man pages + are also provided in plain text (ASCII only) format in the directory + "doc/man" to make the man pages more accessible to those whose + operating system doesn't provide an easy way to view man pages. + + +1.3. Documentation for liblzma + + The liblzma API headers include short docs about each function + and data type as Doxygen tags. These docs should be quite OK as + a quick reference. + + There are a few example/tutorial programs that should help in + getting started with liblzma. In the source package the examples + are in "doc/examples" and in binary packages they may be under + "examples" in the same directory as this README. + + Since the liblzma API has similarities to the zlib API, some people + may find it useful to read the zlib docs and tutorial too: + + https://zlib.net/manual.html + https://zlib.net/zlib_how.html + + +2. Version numbering +-------------------- + + The version number format of XZ Utils is X.Y.ZS: + + - X is the major version. When this is incremented, the library + API and ABI break. + + - Y is the minor version. It is incremented when new features + are added without breaking the existing API or ABI. An even Y + indicates a stable release and an odd Y indicates unstable + (alpha or beta version). + + - Z is the revision. This has a different meaning for stable and + unstable releases: + + * Stable: Z is incremented when bugs get fixed without adding + any new features. This is intended to be convenient for + downstream distributors that want bug fixes but don't want + any new features to minimize the risk of introducing new bugs. + + * Unstable: Z is just a counter. API or ABI of features added + in earlier unstable releases having the same X.Y may break. + + - S indicates stability of the release. It is missing from the + stable releases, where Y is an even number. When Y is odd, S + is either "alpha" or "beta" to make it very clear that such + versions are not stable releases. The same X.Y.Z combination is + not used for more than one stability level, i.e. after X.Y.Zalpha, + the next version can be X.Y.(Z+1)beta but not X.Y.Zbeta. + + +3. Reporting bugs +----------------- + + Naturally it is easiest for me if you already know what causes the + unexpected behavior. Even better if you have a patch to propose. + However, quite often the reason for unexpected behavior is unknown, + so here are a few things to do before sending a bug report: + + 1. Try to create a small example how to reproduce the issue. + + 2. Compile XZ Utils with debugging code using configure switches + --enable-debug and, if possible, --disable-shared. If you are + using GCC, use CFLAGS='-O0 -ggdb3'. Don't strip the resulting + binaries. + + 3. Turn on core dumps. The exact command depends on your shell; + for example in GNU bash it is done with "ulimit -c unlimited", + and in tcsh with "limit coredumpsize unlimited". + + 4. Try to reproduce the suspected bug. If you get "assertion failed" + message, be sure to include the complete message in your bug + report. If the application leaves a coredump, get a backtrace + using gdb: + $ gdb /path/to/app-binary # Load the app to the debugger. + (gdb) core core # Open the coredump. + (gdb) bt # Print the backtrace. Copy & paste to bug report. + (gdb) quit # Quit gdb. + + Report your bug via email or IRC (see Contact information below). + Don't send core dump files or any executables. If you have a small + example file(s) (total size less than 256 KiB), please include + it/them as an attachment. If you have bigger test files, put them + online somewhere and include a URL to the file(s) in the bug report. + + Always include the exact version number of XZ Utils in the bug report. + If you are using a snapshot from the git repository, use "git describe" + to get the exact snapshot version. If you are using XZ Utils shipped + in an operating system distribution, mention the distribution name, + distribution version, and exact xz package version; if you cannot + repeat the bug with the code compiled from unpatched source code, + you probably need to report a bug to your distribution's bug tracking + system. + + +4. Translations +--------------- + + The xz command line tool and all man pages can be translated. + The translations are handled via the Translation Project. If you + wish to help translating xz, please join the Translation Project: + + https://translationproject.org/html/translators.html + + Updates to translations won't be accepted by methods that bypass + the Translation Project because there is a risk of duplicate work: + translation updates made in the xz repository aren't seen by the + translators in the Translation Project. If you have found bugs in + a translation, please report them to the Language-Team address + which can be found near the beginning of the PO file. + + If you find language problems in the original English strings, + feel free to suggest improvements. Ask if something is unclear. + + +4.1. Testing translations + + Testing can be done by installing xz into a temporary directory. + + If building from Git repository (not tarball), generate the + Autotools files: + + ./autogen.sh + + Create a subdirectory for the build files. The tmp-build directory + can be deleted after testing. + + mkdir tmp-build + cd tmp-build + ../configure --disable-shared --enable-debug --prefix=$PWD/inst + + Edit the .po file in the po directory. Then build and install to + the "tmp-build/inst" directory, and use translations.bash to see + how some of the messages look. Repeat these steps if needed: + + make -C po update-po + make -j"$(nproc)" install + bash ../debug/translation.bash | less + bash ../debug/translation.bash | less -S # For --list outputs + + To test other languages, set the LANGUAGE environment variable + before running translations.bash. The value should match the PO file + name without the .po suffix. Example: + + export LANGUAGE=fi + + +5. Other implementations of the .xz format +------------------------------------------ + + 7-Zip and the p7zip port of 7-Zip support the .xz format starting + from the version 9.00alpha. + + https://7-zip.org/ + https://p7zip.sourceforge.net/ + + XZ Embedded is a limited implementation written for use in the Linux + kernel, but it is also suitable for other embedded use. + + https://tukaani.org/xz/embedded.html + + XZ for Java is a complete implementation written in pure Java. + + https://tukaani.org/xz/java.html + + +6. Contact information +---------------------- + + XZ Utils in general: + - Home page: https://tukaani.org/xz/ + - Email to maintainer(s): xz@tukaani.org + - IRC: #tukaani on Libera Chat + - GitHub: https://github.com/tukaani-project/xz + + Lead maintainer: + - Email: Lasse Collin + - IRC: Larhzu on Libera Chat + diff --git a/miniconda3/envs/ladir/share/doc/xz/THANKS b/miniconda3/envs/ladir/share/doc/xz/THANKS new file mode 100644 index 0000000000000000000000000000000000000000..e1c21ebfe5d22a6683f30bef678c3414012de49f --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/THANKS @@ -0,0 +1,257 @@ + +Thanks +====== + +Some people have helped more, some less, but nevertheless everyone's help +has been important. :-) + - Adam Borowski + - Adam Walling + - Adrien Nader + - Agostino Sarubbo + - Alexander Bluhm + - Alexander M. Greenham + - Alexander Neumann + - Alexandre Sauvé + - Alexey Tourbin + - Anders F. Björklund + - Andraž 'ruskie' Levstik + - Andre Noll + - Andreas K. Hüttel + - Andreas Müller + - Andreas Schwab + - Andreas Zieringer + - Andrej Skenderija + - Andres Freund + - Andrew Dudman + - Andrew Murray + - Antoine Cœur + - Anton Kochkov + - Antonio Diaz Diaz + - Arkadiusz Miskiewicz + - Asgeir Storesund Nilsen + - Aziz Chaudhry + - Bela Lubkin + - Ben Boeckel + - Benjamin Buch + - Benno Schulenberg + - Bernhard Reutner-Fischer + - Bert Wesarg + - Bhargava Shastry + - Bill Glessner + - Bjarni Ingi Gislason + - Boud Roukema + - Brad Smith + - Bruce Stark + - Cary Lewis + - Charles Wilson + - Chenxi Mao + - Chien Wong + - Chris Donawa + - Chris McCrohan + - Christian Hesse + - Christian Kujau + - Christian von Roques + - Christian Weisgerber + - Christoph Junghans + - Collin Funk + - Conley Moorhous + - Cristian Rodríguez + - Cristiano Ceglia + - Dan Shechter + - Dan Stromberg + - Dan Weiss + - Daniel Leonard + - Daniel Mealha Cabrita + - Daniel Packard + - Daniel Richard G. + - David Burklund + - Denis Excoffier + - Derwin McGeary + - Dexter Castor Döpping + - Diederik de Haas + - Diego Elio Pettenò + - Dimitri Papadopoulos Orfanos + - Dirk Müller + - Douglas Thor + - Ed Maste + - Elbert Pol + - Eli Schwartz + - Elijah Almeida Coimbra + - Émilie Labbé + - Emmanuel Blot + - Eric Lindblad + - Eric S. Raymond + - Étienne Mollier + - Evan Nemerson + - Fangrui Song + - Felix Collin + - Filip Palian + - Firas Khalil Khana + - François Etcheverry + - Frank Busse + - Frank Prochnow + - Fredrik Wikstrom + - Gabi Davar + - Gabriela Gutierrez + - Gilles Espinasse + - Gregory Margo + - Guillaume Outters + - Guiorgy Potskhishvili + - H. Peter Anvin + - Hajin Jang + - Hans Jansen + - Harri K. Koskinen + - Hin-Tak Leung + - H.J. Lu + - Hongbo Ni + - Igor Pavlov + - İhsan Doğan + - Ilya Kurdyukov + - Iouri Kharon + - İsmail Dönmez + - Ivan A. Melnikov + - Jakub Bogusz + - James Buren + - James M Leddy + - Jan Kratochvil + - Jan Terje Hansen + - Jason Gorski + - Jeff Bastian + - Jeffrey Walton + - Jeroen Roovers + - Jim Meyering + - Jim Wilcoxson + - Joachim Henke + - John Paul Adrian Glaubitz + - Jonathan Nieder + - Jonathan Stott + - Joona Kannisto + - Jouk Jansen + - Juan Manuel Guerrero + - Jukka Salmi + - Julien Marrec + - Jun I Jin + - Kai Pastor + - Karl Beldan + - Karl Berry + - Keith Patton + - Kelvin Lee + - Kevin R. Bulgrien + - Kian-Meng Ang + - Kim Jinyeong + - Kirill A. Korinsky + - Kiyoshi Kanazawa + - Lars Wirzenius + - Li Chenggang + - Lizandro Heredia + - Loganaden Velvindron + - Lorenzo De Liso + - Lukas Braune + - Maarten Bosmans + - Maksym Vatsyk + - Marcin Kowalczyk + - Marcus Comstedt + - Marcus Tillmanns + - Marek Černocký + - Mark Adler + - Mark Wielaard + - Markus Duft + - Markus Rickert + - Martin Blumenstingl + - Martin Matuška + - Martin Storsjö + - Martin Väth + - Mathieu Vachon + - Matthew Good + - Matthieu Rakotojaona + - Melanie Blower + - Michael Felt + - Michael Fox + - Michał Górny + - Mike Frysinger + - Mikko Pouru + - Milo Casagrande + - Mohammed Adnène Trojette + - Nathan Moinvaziri + - Nelson H. F. Beebe + - Nicholas Jackson + - Ole André Vadla Ravnås + - Orange Tsai + - Orgad Shaneh + - Patrick J. Volkerding + - Paul Eggert + - Paul Townsend + - Pavel Raiskup + - Per Øyvind Karlsen + - Peter Ivanov + - Peter Lawler + - Peter O'Gorman + - Peter Pallinger + - Peter Seiderer + - Pierre-Yves Martin + - Pilorz Wojciech + - Pippijn van Steenhoven + - Rafał Mużyło + - Rainer Müller + - Ralf Wildenhues + - Rich Prohaska + - Richard Koch + - Richard W.M. Jones + - Robert Elz + - Robert Readman + - Roel Bouckaert + - Ron Desmond + - Ruarí Ødegaard + - Rui Paulo + - Ryan Colyer + - Ryan Young + - Sam James + - Scott McAllister + - Sean Fenian + - Sebastian Andrzej Siewior + - Sergey Kosukhin + - Simon Josefsson + - Siteshwar Vashisht + - Steffen Nurpmeso + - Stephan Kulow + - Stephen Sachs + - Stuart Shelton + - Taiki Tsunekawa + - Thomas Klausner + - Tobias Lahrmann Hansen + - Tobias Stoeckmann + - Tomasz Gajc + - Tomer Chachamu + - Torsten Rupp + - Trần Ngọc Quân + - Trent W. Buck + - Victoria Alexia + - Vijay Sarvepalli + - Ville Koskinen + - Ville Skyttä + - Vincent Cruz + - Vincent Fazio + - Vincent Lefevre + - Vincent Torri + - Vincent Wixsom + - Vincenzo Innocente + - Vitaly Chikunov + - Wim Lewis + - Xi Ruoyao + - Xin Li + - Yifeng Li + - 榆柳松 (ZhengSen Wang) + +Companies: + - Google + - Sandfly Security + +Other credits: + - cleemy desu wayo working with Trend Micro Zero Day Initiative + - Orange Tsai and splitline from DEVCORE Research Team + +Also thanks to all the people who have participated in the Tukaani project. + +I have probably forgot to add some names to the above list. Sorry about +that and thanks for your help. + diff --git a/miniconda3/envs/ladir/share/doc/xz/examples/00_README.txt b/miniconda3/envs/ladir/share/doc/xz/examples/00_README.txt new file mode 100644 index 0000000000000000000000000000000000000000..120e1eb7e7c507a8293a060767d60fcfac3babde --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/examples/00_README.txt @@ -0,0 +1,31 @@ + +liblzma example programs +======================== + +Introduction + + The examples are written so that the same comments aren't + repeated (much) in later files. + + On POSIX systems, the examples should build by just typing "make". + + The examples that use stdin or stdout don't set stdin and stdout + to binary mode. On systems where it matters (e.g. Windows) it is + possible that the examples won't work without modification. + + +List of examples + + 01_compress_easy.c Multi-call compression using + a compression preset + + 02_decompress.c Multi-call decompression + + 03_compress_custom.c Like 01_compress_easy.c but using + a custom filter chain + (x86 BCJ + LZMA2) + + 04_compress_easy_mt.c Multi-threaded multi-call + compression using a compression + preset + diff --git a/miniconda3/envs/ladir/share/doc/xz/examples/01_compress_easy.c b/miniconda3/envs/ladir/share/doc/xz/examples/01_compress_easy.c new file mode 100644 index 0000000000000000000000000000000000000000..31bcf928508afd0e63699114cf1fb2e944e7e1d8 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/examples/01_compress_easy.c @@ -0,0 +1,296 @@ +// SPDX-License-Identifier: 0BSD + +/////////////////////////////////////////////////////////////////////////////// +// +/// \file 01_compress_easy.c +/// \brief Compress from stdin to stdout in multi-call mode +/// +/// Usage: ./01_compress_easy PRESET < INFILE > OUTFILE +/// +/// Example: ./01_compress_easy 6 < foo > foo.xz +// +// Author: Lasse Collin +// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include +#include +#include + + +static void +show_usage_and_exit(const char *argv0) +{ + fprintf(stderr, "Usage: %s PRESET < INFILE > OUTFILE\n" + "PRESET is a number 0-9 and can optionally be " + "followed by 'e' to indicate extreme preset\n", + argv0); + exit(EXIT_FAILURE); +} + + +static uint32_t +get_preset(int argc, char **argv) +{ + // One argument whose first char must be 0-9. + if (argc != 2 || argv[1][0] < '0' || argv[1][0] > '9') + show_usage_and_exit(argv[0]); + + // Calculate the preste level 0-9. + uint32_t preset = argv[1][0] - '0'; + + // If there is a second char, it must be 'e'. It will set + // the LZMA_PRESET_EXTREME flag. + if (argv[1][1] != '\0') { + if (argv[1][1] != 'e' || argv[1][2] != '\0') + show_usage_and_exit(argv[0]); + + preset |= LZMA_PRESET_EXTREME; + } + + return preset; +} + + +static bool +init_encoder(lzma_stream *strm, uint32_t preset) +{ + // Initialize the encoder using a preset. Set the integrity to check + // to CRC64, which is the default in the xz command line tool. If + // the .xz file needs to be decompressed with XZ Embedded, use + // LZMA_CHECK_CRC32 instead. + lzma_ret ret = lzma_easy_encoder(strm, preset, LZMA_CHECK_CRC64); + + // Return successfully if the initialization went fine. + if (ret == LZMA_OK) + return true; + + // Something went wrong. The possible errors are documented in + // lzma/container.h (src/liblzma/api/lzma/container.h in the source + // package or e.g. /usr/include/lzma/container.h depending on the + // install prefix). + const char *msg; + switch (ret) { + case LZMA_MEM_ERROR: + msg = "Memory allocation failed"; + break; + + case LZMA_OPTIONS_ERROR: + msg = "Specified preset is not supported"; + break; + + case LZMA_UNSUPPORTED_CHECK: + msg = "Specified integrity check is not supported"; + break; + + default: + // This is most likely LZMA_PROG_ERROR indicating a bug in + // this program or in liblzma. It is inconvenient to have a + // separate error message for errors that should be impossible + // to occur, but knowing the error code is important for + // debugging. That's why it is good to print the error code + // at least when there is no good error message to show. + msg = "Unknown error, possibly a bug"; + break; + } + + fprintf(stderr, "Error initializing the encoder: %s (error code %u)\n", + msg, ret); + return false; +} + + +static bool +compress(lzma_stream *strm, FILE *infile, FILE *outfile) +{ + // This will be LZMA_RUN until the end of the input file is reached. + // This tells lzma_code() when there will be no more input. + lzma_action action = LZMA_RUN; + + // Buffers to temporarily hold uncompressed input + // and compressed output. + uint8_t inbuf[BUFSIZ]; + uint8_t outbuf[BUFSIZ]; + + // Initialize the input and output pointers. Initializing next_in + // and avail_in isn't really necessary when we are going to encode + // just one file since LZMA_STREAM_INIT takes care of initializing + // those already. But it doesn't hurt much and it will be needed + // if encoding more than one file like we will in 02_decompress.c. + // + // While we don't care about strm->total_in or strm->total_out in this + // example, it is worth noting that initializing the encoder will + // always reset total_in and total_out to zero. But the encoder + // initialization doesn't touch next_in, avail_in, next_out, or + // avail_out. + strm->next_in = NULL; + strm->avail_in = 0; + strm->next_out = outbuf; + strm->avail_out = sizeof(outbuf); + + // Loop until the file has been successfully compressed or until + // an error occurs. + while (true) { + // Fill the input buffer if it is empty. + if (strm->avail_in == 0 && !feof(infile)) { + strm->next_in = inbuf; + strm->avail_in = fread(inbuf, 1, sizeof(inbuf), + infile); + + if (ferror(infile)) { + fprintf(stderr, "Read error: %s\n", + strerror(errno)); + return false; + } + + // Once the end of the input file has been reached, + // we need to tell lzma_code() that no more input + // will be coming and that it should finish the + // encoding. + if (feof(infile)) + action = LZMA_FINISH; + } + + // Tell liblzma do the actual encoding. + // + // This reads up to strm->avail_in bytes of input starting + // from strm->next_in. avail_in will be decremented and + // next_in incremented by an equal amount to match the + // number of input bytes consumed. + // + // Up to strm->avail_out bytes of compressed output will be + // written starting from strm->next_out. avail_out and next_out + // will be incremented by an equal amount to match the number + // of output bytes written. + // + // The encoder has to do internal buffering, which means that + // it may take quite a bit of input before the same data is + // available in compressed form in the output buffer. + lzma_ret ret = lzma_code(strm, action); + + // If the output buffer is full or if the compression finished + // successfully, write the data from the output buffer to + // the output file. + if (strm->avail_out == 0 || ret == LZMA_STREAM_END) { + // When lzma_code() has returned LZMA_STREAM_END, + // the output buffer is likely to be only partially + // full. Calculate how much new data there is to + // be written to the output file. + size_t write_size = sizeof(outbuf) - strm->avail_out; + + if (fwrite(outbuf, 1, write_size, outfile) + != write_size) { + fprintf(stderr, "Write error: %s\n", + strerror(errno)); + return false; + } + + // Reset next_out and avail_out. + strm->next_out = outbuf; + strm->avail_out = sizeof(outbuf); + } + + // Normally the return value of lzma_code() will be LZMA_OK + // until everything has been encoded. + if (ret != LZMA_OK) { + // Once everything has been encoded successfully, the + // return value of lzma_code() will be LZMA_STREAM_END. + // + // It is important to check for LZMA_STREAM_END. Do not + // assume that getting ret != LZMA_OK would mean that + // everything has gone well. + if (ret == LZMA_STREAM_END) + return true; + + // It's not LZMA_OK nor LZMA_STREAM_END, + // so it must be an error code. See lzma/base.h + // (src/liblzma/api/lzma/base.h in the source package + // or e.g. /usr/include/lzma/base.h depending on the + // install prefix) for the list and documentation of + // possible values. Most values listen in lzma_ret + // enumeration aren't possible in this example. + const char *msg; + switch (ret) { + case LZMA_MEM_ERROR: + msg = "Memory allocation failed"; + break; + + case LZMA_DATA_ERROR: + // This error is returned if the compressed + // or uncompressed size get near 8 EiB + // (2^63 bytes) because that's where the .xz + // file format size limits currently are. + // That is, the possibility of this error + // is mostly theoretical unless you are doing + // something very unusual. + // + // Note that strm->total_in and strm->total_out + // have nothing to do with this error. Changing + // those variables won't increase or decrease + // the chance of getting this error. + msg = "File size limits exceeded"; + break; + + default: + // This is most likely LZMA_PROG_ERROR, but + // if this program is buggy (or liblzma has + // a bug), it may be e.g. LZMA_BUF_ERROR or + // LZMA_OPTIONS_ERROR too. + // + // It is inconvenient to have a separate + // error message for errors that should be + // impossible to occur, but knowing the error + // code is important for debugging. That's why + // it is good to print the error code at least + // when there is no good error message to show. + msg = "Unknown error, possibly a bug"; + break; + } + + fprintf(stderr, "Encoder error: %s (error code %u)\n", + msg, ret); + return false; + } + } +} + + +extern int +main(int argc, char **argv) +{ + // Get the preset number from the command line. + uint32_t preset = get_preset(argc, argv); + + // Initialize a lzma_stream structure. When it is allocated on stack, + // it is simplest to use LZMA_STREAM_INIT macro like below. When it + // is allocated on heap, using memset(strmptr, 0, sizeof(*strmptr)) + // works (as long as NULL pointers are represented with zero bits + // as they are on practically all computers today). + lzma_stream strm = LZMA_STREAM_INIT; + + // Initialize the encoder. If it succeeds, compress from + // stdin to stdout. + bool success = init_encoder(&strm, preset); + if (success) + success = compress(&strm, stdin, stdout); + + // Free the memory allocated for the encoder. If we were encoding + // multiple files, this would only need to be done after the last + // file. See 02_decompress.c for handling of multiple files. + // + // It is OK to call lzma_end() multiple times or when it hasn't been + // actually used except initialized with LZMA_STREAM_INIT. + lzma_end(&strm); + + // Close stdout to catch possible write errors that can occur + // when pending data is flushed from the stdio buffers. + if (fclose(stdout)) { + fprintf(stderr, "Write error: %s\n", strerror(errno)); + success = false; + } + + return success ? EXIT_SUCCESS : EXIT_FAILURE; +} diff --git a/miniconda3/envs/ladir/share/doc/xz/examples/02_decompress.c b/miniconda3/envs/ladir/share/doc/xz/examples/02_decompress.c new file mode 100644 index 0000000000000000000000000000000000000000..a87a5d3ece2ed6edbc6e01e77b6e48a112867e47 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/examples/02_decompress.c @@ -0,0 +1,286 @@ +// SPDX-License-Identifier: 0BSD + +/////////////////////////////////////////////////////////////////////////////// +// +/// \file 02_decompress.c +/// \brief Decompress .xz files to stdout +/// +/// Usage: ./02_decompress INPUT_FILES... > OUTFILE +/// +/// Example: ./02_decompress foo.xz bar.xz > foobar +// +// Author: Lasse Collin +// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include +#include +#include + + +static bool +init_decoder(lzma_stream *strm) +{ + // Initialize a .xz decoder. The decoder supports a memory usage limit + // and a set of flags. + // + // The memory usage of the decompressor depends on the settings used + // to compress a .xz file. It can vary from less than a megabyte to + // a few gigabytes, but in practice (at least for now) it rarely + // exceeds 65 MiB because that's how much memory is required to + // decompress files created with "xz -9". Settings requiring more + // memory take extra effort to use and don't (at least for now) + // provide significantly better compression in most cases. + // + // Memory usage limit is useful if it is important that the + // decompressor won't consume gigabytes of memory. The need + // for limiting depends on the application. In this example, + // no memory usage limiting is used. This is done by setting + // the limit to UINT64_MAX. + // + // The .xz format allows concatenating compressed files as is: + // + // echo foo | xz > foobar.xz + // echo bar | xz >> foobar.xz + // + // When decompressing normal standalone .xz files, LZMA_CONCATENATED + // should always be used to support decompression of concatenated + // .xz files. If LZMA_CONCATENATED isn't used, the decoder will stop + // after the first .xz stream. This can be useful when .xz data has + // been embedded inside another file format. + // + // Flags other than LZMA_CONCATENATED are supported too, and can + // be combined with bitwise-or. See lzma/container.h + // (src/liblzma/api/lzma/container.h in the source package or e.g. + // /usr/include/lzma/container.h depending on the install prefix) + // for details. + lzma_ret ret = lzma_stream_decoder( + strm, UINT64_MAX, LZMA_CONCATENATED); + + // Return successfully if the initialization went fine. + if (ret == LZMA_OK) + return true; + + // Something went wrong. The possible errors are documented in + // lzma/container.h (src/liblzma/api/lzma/container.h in the source + // package or e.g. /usr/include/lzma/container.h depending on the + // install prefix). + // + // Note that LZMA_MEMLIMIT_ERROR is never possible here. If you + // specify a very tiny limit, the error will be delayed until + // the first headers have been parsed by a call to lzma_code(). + const char *msg; + switch (ret) { + case LZMA_MEM_ERROR: + msg = "Memory allocation failed"; + break; + + case LZMA_OPTIONS_ERROR: + msg = "Unsupported decompressor flags"; + break; + + default: + // This is most likely LZMA_PROG_ERROR indicating a bug in + // this program or in liblzma. It is inconvenient to have a + // separate error message for errors that should be impossible + // to occur, but knowing the error code is important for + // debugging. That's why it is good to print the error code + // at least when there is no good error message to show. + msg = "Unknown error, possibly a bug"; + break; + } + + fprintf(stderr, "Error initializing the decoder: %s (error code %u)\n", + msg, ret); + return false; +} + + +static bool +decompress(lzma_stream *strm, const char *inname, FILE *infile, FILE *outfile) +{ + // When LZMA_CONCATENATED flag was used when initializing the decoder, + // we need to tell lzma_code() when there will be no more input. + // This is done by setting action to LZMA_FINISH instead of LZMA_RUN + // in the same way as it is done when encoding. + // + // When LZMA_CONCATENATED isn't used, there is no need to use + // LZMA_FINISH to tell when all the input has been read, but it + // is still OK to use it if you want. When LZMA_CONCATENATED isn't + // used, the decoder will stop after the first .xz stream. In that + // case some unused data may be left in strm->next_in. + lzma_action action = LZMA_RUN; + + uint8_t inbuf[BUFSIZ]; + uint8_t outbuf[BUFSIZ]; + + strm->next_in = NULL; + strm->avail_in = 0; + strm->next_out = outbuf; + strm->avail_out = sizeof(outbuf); + + while (true) { + if (strm->avail_in == 0 && !feof(infile)) { + strm->next_in = inbuf; + strm->avail_in = fread(inbuf, 1, sizeof(inbuf), + infile); + + if (ferror(infile)) { + fprintf(stderr, "%s: Read error: %s\n", + inname, strerror(errno)); + return false; + } + + // Once the end of the input file has been reached, + // we need to tell lzma_code() that no more input + // will be coming. As said before, this isn't required + // if the LZMA_CONCATENATED flag isn't used when + // initializing the decoder. + if (feof(infile)) + action = LZMA_FINISH; + } + + lzma_ret ret = lzma_code(strm, action); + + if (strm->avail_out == 0 || ret == LZMA_STREAM_END) { + size_t write_size = sizeof(outbuf) - strm->avail_out; + + if (fwrite(outbuf, 1, write_size, outfile) + != write_size) { + fprintf(stderr, "Write error: %s\n", + strerror(errno)); + return false; + } + + strm->next_out = outbuf; + strm->avail_out = sizeof(outbuf); + } + + if (ret != LZMA_OK) { + // Once everything has been decoded successfully, the + // return value of lzma_code() will be LZMA_STREAM_END. + // + // It is important to check for LZMA_STREAM_END. Do not + // assume that getting ret != LZMA_OK would mean that + // everything has gone well or that when you aren't + // getting more output it must have successfully + // decoded everything. + if (ret == LZMA_STREAM_END) + return true; + + // It's not LZMA_OK nor LZMA_STREAM_END, + // so it must be an error code. See lzma/base.h + // (src/liblzma/api/lzma/base.h in the source package + // or e.g. /usr/include/lzma/base.h depending on the + // install prefix) for the list and documentation of + // possible values. Many values listen in lzma_ret + // enumeration aren't possible in this example, but + // can be made possible by enabling memory usage limit + // or adding flags to the decoder initialization. + const char *msg; + switch (ret) { + case LZMA_MEM_ERROR: + msg = "Memory allocation failed"; + break; + + case LZMA_FORMAT_ERROR: + // .xz magic bytes weren't found. + msg = "The input is not in the .xz format"; + break; + + case LZMA_OPTIONS_ERROR: + // For example, the headers specify a filter + // that isn't supported by this liblzma + // version (or it hasn't been enabled when + // building liblzma, but no-one sane does + // that unless building liblzma for an + // embedded system). Upgrading to a newer + // liblzma might help. + // + // Note that it is unlikely that the file has + // accidentally became corrupt if you get this + // error. The integrity of the .xz headers is + // always verified with a CRC32, so + // unintentionally corrupt files can be + // distinguished from unsupported files. + msg = "Unsupported compression options"; + break; + + case LZMA_DATA_ERROR: + msg = "Compressed file is corrupt"; + break; + + case LZMA_BUF_ERROR: + // Typically this error means that a valid + // file has got truncated, but it might also + // be a damaged part in the file that makes + // the decoder think the file is truncated. + // If you prefer, you can use the same error + // message for this as for LZMA_DATA_ERROR. + msg = "Compressed file is truncated or " + "otherwise corrupt"; + break; + + default: + // This is most likely LZMA_PROG_ERROR. + msg = "Unknown error, possibly a bug"; + break; + } + + fprintf(stderr, "%s: Decoder error: " + "%s (error code %u)\n", + inname, msg, ret); + return false; + } + } +} + + +extern int +main(int argc, char **argv) +{ + if (argc <= 1) { + fprintf(stderr, "Usage: %s FILES...\n", argv[0]); + return EXIT_FAILURE; + } + + lzma_stream strm = LZMA_STREAM_INIT; + + bool success = true; + + // Try to decompress all files. + for (int i = 1; i < argc; ++i) { + if (!init_decoder(&strm)) { + // Decoder initialization failed. There's no point + // to retry it so we need to exit. + success = false; + break; + } + + FILE *infile = fopen(argv[i], "rb"); + + if (infile == NULL) { + fprintf(stderr, "%s: Error opening the " + "input file: %s\n", + argv[i], strerror(errno)); + success = false; + } else { + success &= decompress(&strm, argv[i], infile, stdout); + fclose(infile); + } + } + + // Free the memory allocated for the decoder. This only needs to be + // done after the last file. + lzma_end(&strm); + + if (fclose(stdout)) { + fprintf(stderr, "Write error: %s\n", strerror(errno)); + success = false; + } + + return success ? EXIT_SUCCESS : EXIT_FAILURE; +} diff --git a/miniconda3/envs/ladir/share/doc/xz/examples/03_compress_custom.c b/miniconda3/envs/ladir/share/doc/xz/examples/03_compress_custom.c new file mode 100644 index 0000000000000000000000000000000000000000..80ad189a5e3eab826eb17b4e97ba11b1035bbb53 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/examples/03_compress_custom.c @@ -0,0 +1,192 @@ +// SPDX-License-Identifier: 0BSD + +/////////////////////////////////////////////////////////////////////////////// +// +/// \file 03_compress_custom.c +/// \brief Compress in multi-call mode using x86 BCJ and LZMA2 +/// +/// Usage: ./03_compress_custom < INFILE > OUTFILE +/// +/// Example: ./03_compress_custom < foo > foo.xz +// +// Author: Lasse Collin +// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include +#include +#include + + +static bool +init_encoder(lzma_stream *strm) +{ + // Use the default preset (6) for LZMA2. + // + // The lzma_options_lzma structure and the lzma_lzma_preset() function + // are declared in lzma/lzma12.h (src/liblzma/api/lzma/lzma12.h in the + // source package or e.g. /usr/include/lzma/lzma12.h depending on + // the install prefix). + lzma_options_lzma opt_lzma2; + if (lzma_lzma_preset(&opt_lzma2, LZMA_PRESET_DEFAULT)) { + // It should never fail because the default preset + // (and presets 0-9 optionally with LZMA_PRESET_EXTREME) + // are supported by all stable liblzma versions. + // + // (The encoder initialization later in this function may + // still fail due to unsupported preset *if* the features + // required by the preset have been disabled at build time, + // but no-one does such things except on embedded systems.) + fprintf(stderr, "Unsupported preset, possibly a bug\n"); + return false; + } + + // Now we could customize the LZMA2 options if we wanted. For example, + // we could set the dictionary size (opt_lzma2.dict_size) to + // something else than the default (8 MiB) of the default preset. + // See lzma/lzma12.h for details of all LZMA2 options. + // + // The x86 BCJ filter will try to modify the x86 instruction stream so + // that LZMA2 can compress it better. The x86 BCJ filter doesn't need + // any options so it will be set to NULL below. + // + // Construct the filter chain. The uncompressed data goes first to + // the first filter in the array, in this case the x86 BCJ filter. + // The array is always terminated by setting .id = LZMA_VLI_UNKNOWN. + // + // See lzma/filter.h for more information about the lzma_filter + // structure. + lzma_filter filters[] = { + { .id = LZMA_FILTER_X86, .options = NULL }, + { .id = LZMA_FILTER_LZMA2, .options = &opt_lzma2 }, + { .id = LZMA_VLI_UNKNOWN, .options = NULL }, + }; + + // Initialize the encoder using the custom filter chain. + lzma_ret ret = lzma_stream_encoder(strm, filters, LZMA_CHECK_CRC64); + + if (ret == LZMA_OK) + return true; + + const char *msg; + switch (ret) { + case LZMA_MEM_ERROR: + msg = "Memory allocation failed"; + break; + + case LZMA_OPTIONS_ERROR: + // We are no longer using a plain preset so this error + // message has been edited accordingly compared to + // 01_compress_easy.c. + msg = "Specified filter chain is not supported"; + break; + + case LZMA_UNSUPPORTED_CHECK: + msg = "Specified integrity check is not supported"; + break; + + default: + msg = "Unknown error, possibly a bug"; + break; + } + + fprintf(stderr, "Error initializing the encoder: %s (error code %u)\n", + msg, ret); + return false; +} + + +// This function is identical to the one in 01_compress_easy.c. +static bool +compress(lzma_stream *strm, FILE *infile, FILE *outfile) +{ + lzma_action action = LZMA_RUN; + + uint8_t inbuf[BUFSIZ]; + uint8_t outbuf[BUFSIZ]; + + strm->next_in = NULL; + strm->avail_in = 0; + strm->next_out = outbuf; + strm->avail_out = sizeof(outbuf); + + while (true) { + if (strm->avail_in == 0 && !feof(infile)) { + strm->next_in = inbuf; + strm->avail_in = fread(inbuf, 1, sizeof(inbuf), + infile); + + if (ferror(infile)) { + fprintf(stderr, "Read error: %s\n", + strerror(errno)); + return false; + } + + if (feof(infile)) + action = LZMA_FINISH; + } + + lzma_ret ret = lzma_code(strm, action); + + if (strm->avail_out == 0 || ret == LZMA_STREAM_END) { + size_t write_size = sizeof(outbuf) - strm->avail_out; + + if (fwrite(outbuf, 1, write_size, outfile) + != write_size) { + fprintf(stderr, "Write error: %s\n", + strerror(errno)); + return false; + } + + strm->next_out = outbuf; + strm->avail_out = sizeof(outbuf); + } + + if (ret != LZMA_OK) { + if (ret == LZMA_STREAM_END) + return true; + + const char *msg; + switch (ret) { + case LZMA_MEM_ERROR: + msg = "Memory allocation failed"; + break; + + case LZMA_DATA_ERROR: + msg = "File size limits exceeded"; + break; + + default: + msg = "Unknown error, possibly a bug"; + break; + } + + fprintf(stderr, "Encoder error: %s (error code %u)\n", + msg, ret); + return false; + } + } +} + + +extern int +main(void) +{ + lzma_stream strm = LZMA_STREAM_INIT; + + bool success = init_encoder(&strm); + if (success) + success = compress(&strm, stdin, stdout); + + lzma_end(&strm); + + if (fclose(stdout)) { + fprintf(stderr, "Write error: %s\n", strerror(errno)); + success = false; + } + + return success ? EXIT_SUCCESS : EXIT_FAILURE; +} diff --git a/miniconda3/envs/ladir/share/doc/xz/examples/04_compress_easy_mt.c b/miniconda3/envs/ladir/share/doc/xz/examples/04_compress_easy_mt.c new file mode 100644 index 0000000000000000000000000000000000000000..c721a6618ae0f13cf63541d59b0a31824fb9e55d --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/examples/04_compress_easy_mt.c @@ -0,0 +1,205 @@ +// SPDX-License-Identifier: 0BSD + +/////////////////////////////////////////////////////////////////////////////// +// +/// \file 04_compress_easy_mt.c +/// \brief Compress in multi-call mode using LZMA2 in multi-threaded mode +/// +/// Usage: ./04_compress_easy_mt < INFILE > OUTFILE +/// +/// Example: ./04_compress_easy_mt < foo > foo.xz +// +// Author: Lasse Collin +// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include +#include +#include + + +static bool +init_encoder(lzma_stream *strm) +{ + // The threaded encoder takes the options as pointer to + // a lzma_mt structure. + lzma_mt mt = { + // No flags are needed. + .flags = 0, + + // Let liblzma determine a sane block size. + .block_size = 0, + + // Use no timeout for lzma_code() calls by setting timeout + // to zero. That is, sometimes lzma_code() might block for + // a long time (from several seconds to even minutes). + // If this is not OK, for example due to progress indicator + // needing updates, specify a timeout in milliseconds here. + // See the documentation of lzma_mt in lzma/container.h for + // information how to choose a reasonable timeout. + .timeout = 0, + + // Use the default preset (6) for LZMA2. + // To use a preset, filters must be set to NULL. + .preset = LZMA_PRESET_DEFAULT, + .filters = NULL, + + // Use CRC64 for integrity checking. See also + // 01_compress_easy.c about choosing the integrity check. + .check = LZMA_CHECK_CRC64, + }; + + // Detect how many threads the CPU supports. + mt.threads = lzma_cputhreads(); + + // If the number of CPU cores/threads cannot be detected, + // use one thread. Note that this isn't the same as the normal + // single-threaded mode as this will still split the data into + // blocks and use more RAM than the normal single-threaded mode. + // You may want to consider using lzma_easy_encoder() or + // lzma_stream_encoder() instead of lzma_stream_encoder_mt() if + // lzma_cputhreads() returns 0 or 1. + if (mt.threads == 0) + mt.threads = 1; + + // If the number of CPU cores/threads exceeds threads_max, + // limit the number of threads to keep memory usage lower. + // The number 8 is arbitrarily chosen and may be too low or + // high depending on the compression preset and the computer + // being used. + // + // FIXME: A better way could be to check the amount of RAM + // (or available RAM) and use lzma_stream_encoder_mt_memusage() + // to determine if the number of threads should be reduced. + const uint32_t threads_max = 8; + if (mt.threads > threads_max) + mt.threads = threads_max; + + // Initialize the threaded encoder. + lzma_ret ret = lzma_stream_encoder_mt(strm, &mt); + + if (ret == LZMA_OK) + return true; + + const char *msg; + switch (ret) { + case LZMA_MEM_ERROR: + msg = "Memory allocation failed"; + break; + + case LZMA_OPTIONS_ERROR: + // We are no longer using a plain preset so this error + // message has been edited accordingly compared to + // 01_compress_easy.c. + msg = "Specified filter chain is not supported"; + break; + + case LZMA_UNSUPPORTED_CHECK: + msg = "Specified integrity check is not supported"; + break; + + default: + msg = "Unknown error, possibly a bug"; + break; + } + + fprintf(stderr, "Error initializing the encoder: %s (error code %u)\n", + msg, ret); + return false; +} + + +// This function is identical to the one in 01_compress_easy.c. +static bool +compress(lzma_stream *strm, FILE *infile, FILE *outfile) +{ + lzma_action action = LZMA_RUN; + + uint8_t inbuf[BUFSIZ]; + uint8_t outbuf[BUFSIZ]; + + strm->next_in = NULL; + strm->avail_in = 0; + strm->next_out = outbuf; + strm->avail_out = sizeof(outbuf); + + while (true) { + if (strm->avail_in == 0 && !feof(infile)) { + strm->next_in = inbuf; + strm->avail_in = fread(inbuf, 1, sizeof(inbuf), + infile); + + if (ferror(infile)) { + fprintf(stderr, "Read error: %s\n", + strerror(errno)); + return false; + } + + if (feof(infile)) + action = LZMA_FINISH; + } + + lzma_ret ret = lzma_code(strm, action); + + if (strm->avail_out == 0 || ret == LZMA_STREAM_END) { + size_t write_size = sizeof(outbuf) - strm->avail_out; + + if (fwrite(outbuf, 1, write_size, outfile) + != write_size) { + fprintf(stderr, "Write error: %s\n", + strerror(errno)); + return false; + } + + strm->next_out = outbuf; + strm->avail_out = sizeof(outbuf); + } + + if (ret != LZMA_OK) { + if (ret == LZMA_STREAM_END) + return true; + + const char *msg; + switch (ret) { + case LZMA_MEM_ERROR: + msg = "Memory allocation failed"; + break; + + case LZMA_DATA_ERROR: + msg = "File size limits exceeded"; + break; + + default: + msg = "Unknown error, possibly a bug"; + break; + } + + fprintf(stderr, "Encoder error: %s (error code %u)\n", + msg, ret); + return false; + } + } +} + + +extern int +main(void) +{ + lzma_stream strm = LZMA_STREAM_INIT; + + bool success = init_encoder(&strm); + if (success) + success = compress(&strm, stdin, stdout); + + lzma_end(&strm); + + if (fclose(stdout)) { + fprintf(stderr, "Write error: %s\n", strerror(errno)); + success = false; + } + + return success ? EXIT_SUCCESS : EXIT_FAILURE; +} diff --git a/miniconda3/envs/ladir/share/doc/xz/examples/11_file_info.c b/miniconda3/envs/ladir/share/doc/xz/examples/11_file_info.c new file mode 100644 index 0000000000000000000000000000000000000000..caadd98072fbf0ced7e27869a6f32dd90b45d71f --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/examples/11_file_info.c @@ -0,0 +1,205 @@ +// SPDX-License-Identifier: 0BSD + +/////////////////////////////////////////////////////////////////////////////// +// +/// \file 11_file_info.c +/// \brief Get uncompressed size of .xz file(s) +/// +/// Usage: ./11_file_info INFILE1.xz [INFILEn.xz]... +/// +/// Example: ./11_file_info foo.xz +// +// Author: Lasse Collin +// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include +#include +#include +#include + + +static bool +print_file_size(lzma_stream *strm, FILE *infile, const char *filename) +{ + // Get the file size. In standard C it can be done by seeking to + // the end of the file and then getting the file position. + // In POSIX one can use fstat() and then st_size from struct stat. + // Also note that fseek() and ftell() use long and thus don't support + // large files on 32-bit systems (POSIX versions fseeko() and + // ftello() can support large files). + if (fseek(infile, 0, SEEK_END)) { + fprintf(stderr, "Error seeking the file '%s': %s\n", + filename, strerror(errno)); + return false; + } + + const long file_size = ftell(infile); + + // The decoder wants to start from the beginning of the .xz file. + rewind(infile); + + // Initialize the decoder. + lzma_index *i; + lzma_ret ret = lzma_file_info_decoder(strm, &i, UINT64_MAX, + (uint64_t)file_size); + switch (ret) { + case LZMA_OK: + // Initialization succeeded. + break; + + case LZMA_MEM_ERROR: + fprintf(stderr, "Out of memory when initializing " + "the .xz file info decoder\n"); + return false; + + case LZMA_PROG_ERROR: + default: + fprintf(stderr, "Unknown error, possibly a bug\n"); + return false; + } + + // This example program reuses the same lzma_stream structure + // for multiple files, so we need to reset this when starting + // a new file. + strm->avail_in = 0; + + // Buffer for input data. + uint8_t inbuf[BUFSIZ]; + + // Pass data to the decoder and seek when needed. + while (true) { + if (strm->avail_in == 0) { + strm->next_in = inbuf; + strm->avail_in = fread(inbuf, 1, sizeof(inbuf), + infile); + + if (ferror(infile)) { + fprintf(stderr, + "Error reading from '%s': %s\n", + filename, strerror(errno)); + return false; + } + + // We don't need to care about hitting the end of + // the file so no need to check for feof(). + } + + ret = lzma_code(strm, LZMA_RUN); + + switch (ret) { + case LZMA_OK: + break; + + case LZMA_SEEK_NEEDED: + // The cast is safe because liblzma won't ask us to + // seek past the known size of the input file which + // did fit into a long. + // + // NOTE: Remember to change these to off_t if you + // switch fseeko() or lseek(). + if (fseek(infile, (long)(strm->seek_pos), SEEK_SET)) { + fprintf(stderr, "Error seeking the " + "file '%s': %s\n", + filename, strerror(errno)); + return false; + } + + // The old data in the inbuf is useless now. Set + // avail_in to zero so that we will read new input + // from the new file position on the next iteration + // of this loop. + strm->avail_in = 0; + break; + + case LZMA_STREAM_END: + // File information was successfully decoded. + // See for functions that can be + // used on it. In this example we just print + // the uncompressed size (in bytes) of + // the .xz file followed by its file name. + printf("%10" PRIu64 " %s\n", + lzma_index_uncompressed_size(i), + filename); + + // Free the memory of the lzma_index structure. + lzma_index_end(i, NULL); + + return true; + + case LZMA_FORMAT_ERROR: + // .xz magic bytes weren't found. + fprintf(stderr, "The file '%s' is not " + "in the .xz format\n", filename); + return false; + + case LZMA_OPTIONS_ERROR: + fprintf(stderr, "The file '%s' has .xz headers that " + "are not supported by this liblzma " + "version\n", filename); + return false; + + case LZMA_DATA_ERROR: + fprintf(stderr, "The file '%s' is corrupt\n", + filename); + return false; + + case LZMA_MEM_ERROR: + fprintf(stderr, "Memory allocation failed when " + "decoding the file '%s'\n", filename); + return false; + + // LZMA_MEMLIMIT_ERROR shouldn't happen because we used + // UINT64_MAX as the limit. + // + // LZMA_BUF_ERROR shouldn't happen because we always provide + // new input when the input buffer is empty. The decoder + // knows the input file size and thus won't try to read past + // the end of the file. + case LZMA_MEMLIMIT_ERROR: + case LZMA_BUF_ERROR: + case LZMA_PROG_ERROR: + default: + fprintf(stderr, "Unknown error, possibly a bug\n"); + return false; + } + } + + // This line is never reached. +} + + +extern int +main(int argc, char **argv) +{ + bool success = true; + lzma_stream strm = LZMA_STREAM_INIT; + + for (int i = 1; i < argc; ++i) { + FILE *infile = fopen(argv[i], "rb"); + + if (infile == NULL) { + fprintf(stderr, "Cannot open the file '%s': %s\n", + argv[i], strerror(errno)); + success = false; + } + + success &= print_file_size(&strm, infile, argv[i]); + + (void)fclose(infile); + } + + lzma_end(&strm); + + // Close stdout to catch possible write errors that can occur + // when pending data is flushed from the stdio buffers. + if (fclose(stdout)) { + fprintf(stderr, "Write error: %s\n", strerror(errno)); + success = false; + } + + return success ? EXIT_SUCCESS : EXIT_FAILURE; +} diff --git a/miniconda3/envs/ladir/share/doc/xz/examples/Makefile b/miniconda3/envs/ladir/share/doc/xz/examples/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..f5b98788ece821f1727ec3644c30f7115bd9148f --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/examples/Makefile @@ -0,0 +1,21 @@ +# SPDX-License-Identifier: 0BSD +# Author: Lasse Collin + +CC = c99 +CFLAGS = -g +LDFLAGS = -llzma + +PROGS = \ + 01_compress_easy \ + 02_decompress \ + 03_compress_custom \ + 04_compress_easy_mt \ + 11_file_info + +all: $(PROGS) + +.c: + $(CC) $(CFLAGS) -o $@ $< $(LDFLAGS) + +clean: + -rm -f $(PROGS) diff --git a/miniconda3/envs/ladir/share/doc/xz/faq.txt b/miniconda3/envs/ladir/share/doc/xz/faq.txt new file mode 100644 index 0000000000000000000000000000000000000000..3f9068b4b278040489220702772738604209df03 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/faq.txt @@ -0,0 +1,244 @@ + +XZ Utils FAQ +============ + +Q: What do the letters XZ mean? + +A: Nothing. They are just two letters, which come from the file format + suffix .xz. The .xz suffix was selected, because it seemed to be + pretty much unused. It has no deeper meaning. + + +Q: What are LZMA and LZMA2? + +A: LZMA stands for Lempel-Ziv-Markov chain-Algorithm. It is the name + of the compression algorithm designed by Igor Pavlov for 7-Zip. + LZMA is based on LZ77 and range encoding. + + LZMA2 is an updated version of the original LZMA to fix a couple of + practical issues. In context of XZ Utils, LZMA is called LZMA1 to + emphasize that LZMA is not the same thing as LZMA2. LZMA2 is the + primary compression algorithm in the .xz file format. + + +Q: There are many LZMA related projects. How does XZ Utils relate to them? + +A: 7-Zip and LZMA SDK are the original projects. LZMA SDK is roughly + a subset of the 7-Zip source tree. + + p7zip is 7-Zip's command-line tools ported to POSIX-like systems. + + LZMA Utils provide a gzip-like lzma tool for POSIX-like systems. + LZMA Utils are based on LZMA SDK. XZ Utils are the successor to + LZMA Utils. + + There are several other projects using LZMA. Most are more or less + based on LZMA SDK. See . + + +Q: Why is liblzma named liblzma if its primary file format is .xz? + Shouldn't it be e.g. libxz? + +A: When the designing of the .xz format began, the idea was to replace + the .lzma format and use the same .lzma suffix. It would have been + quite OK to reuse the suffix when there were very few .lzma files + around. However, the old .lzma format became popular before the + new format was finished. The new format was renamed to .xz but the + name of liblzma wasn't changed. + + +Q: Do XZ Utils support the .7z format? + +A: No. Use 7-Zip (Windows) or p7zip (POSIX-like systems) to handle .7z + files. + + +Q: I have many .tar.7z files. Can I convert them to .tar.xz without + spending hours recompressing the data? + +A: In the "extra" directory, there is a script named 7z2lzma.bash which + is able to convert some .7z files to the .lzma format (not .xz). It + needs the 7za (or 7z) command from p7zip. The script may silently + produce corrupt output if certain assumptions are not met, so + decompress the resulting .lzma file and compare it against the + original before deleting the original file! + + +Q: I have many .lzma files. Can I quickly convert them to the .xz format? + +A: For now, no. Since XZ Utils supports the .lzma format, it's usually + not too bad to keep the old files in the old format. If you want to + do the conversion anyway, you need to decompress the .lzma files and + then recompress to the .xz format. + + Technically, there is a way to make the conversion relatively fast + (roughly twice the time that normal decompression takes). Writing + such a tool would take quite a bit of time though, and would probably + be useful to only a few people. If you really want such a conversion + tool, contact Lasse Collin and offer some money. + + +Q: I have installed xz, but my tar doesn't recognize .tar.xz files. + How can I extract .tar.xz files? + +A: xz -dc foo.tar.xz | tar xf - + + +Q: Can I recover parts of a broken .xz file (e.g. a corrupted CD-R)? + +A: It may be possible if the file consists of multiple blocks, which + typically is not the case if the file was created in single-threaded + mode. There is no recovery program yet. + + +Q: Is (some part of) XZ Utils patented? + +A: Lasse Collin is not aware of any patents that could affect XZ Utils. + However, due to the nature of software patents, it's not possible to + guarantee that XZ Utils isn't affected by any third party patent(s). + + +Q: Where can I find documentation about the file format and algorithms? + +A: The .xz format is documented in xz-file-format.txt. It is a container + format only, and doesn't include descriptions of any non-trivial + filters. + + Documenting LZMA and LZMA2 is planned, but for now, there is no other + documentation than the source code. Before you begin, you should know + the basics of LZ77 and range-coding algorithms. LZMA is based on LZ77, + but LZMA is a lot more complex. Range coding is used to compress + the final bitstream like Huffman coding is used in Deflate. + + +Q: I cannot find BCJ and BCJ2 filters. Don't they exist in liblzma? + +A: BCJ filter is called "x86" in liblzma. BCJ2 is not included, + because it requires using more than one encoded output stream. + + +Q: I need to use a script that runs "xz -9". On a system with 256 MiB + of RAM, xz says that it cannot allocate memory. Can I make the + script work without modifying it? + +A: Set a default memory usage limit for compression. You can do it e.g. + in a shell initialization script such as ~/.bashrc or /etc/profile: + + XZ_DEFAULTS=--memlimit-compress=150MiB + export XZ_DEFAULTS + + xz will then scale the compression settings down so that the given + memory usage limit is not reached. This way xz shouldn't run out + of memory. + + Check also that memory-related resource limits are high enough. + On most systems, "ulimit -a" will show the current resource limits. + + +Q: How do I create files that can be decompressed with XZ Embedded? + +A: See the documentation in XZ Embedded. In short, something like + this is a good start: + + xz --check=crc32 --lzma2=preset=6e,dict=64KiB + + Or if a BCJ filter is needed too, e.g. if compressing + a kernel image for PowerPC: + + xz --check=crc32 --powerpc --lzma2=preset=6e,dict=64KiB + + Adjust the dictionary size to get a good compromise between + compression ratio and decompressor memory usage. Note that + in single-call decompression mode of XZ Embedded, a big + dictionary doesn't increase memory usage. + + +Q: How is multi-threaded compression implemented in XZ Utils? + +A: The simplest method is splitting the uncompressed data into blocks + and compressing them in parallel independent from each other. + This is currently the only threading method supported in XZ Utils. + Since the blocks are compressed independently, they can also be + decompressed independently. Together with the index feature in .xz, + this allows using threads to create .xz files for random-access + reading. This also makes threaded decompression possible. + + The independent blocks method has a couple of disadvantages too. It + will compress worse than a single-block method. Often the difference + is not too big (maybe 1-2 %) but sometimes it can be too big. Also, + the memory usage of the compressor increases linearly when adding + threads. + + At least two other threading methods are possible but these haven't + been implemented in XZ Utils: + + Match finder parallelization has been in 7-Zip for ages. It doesn't + affect compression ratio or memory usage significantly. Among the + three threading methods, only this is useful when compressing small + files (files that are not significantly bigger than the dictionary). + Unfortunately this method scales only to about two CPU cores. + + The third method is pigz-style threading (I use that name, because + pigz uses that method). It doesn't + affect compression ratio significantly and scales to many cores. + The memory usage scales linearly when threads are added. This isn't + significant with pigz, because Deflate uses only a 32 KiB dictionary, + but with LZMA2 the memory usage will increase dramatically just like + with the independent-blocks method. There is also a constant + computational overhead, which may make pigz-method a bit dull on + dual-core compared to the parallel match finder method, but with more + cores the overhead is not a big deal anymore. + + Combining the threading methods will be possible and also useful. + For example, combining match finder parallelization with pigz-style + threading or independent-blocks-threading can cut the memory usage + by 50 %. + + +Q: I told xz to use many threads but it is using only one or two + processor cores. What is wrong? + +A: Since multi-threaded compression is done by splitting the data into + blocks that are compressed individually, if the input file is too + small for the block size, then many threads cannot be used. The + default block size increases when the compression level is + increased. For example, xz -6 uses 8 MiB LZMA2 dictionary and + 24 MiB blocks, and xz -9 uses 64 MiB LZMA dictionary and 192 MiB + blocks. If the input file is 100 MiB, xz -6 can use five threads + of which one will finish quickly as it has only 4 MiB to compress. + However, for the same file, xz -9 can only use one thread. + + One can adjust block size with --block-size=SIZE but making the + block size smaller than LZMA2 dictionary is waste of RAM: using + xz -9 with 6 MiB blocks isn't any better than using xz -6 with + 6 MiB blocks. The default settings use a block size bigger than + the LZMA2 dictionary size because this was seen as a reasonable + compromise between RAM usage and compression ratio. + + When decompressing, the ability to use threads depends on how the + file was created. If it was created in multi-threaded mode then + it can be decompressed in multi-threaded mode too if there are + multiple blocks in the file. + + +Q: How do I build a program that needs liblzmadec (lzmadec.h)? + +A: liblzmadec is part of LZMA Utils. XZ Utils has liblzma, but no + liblzmadec. The code using liblzmadec should be ported to use + liblzma instead. If you cannot or don't want to do that, download + LZMA Utils from . + + +Q: The default build of liblzma is too big. How can I make it smaller? + +A: Give --enable-small to the configure script. Use also appropriate + --enable or --disable options to include only those filter encoders + and decoders and integrity checks that you actually need. Use + CFLAGS=-Os (with GCC) or equivalent to tell your compiler to optimize + for size. See INSTALL for information about configure options. + + If the result is still too big, take a look at XZ Embedded. It is + a separate project, which provides a limited but significantly + smaller XZ decoder implementation than XZ Utils. You can find it + at . + diff --git a/miniconda3/envs/ladir/share/doc/xz/history.txt b/miniconda3/envs/ladir/share/doc/xz/history.txt new file mode 100644 index 0000000000000000000000000000000000000000..8545e232254ed5d64bab1aa9f713cc3a24cf3abe --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/history.txt @@ -0,0 +1,150 @@ + +History of LZMA Utils and XZ Utils +================================== + +Tukaani distribution + + In 2005, there was a small group working on the Tukaani distribution, + which was a Slackware fork. One of the project's goals was to fit the + distro on a single 700 MiB ISO-9660 image. Using LZMA instead of gzip + helped a lot. Roughly speaking, one could fit data that took 1000 MiB + in gzipped form into 700 MiB with LZMA. Naturally, the compression + ratio varied across packages, but this was what we got on average. + + Slackware packages have traditionally had .tgz as the filename suffix, + which is an abbreviation of .tar.gz. A logical naming for LZMA + compressed packages was .tlz, being an abbreviation of .tar.lzma. + + At the end of the year 2007, there was no distribution under the + Tukaani project anymore, but development of LZMA Utils was kept going. + Still, there were .tlz packages around, because at least Vector Linux + (a Slackware based distribution) used LZMA for its packages. + + First versions of the modified pkgtools used the LZMA_Alone tool from + Igor Pavlov's LZMA SDK as is. It was fine, because users wouldn't need + to interact with LZMA_Alone directly. But people soon wanted to use + LZMA for other files too, and the interface of LZMA_Alone wasn't + comfortable for those used to gzip and bzip2. + + +First steps of LZMA Utils + + The first version of LZMA Utils (4.22.0) included a shell script called + lzmash. It was a wrapper that had a gzip-like command-line interface. It + used the LZMA_Alone tool from LZMA SDK to do all the real work. zgrep, + zdiff, and related scripts from gzip were adapted to work with LZMA and + were part of the first LZMA Utils release too. + + LZMA Utils 4.22.0 included also lzmadec, which was a small (less than + 10 KiB) decoder-only command-line tool. It was written on top of the + decoder-only C code found from the LZMA SDK. lzmadec was convenient in + situations where LZMA_Alone (a few hundred KiB) would be too big. + + lzmash and lzmadec were written by Lasse Collin. + + +Second generation + + The lzmash script was an ugly and not very secure hack. The last + version of LZMA Utils to use lzmash was 4.27.1. + + LZMA Utils 4.32.0beta1 introduced a new lzma command-line tool written + by Ville Koskinen. It was written in C++, and used the encoder and + decoder from C++ LZMA SDK with some little modifications. This tool + replaced both the lzmash script and the LZMA_Alone command-line tool + in LZMA Utils. + + Introducing this new tool caused some temporary incompatibilities, + because the LZMA_Alone executable was simply named lzma like the new + command-line tool, but they had a completely different command-line + interface. The file format was still the same. + + Lasse wrote liblzmadec, which was a small decoder-only library based + on the C code found from LZMA SDK. liblzmadec had an API similar to + zlib, although there were some significant differences, which made it + non-trivial to use it in some applications designed for zlib and + libbzip2. + + The lzmadec command-line tool was converted to use liblzmadec. + + Alexandre Sauvé helped converting the build system to use GNU + Autotools. This made it easier to test for certain less portable + features needed by the new command-line tool. + + Since the new command-line tool never got completely finished (for + example, it didn't support the LZMA_OPT environment variable), the + intent was to not call 4.32.x stable. Similarly, liblzmadec wasn't + polished, but appeared to work well enough, so some people started + using it too. + + Because the development of the third generation of LZMA Utils was + delayed considerably (3-4 years), the 4.32.x branch had to be kept + maintained. It got some bug fixes now and then, and finally it was + decided to call it stable, although most of the missing features were + never added. + + +File format problems + + The file format used by LZMA_Alone was primitive. It was designed with + embedded systems in mind, and thus provided only a minimal set of + features. The two biggest problems for non-embedded use were the lack + of magic bytes and an integrity check. + + Igor and Lasse started developing a new file format with some help + from Ville Koskinen. Also Mark Adler, Mikko Pouru, H. Peter Anvin, + and Lars Wirzenius helped with some minor things at some point of the + development. Designing the new format took quite a long time (actually, + too long a time would be a more appropriate expression). It was mostly + because Lasse was quite slow at getting things done due to personal + reasons. + + Originally the new format was supposed to use the same .lzma suffix + that was already used by the old file format. Switching to the new + format wouldn't have caused much trouble when the old format wasn't + used by many people. But since the development of the new format took + such a long time, the old format got quite popular, and it was decided + that the new file format must use a different suffix. + + It was decided to use .xz as the suffix of the new file format. The + first stable .xz file format specification was finally released in + December 2008. In addition to fixing the most obvious problems of + the old .lzma format, the .xz format added some new features like + support for multiple filters (compression algorithms), filter chaining + (like piping on the command line), and limited random-access reading. + + Currently the primary compression algorithm used in .xz is LZMA2. + It is an extension on top of the original LZMA to fix some practical + problems: LZMA2 adds support for flushing the encoder, uncompressed + chunks, eases stateful decoder implementations, and improves support + for multithreading. Since LZMA2 is better than the original LZMA, the + original LZMA is not supported in .xz. + + +Transition to XZ Utils + + The early versions of XZ Utils were called LZMA Utils. The first + releases were 4.42.0alphas. They dropped the rest of the C++ LZMA SDK. + The code was still directly based on LZMA SDK but ported to C and + converted from a callback API to a stateful API. Later, Igor Pavlov + made a C version of the LZMA encoder too; these ports from C++ to C + were independent in LZMA SDK and LZMA Utils. + + The core of the new LZMA Utils was liblzma, a compression library with + a zlib-like API. liblzma supported both the old and new file format. + The gzip-like lzma command-line tool was rewritten to use liblzma. + + The new LZMA Utils code base was renamed to XZ Utils when the name + of the new file format had been decided. The liblzma compression + library retained its name though, because changing it would have + caused unnecessary breakage in applications already using the early + liblzma snapshots. + + The xz command-line tool can emulate the gzip-like lzma tool by + creating appropriate symlinks (e.g. lzma -> xz). Thus, practically + all scripts using the lzma tool from LZMA Utils will work as is with + XZ Utils (and will keep using the old .lzma format). Still, the .lzma + format is more or less deprecated. XZ Utils will keep supporting it, + but new applications should use the .xz format, and migrating old + applications to .xz is often a good idea too. + diff --git a/miniconda3/envs/ladir/share/doc/xz/lzma-file-format.txt b/miniconda3/envs/ladir/share/doc/xz/lzma-file-format.txt new file mode 100644 index 0000000000000000000000000000000000000000..8cce5dcce749121b0855010e6e5576d545ba6a68 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/lzma-file-format.txt @@ -0,0 +1,173 @@ + +The .lzma File Format +===================== + + 0. Preface + 0.1. Notices and Acknowledgements + 0.2. Changes + 1. File Format + 1.1. Header + 1.1.1. Properties + 1.1.2. Dictionary Size + 1.1.3. Uncompressed Size + 1.2. LZMA Compressed Data + 2. References + + +0. Preface + + This document describes the .lzma file format, which is + sometimes also called LZMA_Alone format. It is a legacy file + format, which is being or has been replaced by the .xz format. + The MIME type of the .lzma format is `application/x-lzma'. + + The most commonly used software to handle .lzma files are + LZMA SDK, LZMA Utils, 7-Zip, and XZ Utils. This document + describes some of the differences between these implementations + and gives hints what subset of the .lzma format is the most + portable. + + +0.1. Notices and Acknowledgements + + This file format was designed by Igor Pavlov for use in + LZMA SDK. This document was written by Lasse Collin + using the documentation found + from the LZMA SDK. + + This document has been put into the public domain. + + +0.2. Changes + + Last modified: 2024-04-08 17:35+0300 + + From version 2011-04-12 11:55+0300 to 2022-07-13 21:00+0300: + The section 1.1.3 was modified to allow End of Payload Marker + with a known Uncompressed Size. + + +1. File Format + + +-+-+-+-+-+-+-+-+-+-+-+-+-+==========================+ + | Header | LZMA Compressed Data | + +-+-+-+-+-+-+-+-+-+-+-+-+-+==========================+ + + The .lzma format file consist of 13-byte Header followed by + the LZMA Compressed Data. + + Unlike the .gz, .bz2, and .xz formats, it is not possible to + concatenate multiple .lzma files as is and expect the + decompression tool to decode the resulting file as if it were + a single .lzma file. + + For example, the command line tools from LZMA Utils and + LZMA SDK silently ignore all the data after the first .lzma + stream. In contrast, the command line tool from XZ Utils + considers the .lzma file to be corrupt if there is data after + the first .lzma stream. + + +1.1. Header + + +------------+----+----+----+----+--+--+--+--+--+--+--+--+ + | Properties | Dictionary Size | Uncompressed Size | + +------------+----+----+----+----+--+--+--+--+--+--+--+--+ + + +1.1.1. Properties + + The Properties field contains three properties. An abbreviation + is given in parentheses, followed by the value range of the + property. The field consists of + + 1) the number of literal context bits (lc, [0, 8]); + 2) the number of literal position bits (lp, [0, 4]); and + 3) the number of position bits (pb, [0, 4]). + + The properties are encoded using the following formula: + + Properties = (pb * 5 + lp) * 9 + lc + + The following C code illustrates a straightforward way to + decode the Properties field: + + uint8_t lc, lp, pb; + uint8_t prop = get_lzma_properties(); + if (prop > (4 * 5 + 4) * 9 + 8) + return LZMA_PROPERTIES_ERROR; + + pb = prop / (9 * 5); + prop -= pb * 9 * 5; + lp = prop / 9; + lc = prop - lp * 9; + + XZ Utils has an additional requirement: lc + lp <= 4. Files + which don't follow this requirement cannot be decompressed + with XZ Utils. Usually this isn't a problem since the most + common lc/lp/pb values are 3/0/2. It is the only lc/lp/pb + combination that the files created by LZMA Utils can have, + but LZMA Utils can decompress files with any lc/lp/pb. + + +1.1.2. Dictionary Size + + Dictionary Size is stored as an unsigned 32-bit little endian + integer. Any 32-bit value is possible, but for maximum + portability, only sizes of 2^n and 2^n + 2^(n-1) should be + used. + + LZMA Utils creates only files with dictionary size 2^n, + 16 <= n <= 25. LZMA Utils can decompress files with any + dictionary size. + + XZ Utils creates and decompresses .lzma files only with + dictionary sizes 2^n and 2^n + 2^(n-1). If some other + dictionary size is specified when compressing, the value + stored in the Dictionary Size field is a rounded up, but the + specified value is still used in the actual compression code. + + +1.1.3. Uncompressed Size + + Uncompressed Size is stored as unsigned 64-bit little endian + integer. A special value of 0xFFFF_FFFF_FFFF_FFFF indicates + that Uncompressed Size is unknown. End of Payload Marker (*) + is used if Uncompressed Size is unknown. End of Payload Marker + is allowed but rarely used if Uncompressed Size is known. + XZ Utils 5.2.5 and older don't support .lzma files that have + End of Payload Marker together with a known Uncompressed Size. + + XZ Utils rejects files whose Uncompressed Size field specifies + a known size that is 256 GiB or more. This is to reject false + positives when trying to guess if the input file is in the + .lzma format. When Uncompressed Size is unknown, there is no + limit for the uncompressed size of the file. + + (*) Some tools use the term End of Stream (EOS) marker + instead of End of Payload Marker. + + +1.2. LZMA Compressed Data + + Detailed description of the format of this field is out of + scope of this document. + + +2. References + + LZMA SDK - The original LZMA implementation + https://7-zip.org/sdk.html + + 7-Zip + https://7-zip.org/ + + LZMA Utils - LZMA adapted to POSIX-like systems + https://tukaani.org/lzma/ + + XZ Utils - The next generation of LZMA Utils + https://tukaani.org/xz/ + + The .xz file format - The successor of the .lzma format + https://tukaani.org/xz/xz-file-format.txt + diff --git a/miniconda3/envs/ladir/share/doc/xz/xz-file-format.txt b/miniconda3/envs/ladir/share/doc/xz/xz-file-format.txt new file mode 100644 index 0000000000000000000000000000000000000000..12d2530cda4831e133ffaebad7d0f3f22ae302f2 --- /dev/null +++ b/miniconda3/envs/ladir/share/doc/xz/xz-file-format.txt @@ -0,0 +1,1174 @@ + +The .xz File Format +=================== + +Version 1.2.1 (2024-04-08) + + + 0. Preface + 0.1. Notices and Acknowledgements + 0.2. Getting the Latest Version + 0.3. Version History + 1. Conventions + 1.1. Byte and Its Representation + 1.2. Multibyte Integers + 2. Overall Structure of .xz File + 2.1. Stream + 2.1.1. Stream Header + 2.1.1.1. Header Magic Bytes + 2.1.1.2. Stream Flags + 2.1.1.3. CRC32 + 2.1.2. Stream Footer + 2.1.2.1. CRC32 + 2.1.2.2. Backward Size + 2.1.2.3. Stream Flags + 2.1.2.4. Footer Magic Bytes + 2.2. Stream Padding + 3. Block + 3.1. Block Header + 3.1.1. Block Header Size + 3.1.2. Block Flags + 3.1.3. Compressed Size + 3.1.4. Uncompressed Size + 3.1.5. List of Filter Flags + 3.1.6. Header Padding + 3.1.7. CRC32 + 3.2. Compressed Data + 3.3. Block Padding + 3.4. Check + 4. Index + 4.1. Index Indicator + 4.2. Number of Records + 4.3. List of Records + 4.3.1. Unpadded Size + 4.3.2. Uncompressed Size + 4.4. Index Padding + 4.5. CRC32 + 5. Filter Chains + 5.1. Alignment + 5.2. Security + 5.3. Filters + 5.3.1. LZMA2 + 5.3.2. Branch/Call/Jump Filters for Executables + 5.3.3. Delta + 5.3.3.1. Format of the Encoded Output + 5.4. Custom Filter IDs + 5.4.1. Reserved Custom Filter ID Ranges + 6. Cyclic Redundancy Checks + 7. References + + +0. Preface + + This document describes the .xz file format (filename suffix + ".xz", MIME type "application/x-xz"). It is intended that this + this format replace the old .lzma format used by LZMA SDK and + LZMA Utils. + + +0.1. Notices and Acknowledgements + + This file format was designed by Lasse Collin + and Igor Pavlov. + + Special thanks for helping with this document goes to + Ville Koskinen. Thanks for helping with this document goes to + Mark Adler, H. Peter Anvin, Mikko Pouru, and Lars Wirzenius. + + This document has been put into the public domain. + + +0.2. Getting the Latest Version + + The latest official version of this document can be downloaded + from . + + Specific versions of this document have a filename + xz-file-format-X.Y.Z.txt where X.Y.Z is the version number. + For example, the version 1.0.0 of this document is available + at . + + +0.3. Version History + + Version Date Description + + 1.2.1 2024-04-08 The URLs of this specification and + XZ Utils were changed back to the + original ones in Sections 0.2 and 7. + + 1.2.0 2024-01-19 Added RISC-V filter and updated URLs in + Sections 0.2 and 7. The URL of this + specification was changed. + + 1.1.0 2022-12-11 Added ARM64 filter and clarified 32-bit + ARM endianness in Section 5.3.2, + language improvements in Section 5.4 + + 1.0.4 2009-08-27 Language improvements in Sections 1.2, + 2.1.1.2, 3.1.1, 3.1.2, and 5.3.1 + + 1.0.3 2009-06-05 Spelling fixes in Sections 5.1 and 5.4 + + 1.0.2 2009-06-04 Typo fixes in Sections 4 and 5.3.1 + + 1.0.1 2009-06-01 Typo fix in Section 0.3 and minor + clarifications to Sections 2, 2.2, + 3.3, 4.4, and 5.3.2 + + 1.0.0 2009-01-14 The first official version + + +1. Conventions + + The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", + "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this + document are to be interpreted as described in [RFC-2119]. + + Indicating a warning means displaying a message, returning + appropriate exit status, or doing something else to let the + user know that something worth warning occurred. The operation + SHOULD still finish if a warning is indicated. + + Indicating an error means displaying a message, returning + appropriate exit status, or doing something else to let the + user know that something prevented successfully finishing the + operation. The operation MUST be aborted once an error has + been indicated. + + +1.1. Byte and Its Representation + + In this document, byte is always 8 bits. + + A "null byte" has all bits unset. That is, the value of a null + byte is 0x00. + + To represent byte blocks, this document uses notation that + is similar to the notation used in [RFC-1952]: + + +-------+ + | Foo | One byte. + +-------+ + + +---+---+ + | Foo | Two bytes; that is, some of the vertical bars + +---+---+ can be missing. + + +=======+ + | Foo | Zero or more bytes. + +=======+ + + In this document, a boxed byte or a byte sequence declared + using this notation is called "a field". The example field + above would be called "the Foo field" or plain "Foo". + + If there are many fields, they may be split to multiple lines. + This is indicated with an arrow ("--->"): + + +=====+ + | Foo | + +=====+ + + +=====+ + ---> | Bar | + +=====+ + + The above is equivalent to this: + + +=====+=====+ + | Foo | Bar | + +=====+=====+ + + +1.2. Multibyte Integers + + Multibyte integers of static length, such as CRC values, + are stored in little endian byte order (least significant + byte first). + + When smaller values are more likely than bigger values (for + example file sizes), multibyte integers are encoded in a + variable-length representation: + - Numbers in the range [0, 127] are copied as is, and take + one byte of space. + - Bigger numbers will occupy two or more bytes. All but the + last byte of the multibyte representation have the highest + (eighth) bit set. + + For now, the value of the variable-length integers is limited + to 63 bits, which limits the encoded size of the integer to + nine bytes. These limits may be increased in the future if + needed. + + The following C code illustrates encoding and decoding of + variable-length integers. The functions return the number of + bytes occupied by the integer (1-9), or zero on error. + + #include + #include + + size_t + encode(uint8_t buf[static 9], uint64_t num) + { + if (num > UINT64_MAX / 2) + return 0; + + size_t i = 0; + + while (num >= 0x80) { + buf[i++] = (uint8_t)(num) | 0x80; + num >>= 7; + } + + buf[i++] = (uint8_t)(num); + + return i; + } + + size_t + decode(const uint8_t buf[], size_t size_max, uint64_t *num) + { + if (size_max == 0) + return 0; + + if (size_max > 9) + size_max = 9; + + *num = buf[0] & 0x7F; + size_t i = 0; + + while (buf[i++] & 0x80) { + if (i >= size_max || buf[i] == 0x00) + return 0; + + *num |= (uint64_t)(buf[i] & 0x7F) << (i * 7); + } + + return i; + } + + +2. Overall Structure of .xz File + + A standalone .xz files consist of one or more Streams which may + have Stream Padding between or after them: + + +========+================+========+================+ + | Stream | Stream Padding | Stream | Stream Padding | ... + +========+================+========+================+ + + The sizes of Stream and Stream Padding are always multiples + of four bytes, thus the size of every valid .xz file MUST be + a multiple of four bytes. + + While a typical file contains only one Stream and no Stream + Padding, a decoder handling standalone .xz files SHOULD support + files that have more than one Stream or Stream Padding. + + In contrast to standalone .xz files, when the .xz file format + is used as an internal part of some other file format or + communication protocol, it usually is expected that the decoder + stops after the first Stream, and doesn't look for Stream + Padding or possibly other Streams. + + +2.1. Stream + + +-+-+-+-+-+-+-+-+-+-+-+-+=======+=======+ +=======+ + | Stream Header | Block | Block | ... | Block | + +-+-+-+-+-+-+-+-+-+-+-+-+=======+=======+ +=======+ + + +=======+-+-+-+-+-+-+-+-+-+-+-+-+ + ---> | Index | Stream Footer | + +=======+-+-+-+-+-+-+-+-+-+-+-+-+ + + All the above fields have a size that is a multiple of four. If + Stream is used as an internal part of another file format, it + is RECOMMENDED to make the Stream start at an offset that is + a multiple of four bytes. + + Stream Header, Index, and Stream Footer are always present in + a Stream. The maximum size of the Index field is 16 GiB (2^34). + + There are zero or more Blocks. The maximum number of Blocks is + limited only by the maximum size of the Index field. + + Total size of a Stream MUST be less than 8 EiB (2^63 bytes). + The same limit applies to the total amount of uncompressed + data stored in a Stream. + + If an implementation supports handling .xz files with multiple + concatenated Streams, it MAY apply the above limits to the file + as a whole instead of limiting per Stream basis. + + +2.1.1. Stream Header + + +---+---+---+---+---+---+-------+------+--+--+--+--+ + | Header Magic Bytes | Stream Flags | CRC32 | + +---+---+---+---+---+---+-------+------+--+--+--+--+ + + +2.1.1.1. Header Magic Bytes + + The first six (6) bytes of the Stream are so called Header + Magic Bytes. They can be used to identify the file type. + + Using a C array and ASCII: + const uint8_t HEADER_MAGIC[6] + = { 0xFD, '7', 'z', 'X', 'Z', 0x00 }; + + In plain hexadecimal: + FD 37 7A 58 5A 00 + + Notes: + - The first byte (0xFD) was chosen so that the files cannot + be erroneously detected as being in .lzma format, in which + the first byte is in the range [0x00, 0xE0]. + - The sixth byte (0x00) was chosen to prevent applications + from misdetecting the file as a text file. + + If the Header Magic Bytes don't match, the decoder MUST + indicate an error. + + +2.1.1.2. Stream Flags + + The first byte of Stream Flags is always a null byte. In the + future, this byte may be used to indicate a new Stream version + or other Stream properties. + + The second byte of Stream Flags is a bit field: + + Bit(s) Mask Description + 0-3 0x0F Type of Check (see Section 3.4): + ID Size Check name + 0x00 0 bytes None + 0x01 4 bytes CRC32 + 0x02 4 bytes (Reserved) + 0x03 4 bytes (Reserved) + 0x04 8 bytes CRC64 + 0x05 8 bytes (Reserved) + 0x06 8 bytes (Reserved) + 0x07 16 bytes (Reserved) + 0x08 16 bytes (Reserved) + 0x09 16 bytes (Reserved) + 0x0A 32 bytes SHA-256 + 0x0B 32 bytes (Reserved) + 0x0C 32 bytes (Reserved) + 0x0D 64 bytes (Reserved) + 0x0E 64 bytes (Reserved) + 0x0F 64 bytes (Reserved) + 4-7 0xF0 Reserved for future use; MUST be zero for now. + + Implementations SHOULD support at least the Check IDs 0x00 + (None) and 0x01 (CRC32). Supporting other Check IDs is + OPTIONAL. If an unsupported Check is used, the decoder SHOULD + indicate a warning or error. + + If any reserved bit is set, the decoder MUST indicate an error. + It is possible that there is a new field present which the + decoder is not aware of, and can thus parse the Stream Header + incorrectly. + + +2.1.1.3. CRC32 + + The CRC32 is calculated from the Stream Flags field. It is + stored as an unsigned 32-bit little endian integer. If the + calculated value does not match the stored one, the decoder + MUST indicate an error. + + The idea is that Stream Flags would always be two bytes, even + if new features are needed. This way old decoders will be able + to verify the CRC32 calculated from Stream Flags, and thus + distinguish between corrupt files (CRC32 doesn't match) and + files that the decoder doesn't support (CRC32 matches but + Stream Flags has reserved bits set). + + +2.1.2. Stream Footer + + +-+-+-+-+---+---+---+---+-------+------+----------+---------+ + | CRC32 | Backward Size | Stream Flags | Footer Magic Bytes | + +-+-+-+-+---+---+---+---+-------+------+----------+---------+ + + +2.1.2.1. CRC32 + + The CRC32 is calculated from the Backward Size and Stream Flags + fields. It is stored as an unsigned 32-bit little endian + integer. If the calculated value does not match the stored one, + the decoder MUST indicate an error. + + The reason to have the CRC32 field before the Backward Size and + Stream Flags fields is to keep the four-byte fields aligned to + a multiple of four bytes. + + +2.1.2.2. Backward Size + + Backward Size is stored as a 32-bit little endian integer, + which indicates the size of the Index field as multiple of + four bytes, minimum value being four bytes: + + real_backward_size = (stored_backward_size + 1) * 4; + + If the stored value does not match the real size of the Index + field, the decoder MUST indicate an error. + + Using a fixed-size integer to store Backward Size makes + it slightly simpler to parse the Stream Footer when the + application needs to parse the Stream backwards. + + +2.1.2.3. Stream Flags + + This is a copy of the Stream Flags field from the Stream + Header. The information stored to Stream Flags is needed + when parsing the Stream backwards. The decoder MUST compare + the Stream Flags fields in both Stream Header and Stream + Footer, and indicate an error if they are not identical. + + +2.1.2.4. Footer Magic Bytes + + As the last step of the decoding process, the decoder MUST + verify the existence of Footer Magic Bytes. If they don't + match, an error MUST be indicated. + + Using a C array and ASCII: + const uint8_t FOOTER_MAGIC[2] = { 'Y', 'Z' }; + + In hexadecimal: + 59 5A + + The primary reason to have Footer Magic Bytes is to make + it easier to detect incomplete files quickly, without + uncompressing. If the file does not end with Footer Magic Bytes + (excluding Stream Padding described in Section 2.2), it cannot + be undamaged, unless someone has intentionally appended garbage + after the end of the Stream. + + +2.2. Stream Padding + + Only the decoders that support decoding of concatenated Streams + MUST support Stream Padding. + + Stream Padding MUST contain only null bytes. To preserve the + four-byte alignment of consecutive Streams, the size of Stream + Padding MUST be a multiple of four bytes. Empty Stream Padding + is allowed. If these requirements are not met, the decoder MUST + indicate an error. + + Note that non-empty Stream Padding is allowed at the end of the + file; there doesn't need to be a new Stream after non-empty + Stream Padding. This can be convenient in certain situations + [GNU-tar]. + + The possibility of Stream Padding MUST be taken into account + when designing an application that parses Streams backwards, + and the application supports concatenated Streams. + + +3. Block + + +==============+=================+===============+=======+ + | Block Header | Compressed Data | Block Padding | Check | + +==============+=================+===============+=======+ + + +3.1. Block Header + + +-------------------+-------------+=================+ + | Block Header Size | Block Flags | Compressed Size | + +-------------------+-------------+=================+ + + +===================+======================+ + ---> | Uncompressed Size | List of Filter Flags | + +===================+======================+ + + +================+--+--+--+--+ + ---> | Header Padding | CRC32 | + +================+--+--+--+--+ + + +3.1.1. Block Header Size + + This field overlaps with the Index Indicator field (see + Section 4.1). + + This field contains the size of the Block Header field, + including the Block Header Size field itself. Valid values are + in the range [0x01, 0xFF], which indicate the size of the Block + Header as multiples of four bytes, minimum size being eight + bytes: + + real_header_size = (encoded_header_size + 1) * 4; + + If a Block Header bigger than 1024 bytes is needed in the + future, a new field can be added between the Block Header and + Compressed Data fields. The presence of this new field would + be indicated in the Block Header field. + + +3.1.2. Block Flags + + The Block Flags field is a bit field: + + Bit(s) Mask Description + 0-1 0x03 Number of filters (1-4) + 2-5 0x3C Reserved for future use; MUST be zero for now. + 6 0x40 The Compressed Size field is present. + 7 0x80 The Uncompressed Size field is present. + + If any reserved bit is set, the decoder MUST indicate an error. + It is possible that there is a new field present which the + decoder is not aware of, and can thus parse the Block Header + incorrectly. + + +3.1.3. Compressed Size + + This field is present only if the appropriate bit is set in + the Block Flags field (see Section 3.1.2). + + The Compressed Size field contains the size of the Compressed + Data field, which MUST be non-zero. Compressed Size is stored + using the encoding described in Section 1.2. If the Compressed + Size doesn't match the size of the Compressed Data field, the + decoder MUST indicate an error. + + +3.1.4. Uncompressed Size + + This field is present only if the appropriate bit is set in + the Block Flags field (see Section 3.1.2). + + The Uncompressed Size field contains the size of the Block + after uncompressing. Uncompressed Size is stored using the + encoding described in Section 1.2. If the Uncompressed Size + does not match the real uncompressed size, the decoder MUST + indicate an error. + + Storing the Compressed Size and Uncompressed Size fields serves + several purposes: + - The decoder knows how much memory it needs to allocate + for a temporary buffer in multithreaded mode. + - Simple error detection: wrong size indicates a broken file. + - Seeking forwards to a specific location in streamed mode. + + It should be noted that the only reliable way to determine + the real uncompressed size is to uncompress the Block, + because the Block Header and Index fields may contain + (intentionally or unintentionally) invalid information. + + +3.1.5. List of Filter Flags + + +================+================+ +================+ + | Filter 0 Flags | Filter 1 Flags | ... | Filter n Flags | + +================+================+ +================+ + + The number of Filter Flags fields is stored in the Block Flags + field (see Section 3.1.2). + + The format of each Filter Flags field is as follows: + + +===========+====================+===================+ + | Filter ID | Size of Properties | Filter Properties | + +===========+====================+===================+ + + Both Filter ID and Size of Properties are stored using the + encoding described in Section 1.2. Size of Properties indicates + the size of the Filter Properties field as bytes. The list of + officially defined Filter IDs and the formats of their Filter + Properties are described in Section 5.3. + + Filter IDs greater than or equal to 0x4000_0000_0000_0000 + (2^62) are reserved for implementation-specific internal use. + These Filter IDs MUST never be used in List of Filter Flags. + + +3.1.6. Header Padding + + This field contains as many null byte as it is needed to make + the Block Header have the size specified in Block Header Size. + If any of the bytes are not null bytes, the decoder MUST + indicate an error. It is possible that there is a new field + present which the decoder is not aware of, and can thus parse + the Block Header incorrectly. + + +3.1.7. CRC32 + + The CRC32 is calculated over everything in the Block Header + field except the CRC32 field itself. It is stored as an + unsigned 32-bit little endian integer. If the calculated + value does not match the stored one, the decoder MUST indicate + an error. + + By verifying the CRC32 of the Block Header before parsing the + actual contents allows the decoder to distinguish between + corrupt and unsupported files. + + +3.2. Compressed Data + + The format of Compressed Data depends on Block Flags and List + of Filter Flags. Excluding the descriptions of the simplest + filters in Section 5.3, the format of the filter-specific + encoded data is out of scope of this document. + + +3.3. Block Padding + + Block Padding MUST contain 0-3 null bytes to make the size of + the Block a multiple of four bytes. This can be needed when + the size of Compressed Data is not a multiple of four. If any + of the bytes in Block Padding are not null bytes, the decoder + MUST indicate an error. + + +3.4. Check + + The type and size of the Check field depends on which bits + are set in the Stream Flags field (see Section 2.1.1.2). + + The Check, when used, is calculated from the original + uncompressed data. If the calculated Check does not match the + stored one, the decoder MUST indicate an error. If the selected + type of Check is not supported by the decoder, it SHOULD + indicate a warning or error. + + +4. Index + + +-----------------+===================+ + | Index Indicator | Number of Records | + +-----------------+===================+ + + +=================+===============+-+-+-+-+ + ---> | List of Records | Index Padding | CRC32 | + +=================+===============+-+-+-+-+ + + Index serves several purposes. Using it, one can + - verify that all Blocks in a Stream have been processed; + - find out the uncompressed size of a Stream; and + - quickly access the beginning of any Block (random access). + + +4.1. Index Indicator + + This field overlaps with the Block Header Size field (see + Section 3.1.1). The value of Index Indicator is always 0x00. + + +4.2. Number of Records + + This field indicates how many Records there are in the List + of Records field, and thus how many Blocks there are in the + Stream. The value is stored using the encoding described in + Section 1.2. If the decoder has decoded all the Blocks of the + Stream, and then notices that the Number of Records doesn't + match the real number of Blocks, the decoder MUST indicate an + error. + + +4.3. List of Records + + List of Records consists of as many Records as indicated by the + Number of Records field: + + +========+========+ + | Record | Record | ... + +========+========+ + + Each Record contains information about one Block: + + +===============+===================+ + | Unpadded Size | Uncompressed Size | + +===============+===================+ + + If the decoder has decoded all the Blocks of the Stream, it + MUST verify that the contents of the Records match the real + Unpadded Size and Uncompressed Size of the respective Blocks. + + Implementation hint: It is possible to verify the Index with + constant memory usage by calculating for example SHA-256 of + both the real size values and the List of Records, then + comparing the hash values. Implementing this using + non-cryptographic hash like CRC32 SHOULD be avoided unless + small code size is important. + + If the decoder supports random-access reading, it MUST verify + that Unpadded Size and Uncompressed Size of every completely + decoded Block match the sizes stored in the Index. If only + partial Block is decoded, the decoder MUST verify that the + processed sizes don't exceed the sizes stored in the Index. + + +4.3.1. Unpadded Size + + This field indicates the size of the Block excluding the Block + Padding field. That is, Unpadded Size is the size of the Block + Header, Compressed Data, and Check fields. Unpadded Size is + stored using the encoding described in Section 1.2. The value + MUST never be zero; with the current structure of Blocks, the + actual minimum value for Unpadded Size is five. + + Implementation note: Because the size of the Block Padding + field is not included in Unpadded Size, calculating the total + size of a Stream or doing random-access reading requires + calculating the actual size of the Blocks by rounding Unpadded + Sizes up to the next multiple of four. + + The reason to exclude Block Padding from Unpadded Size is to + ease making a raw copy of Compressed Data without Block + Padding. This can be useful, for example, if someone wants + to convert Streams to some other file format quickly. + + +4.3.2. Uncompressed Size + + This field indicates the Uncompressed Size of the respective + Block as bytes. The value is stored using the encoding + described in Section 1.2. + + +4.4. Index Padding + + This field MUST contain 0-3 null bytes to pad the Index to + a multiple of four bytes. If any of the bytes are not null + bytes, the decoder MUST indicate an error. + + +4.5. CRC32 + + The CRC32 is calculated over everything in the Index field + except the CRC32 field itself. The CRC32 is stored as an + unsigned 32-bit little endian integer. If the calculated + value does not match the stored one, the decoder MUST indicate + an error. + + +5. Filter Chains + + The Block Flags field defines how many filters are used. When + more than one filter is used, the filters are chained; that is, + the output of one filter is the input of another filter. The + following figure illustrates the direction of data flow. + + v Uncompressed Data ^ + | Filter 0 | + Encoder | Filter 1 | Decoder + | Filter n | + v Compressed Data ^ + + +5.1. Alignment + + Alignment of uncompressed input data is usually the job of + the application producing the data. For example, to get the + best results, an archiver tool should make sure that all + PowerPC executable files in the archive stream start at + offsets that are multiples of four bytes. + + Some filters, for example LZMA2, can be configured to take + advantage of specified alignment of input data. Note that + taking advantage of aligned input can be beneficial also when + a filter is not the first filter in the chain. For example, + if you compress PowerPC executables, you may want to use the + PowerPC filter and chain that with the LZMA2 filter. Because + not only the input but also the output alignment of the PowerPC + filter is four bytes, it is now beneficial to set LZMA2 + settings so that the LZMA2 encoder can take advantage of its + four-byte-aligned input data. + + The output of the last filter in the chain is stored to the + Compressed Data field, which is is guaranteed to be aligned + to a multiple of four bytes relative to the beginning of the + Stream. This can increase + - speed, if the filtered data is handled multiple bytes at + a time by the filter-specific encoder and decoder, + because accessing aligned data in computer memory is + usually faster; and + - compression ratio, if the output data is later compressed + with an external compression tool. + + +5.2. Security + + If filters would be allowed to be chained freely, it would be + possible to create malicious files, that would be very slow to + decode. Such files could be used to create denial of service + attacks. + + Slow files could occur when multiple filters are chained: + + v Compressed input data + | Filter 1 decoder (last filter) + | Filter 0 decoder (non-last filter) + v Uncompressed output data + + The decoder of the last filter in the chain produces a lot of + output from little input. Another filter in the chain takes the + output of the last filter, and produces very little output + while consuming a lot of input. As a result, a lot of data is + moved inside the filter chain, but the filter chain as a whole + gets very little work done. + + To prevent this kind of slow files, there are restrictions on + how the filters can be chained. These restrictions MUST be + taken into account when designing new filters. + + The maximum number of filters in the chain has been limited to + four, thus there can be at maximum of three non-last filters. + Of these three non-last filters, only two are allowed to change + the size of the data. + + The non-last filters, that change the size of the data, MUST + have a limit how much the decoder can compress the data: the + decoder SHOULD produce at least n bytes of output when the + filter is given 2n bytes of input. This limit is not + absolute, but significant deviations MUST be avoided. + + The above limitations guarantee that if the last filter in the + chain produces 4n bytes of output, the chain as a whole will + produce at least n bytes of output. + + +5.3. Filters + +5.3.1. LZMA2 + + LZMA (Lempel-Ziv-Markov chain-Algorithm) is a general-purpose + compression algorithm with high compression ratio and fast + decompression. LZMA is based on LZ77 and range coding + algorithms. + + LZMA2 is an extension on top of the original LZMA. LZMA2 uses + LZMA internally, but adds support for flushing the encoder, + uncompressed chunks, eases stateful decoder implementations, + and improves support for multithreading. Thus, the plain LZMA + will not be supported in this file format. + + Filter ID: 0x21 + Size of Filter Properties: 1 byte + Changes size of data: Yes + Allow as a non-last filter: No + Allow as the last filter: Yes + + Preferred alignment: + Input data: Adjustable to 1/2/4/8/16 byte(s) + Output data: 1 byte + + The format of the one-byte Filter Properties field is as + follows: + + Bits Mask Description + 0-5 0x3F Dictionary Size + 6-7 0xC0 Reserved for future use; MUST be zero for now. + + Dictionary Size is encoded with one-bit mantissa and five-bit + exponent. The smallest dictionary size is 4 KiB and the biggest + is 4 GiB. + + Raw value Mantissa Exponent Dictionary size + 0 2 11 4 KiB + 1 3 11 6 KiB + 2 2 12 8 KiB + 3 3 12 12 KiB + 4 2 13 16 KiB + 5 3 13 24 KiB + 6 2 14 32 KiB + ... ... ... ... + 35 3 27 768 MiB + 36 2 28 1024 MiB + 37 3 29 1536 MiB + 38 2 30 2048 MiB + 39 3 30 3072 MiB + 40 2 31 4096 MiB - 1 B + + Instead of having a table in the decoder, the dictionary size + can be decoded using the following C code: + + const uint8_t bits = get_dictionary_flags() & 0x3F; + if (bits > 40) + return DICTIONARY_TOO_BIG; // Bigger than 4 GiB + + uint32_t dictionary_size; + if (bits == 40) { + dictionary_size = UINT32_MAX; + } else { + dictionary_size = 2 | (bits & 1); + dictionary_size <<= bits / 2 + 11; + } + + +5.3.2. Branch/Call/Jump Filters for Executables + + These filters convert relative branch, call, and jump + instructions to their absolute counterparts in executable + files. This conversion increases redundancy and thus + compression ratio. + + Size of Filter Properties: 0 or 4 bytes + Changes size of data: No + Allow as a non-last filter: Yes + Allow as the last filter: No + + Below is the list of filters in this category. The alignment + is the same for both input and output data. + + Filter ID Alignment Description + 0x04 1 byte x86 filter (BCJ) + 0x05 4 bytes PowerPC (big endian) filter + 0x06 16 bytes IA64 filter + 0x07 4 bytes ARM filter [1] + 0x08 2 bytes ARM Thumb filter [1] + 0x09 4 bytes SPARC filter + 0x0A 4 bytes ARM64 filter [2] + 0x0B 2 bytes RISC-V filter + + [1] These are for little endian instruction encoding. + This must not be confused with data endianness. + A processor configured for big endian data access + may still use little endian instruction encoding. + The filters don't care about the data endianness. + + [2] 4096-byte alignment gives the best results + because the address in the ADRP instruction + is a multiple of 4096 bytes. + + If the size of Filter Properties is four bytes, the Filter + Properties field contains the start offset used for address + conversions. It is stored as an unsigned 32-bit little endian + integer. The start offset MUST be a multiple of the alignment + of the filter as listed in the table above; if it isn't, the + decoder MUST indicate an error. If the size of Filter + Properties is zero, the start offset is zero. + + Setting the start offset may be useful if an executable has + multiple sections, and there are many cross-section calls. + Taking advantage of this feature usually requires usage of + the Subblock filter, whose design is not complete yet. + + +5.3.3. Delta + + The Delta filter may increase compression ratio when the value + of the next byte correlates with the value of an earlier byte + at specified distance. + + Filter ID: 0x03 + Size of Filter Properties: 1 byte + Changes size of data: No + Allow as a non-last filter: Yes + Allow as the last filter: No + + Preferred alignment: + Input data: 1 byte + Output data: Same as the original input data + + The Properties byte indicates the delta distance, which can be + 1-256 bytes backwards from the current byte: 0x00 indicates + distance of 1 byte and 0xFF distance of 256 bytes. + + +5.3.3.1. Format of the Encoded Output + + The code below illustrates both encoding and decoding with + the Delta filter. + + // Distance is in the range [1, 256]. + const unsigned int distance = get_properties_byte() + 1; + uint8_t pos = 0; + uint8_t delta[256]; + + memset(delta, 0, sizeof(delta)); + + while (1) { + const int byte = read_byte(); + if (byte == EOF) + break; + + uint8_t tmp = delta[(uint8_t)(distance + pos)]; + if (is_encoder) { + tmp = (uint8_t)(byte) - tmp; + delta[pos] = (uint8_t)(byte); + } else { + tmp = (uint8_t)(byte) + tmp; + delta[pos] = tmp; + } + + write_byte(tmp); + --pos; + } + + +5.4. Custom Filter IDs + + If a developer wants to use custom Filter IDs, there are two + choices. The first choice is to contact Lasse Collin and ask + him to allocate a range of IDs for the developer. + + The second choice is to generate a 40-bit random integer + which the developer can use as a personal Developer ID. + To minimize the risk of collisions, Developer ID has to be + a randomly generated integer, not manually selected "hex word". + The following command, which works on many free operating + systems, can be used to generate Developer ID: + + dd if=/dev/urandom bs=5 count=1 | hexdump + + The developer can then use the Developer ID to create unique + (well, hopefully unique) Filter IDs. + + Bits Mask Description + 0-15 0x0000_0000_0000_FFFF Filter ID + 16-55 0x00FF_FFFF_FFFF_0000 Developer ID + 56-62 0x3F00_0000_0000_0000 Static prefix: 0x3F + + The resulting 63-bit integer will use 9 bytes of space when + stored using the encoding described in Section 1.2. To get + a shorter ID, see the beginning of this Section how to + request a custom ID range. + + +5.4.1. Reserved Custom Filter ID Ranges + + Range Description + 0x0000_0300 - 0x0000_04FF Reserved to ease .7z compatibility + 0x0002_0000 - 0x0007_FFFF Reserved to ease .7z compatibility + 0x0200_0000 - 0x07FF_FFFF Reserved to ease .7z compatibility + + +6. Cyclic Redundancy Checks + + There are several incompatible variations to calculate CRC32 + and CRC64. For simplicity and clarity, complete examples are + provided to calculate the checks as they are used in this file + format. Implementations MAY use different code as long as it + gives identical results. + + The program below reads data from standard input, calculates + the CRC32 and CRC64 values, and prints the calculated values + as big endian hexadecimal strings to standard output. + + #include + #include + #include + + uint32_t crc32_table[256]; + uint64_t crc64_table[256]; + + void + init(void) + { + static const uint32_t poly32 = UINT32_C(0xEDB88320); + static const uint64_t poly64 + = UINT64_C(0xC96C5795D7870F42); + + for (size_t i = 0; i < 256; ++i) { + uint32_t crc32 = i; + uint64_t crc64 = i; + + for (size_t j = 0; j < 8; ++j) { + if (crc32 & 1) + crc32 = (crc32 >> 1) ^ poly32; + else + crc32 >>= 1; + + if (crc64 & 1) + crc64 = (crc64 >> 1) ^ poly64; + else + crc64 >>= 1; + } + + crc32_table[i] = crc32; + crc64_table[i] = crc64; + } + } + + uint32_t + crc32(const uint8_t *buf, size_t size, uint32_t crc) + { + crc = ~crc; + for (size_t i = 0; i < size; ++i) + crc = crc32_table[buf[i] ^ (crc & 0xFF)] + ^ (crc >> 8); + return ~crc; + } + + uint64_t + crc64(const uint8_t *buf, size_t size, uint64_t crc) + { + crc = ~crc; + for (size_t i = 0; i < size; ++i) + crc = crc64_table[buf[i] ^ (crc & 0xFF)] + ^ (crc >> 8); + return ~crc; + } + + int + main() + { + init(); + + uint32_t value32 = 0; + uint64_t value64 = 0; + uint64_t total_size = 0; + uint8_t buf[8192]; + + while (1) { + const size_t buf_size + = fread(buf, 1, sizeof(buf), stdin); + if (buf_size == 0) + break; + + total_size += buf_size; + value32 = crc32(buf, buf_size, value32); + value64 = crc64(buf, buf_size, value64); + } + + printf("Bytes: %" PRIu64 "\n", total_size); + printf("CRC-32: 0x%08" PRIX32 "\n", value32); + printf("CRC-64: 0x%016" PRIX64 "\n", value64); + + return 0; + } + + +7. References + + LZMA SDK - The original LZMA implementation + https://7-zip.org/sdk.html + + LZMA Utils - LZMA adapted to POSIX-like systems + https://tukaani.org/lzma/ + + XZ Utils - The next generation of LZMA Utils + https://tukaani.org/xz/ + + [RFC-1952] + GZIP file format specification version 4.3 + https://www.ietf.org/rfc/rfc1952.txt + - Notation of byte boxes in section "2.1. Overall conventions" + + [RFC-2119] + Key words for use in RFCs to Indicate Requirement Levels + https://www.ietf.org/rfc/rfc2119.txt + + [GNU-tar] + GNU tar 1.35 manual + https://www.gnu.org/software/tar/manual/html_node/Blocking-Factor.html + - Node 9.4.2 "Blocking Factor", paragraph that begins + "gzip will complain about trailing garbage" + - Note that this URL points to the latest version of the + manual, and may some day not contain the note which is in + 1.35. For the exact version of the manual, download GNU + tar 1.35: ftp://ftp.gnu.org/pub/gnu/tar/tar-1.35.tar.gz + diff --git a/miniconda3/envs/ladir/share/info/history.info b/miniconda3/envs/ladir/share/info/history.info new file mode 100644 index 0000000000000000000000000000000000000000..3663d06b53c9f4ad6a5b91d04c038198274acef4 --- /dev/null +++ b/miniconda3/envs/ladir/share/info/history.info @@ -0,0 +1,1461 @@ +This is history.info, produced by makeinfo version 7.1 from +history.texi. + +This document describes the GNU History library (version 8.3, 30 +December 2024), a programming tool that provides a consistent user +interface for recalling lines of previously typed input. + + Copyright © 1988-2025 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.3 or any later version published by the Free Software + Foundation; with no Invariant Sections, no Front-Cover Texts, and + no Back-Cover Texts. A copy of the license is included in the + section entitled "GNU Free Documentation License". + +INFO-DIR-SECTION Libraries +START-INFO-DIR-ENTRY +* History: (history). The GNU history library API. +END-INFO-DIR-ENTRY + + +File: history.info, Node: Top, Next: Using History Interactively, Up: (dir) + +GNU History Library +******************* + +This document describes the GNU History library, a programming tool that +provides a consistent user interface for recalling lines of previously +typed input. + +* Menu: + +* Using History Interactively:: GNU History User's Manual. +* Programming with GNU History:: GNU History Programmer's Manual. +* GNU Free Documentation License:: License for copying this manual. +* Concept Index:: Index of concepts described in this manual. +* Function and Variable Index:: Index of externally visible functions + and variables. + + +File: history.info, Node: Using History Interactively, Next: Programming with GNU History, Prev: Top, Up: Top + +1 Using History Interactively +***************************** + +This chapter describes how to use the GNU History Library interactively, +from a user's standpoint. It should be considered a user's guide. For +information on using the GNU History Library in your own programs, *note +Programming with GNU History::. + +* Menu: + +* History Interaction:: What it feels like using History as a user. + + +File: history.info, Node: History Interaction, Up: Using History Interactively + +1.1 History Expansion +===================== + +The History library provides a history expansion feature that is similar +to the history expansion provided by ‘csh’ (also referred to as history +substitution where appropriate). This section describes the syntax used +to manipulate the history information. + + History expansions introduce words from the history list into the +input stream, making it easy to repeat commands, insert the arguments to +a previous command into the current input line, or fix errors in +previous commands quickly. + + History expansion takes place in two parts. The first is to +determine which entry from the history list should be used during +substitution. The second is to select portions of that entry to include +into the current one. + + The entry selected from the history is called the “event”, and the +portions of that entry that are acted upon are “words”. Various +“modifiers” are available to manipulate the selected words. The entry +is split into words in the same fashion that Bash does when reading +input, so that several words surrounded by quotes are considered one +word. The “event designator” selects the event, the optional “word +designator” selects words from the event, and various optional +“modifiers” are available to manipulate the selected words. + + History expansions are introduced by the appearance of the history +expansion character, which is ‘!’ by default. History expansions may +appear anywhere in the input, but do not nest. + + History expansion implements shell-like quoting conventions: a +backslash can be used to remove the special handling for the next +character; single quotes enclose verbatim sequences of characters, and +can be used to inhibit history expansion; and characters enclosed within +double quotes may be subject to history expansion, since backslash can +escape the history expansion character, but single quotes may not, since +they are not treated specially within double quotes. + + There is a special abbreviation for substitution, active when the +QUICK SUBSTITUTION character (default ‘^’) is the first character on the +line. It selects the previous history list entry, using an event +designator equivalent to ‘!!’, and substitutes one string for another in +that entry. It is described below (*note Event Designators::). This is +the only history expansion that does not begin with the history +expansion character. + +* Menu: + +* Event Designators:: How to specify which history line to use. +* Word Designators:: Specifying which words are of interest. +* Modifiers:: Modifying the results of substitution. + + +File: history.info, Node: Event Designators, Next: Word Designators, Up: History Interaction + +1.1.1 Event Designators +----------------------- + +An event designator is a reference to an entry in the history list. The +event designator consists of the portion of the word beginning with the +history expansion character, and ending with the word designator if one +is present, or the end of the word. Unless the reference is absolute, +events are relative to the current position in the history list. + +‘!’ + Start a history substitution, except when followed by a space, tab, + the end of the line, or ‘=’. + +‘!N’ + Refer to history list entry N. + +‘!-N’ + Refer to the history entry minus N. + +‘!!’ + Refer to the previous entry. This is a synonym for ‘!-1’. + +‘!STRING’ + Refer to the most recent command preceding the current position in + the history list starting with STRING. + +‘!?STRING[?]’ + Refer to the most recent command preceding the current position in + the history list containing STRING. The trailing ‘?’ may be + omitted if the STRING is followed immediately by a newline. If + STRING is missing, this uses the string from the most recent + search; it is an error if there is no previous search string. + +‘^STRING1^STRING2^’ + Quick Substitution. Repeat the last command, replacing STRING1 + with STRING2. Equivalent to ‘!!:s^STRING1^STRING2^’. + +‘!#’ + The entire command line typed so far. + + +File: history.info, Node: Word Designators, Next: Modifiers, Prev: Event Designators, Up: History Interaction + +1.1.2 Word Designators +---------------------- + +Word designators are used to select desired words from the event. They +are optional; if the word designator isn't supplied, the history +expansion uses the entire event. A ‘:’ separates the event +specification from the word designator. It may be omitted if the word +designator begins with a ‘^’, ‘$’, ‘*’, ‘-’, or ‘%’. Words are numbered +from the beginning of the line, with the first word being denoted by 0 +(zero). That first word is usually the command word, and the arguments +begin with the second word. Words are inserted into the current line +separated by single spaces. + + For example, + +‘!!’ + designates the preceding command. When you type this, the + preceding command is repeated in toto. + +‘!!:$’ + designates the last word of the preceding command. This may be + shortened to ‘!$’. + +‘!fi:2’ + designates the second argument of the most recent command starting + with the letters ‘fi’. + + Here are the word designators: + +‘0 (zero)’ + The ‘0’th word. For the shell, and many other, applications, this + is the command word. + +‘N’ + The Nth word. + +‘^’ + The first argument: word 1. + +‘$’ + The last word. This is usually the last argument, but expands to + the zeroth word if there is only one word in the line. + +‘%’ + The first word matched by the most recent ‘?STRING?’ search, if the + search string begins with a character that is part of a word. By + default, searches begin at the end of each line and proceed to the + beginning, so the first word matched is the one closest to the end + of the line. + +‘X-Y’ + A range of words; ‘-Y’ abbreviates ‘0-Y’. + +‘*’ + All of the words, except the ‘0’th. This is a synonym for ‘1-$’. + It is not an error to use ‘*’ if there is just one word in the + event; it expands to the empty string in that case. + +‘X*’ + Abbreviates ‘X-$’. + +‘X-’ + Abbreviates ‘X-$’ like ‘X*’, but omits the last word. If ‘x’ is + missing, it defaults to 0. + + If a word designator is supplied without an event specification, the +previous command is used as the event, equivalent to ‘!!’. + + +File: history.info, Node: Modifiers, Prev: Word Designators, Up: History Interaction + +1.1.3 Modifiers +--------------- + +After the optional word designator, you can add a sequence of one or +more of the following modifiers, each preceded by a ‘:’. These modify, +or edit, the word or words selected from the history event. + +‘h’ + Remove a trailing filename component, leaving only the head. + +‘t’ + Remove all leading filename components, leaving the tail. + +‘r’ + Remove a trailing suffix of the form ‘.SUFFIX’, leaving the + basename. + +‘e’ + Remove all but the trailing suffix. + +‘p’ + Print the new command but do not execute it. + +‘s/OLD/NEW/’ + Substitute NEW for the first occurrence of OLD in the event line. + Any character may be used as the delimiter in place of ‘/’. The + delimiter may be quoted in OLD and NEW with a single backslash. If + ‘&’ appears in NEW, it is replaced with OLD. A single backslash + quotes the ‘&’ in OLD and NEW. If OLD is null, it is set to the + last OLD substituted, or, if no previous history substitutions took + place, the last STRING in a !?STRING‘[?]’ search. If NEW is null, + each matching OLD is deleted. The final delimiter is optional if + it is the last character on the input line. + +‘&’ + Repeat the previous substitution. + +‘g’ +‘a’ + Cause changes to be applied over the entire event line. This is + used in conjunction with ‘s’, as in ‘gs/OLD/NEW/’, or with ‘&’. + +‘G’ + Apply the following ‘s’ or ‘&’ modifier once to each word in the + event. + + +File: history.info, Node: Programming with GNU History, Next: GNU Free Documentation License, Prev: Using History Interactively, Up: Top + +2 Programming with GNU History +****************************** + +This chapter describes how to interface programs that you write with the +GNU History Library. It should be considered a technical guide. For +information on the interactive use of GNU History, *note Using History +Interactively::. + +* Menu: + +* Introduction to History:: What is the GNU History library for? +* History Storage:: How information is stored. +* History Functions:: Functions that you can use. +* History Variables:: Variables that control behavior. +* History Programming Example:: Example of using the GNU History Library. + + +File: history.info, Node: Introduction to History, Next: History Storage, Up: Programming with GNU History + +2.1 Introduction to History +=========================== + +Many programs read input from the user a line at a time. The GNU +History library is able to keep track of those lines, associate +arbitrary data with each line, and utilize information from previous +lines when composing new ones. + + A programmer using the History library can use functions to save +commands on a history list, associate arbitrary data with history list +entries, remove entries from the list, search through the list for a +line containing an arbitrary text string, reference any entry in the +list directly, and read and write the history list from and to a file. +In addition, a history “expansion” function is available which provides +for a consistent user interface across different programs. + + Someone using programs written with the History library has the +benefit of a consistent user interface with a set of well-known commands +for manipulating the text of previous lines and using that text in new +commands. The basic history manipulation commands are similar to the +history substitution provided by ‘csh’. + + The programmer can also use the Readline library, which includes some +history manipulation by default, and has the added advantage of command +line editing. + + Before declaring any functions using any functionality the History +library provides in other code, an application writer should include the +file ‘’ in any file that uses the History library's +features. It supplies declarations for all of the library's public +functions and variables, and declares all of the public data structures. + + +File: history.info, Node: History Storage, Next: History Functions, Prev: Introduction to History, Up: Programming with GNU History + +2.2 History Storage +=================== + +The history list is an array of history entries. A history entry is +declared as follows: + + typedef void *histdata_t; + + typedef struct _hist_entry { + char *line; + char *timestamp; + histdata_t data; + } HIST_ENTRY; + + The history list itself might therefore be declared as + + HIST_ENTRY **the_history_list; + + The state of the History library is encapsulated into a single +structure: + + /* + * A structure used to pass around the current state of the history. + */ + typedef struct _hist_state { + HIST_ENTRY **entries; /* Pointer to the entries themselves. */ + int offset; /* The location pointer within this array. */ + int length; /* Number of elements within this array. */ + int size; /* Number of slots allocated to this array. */ + int flags; + } HISTORY_STATE; + + If the flags member includes ‘HS_STIFLED’, the history has been +stifled (limited to a maximum number of entries). + + +File: history.info, Node: History Functions, Next: History Variables, Prev: History Storage, Up: Programming with GNU History + +2.3 History Functions +===================== + +This section describes the calling sequence for the various functions +exported by the GNU History library. + +* Menu: + +* Initializing History and State Management:: Functions to call when you + want to use history in a + program. +* History List Management:: Functions used to manage the list + of history entries. +* Information About the History List:: Functions returning information about + the history list. +* Moving Around the History List:: Functions used to change the position + in the history list. +* Searching the History List:: Functions to search the history list + for entries containing a string. +* Managing the History File:: Functions that read and write a file + containing the history list. +* History Expansion:: Functions to perform csh-like history + expansion. + + +File: history.info, Node: Initializing History and State Management, Next: History List Management, Up: History Functions + +2.3.1 Initializing History and State Management +----------------------------------------------- + +This section describes functions used to initialize and manage the state +of the History library when you want to use the history functions in +your program. + + -- Function: void using_history (void) + Begin a session that will use the history functions. This + initializes the interactive variables. + + -- Function: HISTORY_STATE * history_get_history_state (void) + Return a structure describing the current state of the input + history. + + -- Function: void history_set_history_state (HISTORY_STATE *state) + Set the state of the history list according to STATE. + + +File: history.info, Node: History List Management, Next: Information About the History List, Prev: Initializing History and State Management, Up: History Functions + +2.3.2 History List Management +----------------------------- + +These functions manage individual entries on the history list, or set +parameters managing the list itself. + + -- Function: void add_history (const char *string) + Add STRING to the end of the history list, and set the associated + data field (if any) to ‘NULL’. If the maximum number of history + entries has been set using ‘stifle_history()’, and the new number + of history entries would exceed that maximum, this removes the + oldest history entry. + + -- Function: void add_history_time (const char *string) + Change the time stamp associated with the most recent history entry + to STRING. + + -- Function: HIST_ENTRY * remove_history (int which) + Remove the history entry at offset WHICH from the history list. + This returns the removed element so you can free the line, data, + and containing structure. Since the data is private to your + application, the History library doesn't know how to free it, if + necessary. + + -- Function: histdata_t free_history_entry (HIST_ENTRY *histent) + Free the history entry HISTENT and any history library private data + associated with it. Returns the application-specific data so the + caller can dispose of it. + + -- Function: HIST_ENTRY * replace_history_entry (int which, const char + *line, histdata_t data) + Make the history entry at offset WHICH have LINE and DATA. This + returns the old entry so the caller can dispose of any + application-specific data. In the case of an invalid WHICH, this + returns ‘NULL’. + + -- Function: void clear_history (void) + Clear the history list by deleting all the entries. + + -- Function: void stifle_history (int max) + Stifle the history list, remembering only the last MAX entries. + The history list will contain only MAX entries at a time. + + -- Function: int unstifle_history (void) + Stop stifling the history. This returns the previously-set maximum + number of history entries (as set by ‘stifle_history()’). The + value is positive if the history was stifled, negative if it + wasn't. + + -- Function: int history_is_stifled (void) + Returns non-zero if the history is stifled, zero if it is not. + + +File: history.info, Node: Information About the History List, Next: Moving Around the History List, Prev: History List Management, Up: History Functions + +2.3.3 Information About the History List +---------------------------------------- + +These functions return information about the entire history list or +individual list entries. + + -- Function: HIST_ENTRY ** history_list (void) + Return a ‘NULL’ terminated array of ‘HIST_ENTRY *’ which is the + current input history. Element 0 of this list is the beginning of + time. Return ‘NULL’ if there is no history. + + -- Function: int where_history (void) + Return the offset of the current history entry. + + -- Function: HIST_ENTRY * current_history (void) + Return the history entry at the current position, as determined by + ‘where_history()’. If there is no entry there, return ‘NULL’. + + -- Function: HIST_ENTRY * history_get (int offset) + Return the history entry at position OFFSET. The range of valid + values of OFFSET starts at ‘history_base’ and ends at + HISTORY_LENGTH - 1 (*note History Variables::). If there is no + entry there, or if OFFSET is outside the valid range, return + ‘NULL’. + + -- Function: time_t history_get_time (HIST_ENTRY *entry) + Return the time stamp associated with the history entry ENTRY. If + the timestamp is missing or invalid, return 0. + + -- Function: int history_total_bytes (void) + Return the number of bytes that the primary history entries are + using. This function returns the sum of the lengths of all the + lines in the history. + + +File: history.info, Node: Moving Around the History List, Next: Searching the History List, Prev: Information About the History List, Up: History Functions + +2.3.4 Moving Around the History List +------------------------------------ + +These functions allow the current index into the history list to be set +or changed. + + -- Function: int history_set_pos (int pos) + Set the current history offset to POS, an absolute index into the + list. Returns 1 on success, 0 if POS is less than zero or greater + than the number of history entries. + + -- Function: HIST_ENTRY * previous_history (void) + Back up the current history offset to the previous history entry, + and return a pointer to that entry. If there is no previous entry, + return ‘NULL’. + + -- Function: HIST_ENTRY * next_history (void) + If the current history offset refers to a valid history entry, + increment the current history offset. If the possibly-incremented + history offset refers to a valid history entry, return a pointer to + that entry; otherwise, return ‘NULL’. + + +File: history.info, Node: Searching the History List, Next: Managing the History File, Prev: Moving Around the History List, Up: History Functions + +2.3.5 Searching the History List +-------------------------------- + +These functions search the history list for entries containing a +specific string. Searching may be performed both forward and backward +from the current history position. The search may be “anchored”, +meaning that the string must match at the beginning of a history entry. + + -- Function: int history_search (const char *string, int direction) + Search the history for STRING, starting at the current history + offset. If DIRECTION is less than 0, then the search is through + previous entries, otherwise through subsequent entries. If STRING + is found, then the current history index is set to that history + entry, and ‘history_search’ returns the offset in the line of the + entry where STRING was found. Otherwise, nothing is changed, and + this returns -1. + + -- Function: int history_search_prefix (const char *string, int + direction) + Search the history for STRING, starting at the current history + offset. The search is anchored: matching history entries must + begin with STRING. If DIRECTION is less than 0, then the search is + through previous entries, otherwise through subsequent entries. If + STRING is found, then the current history index is set to that + entry, and the return value is 0. Otherwise, nothing is changed, + and this returns -1. + + -- Function: int history_search_pos (const char *string, int direction, + int pos) + Search for STRING in the history list, starting at POS, an absolute + index into the list. If DIRECTION is negative, the search proceeds + backward from POS, otherwise forward. Returns the index in the + history list of the history element where STRING was found, or -1 + otherwise. + + +File: history.info, Node: Managing the History File, Next: History Expansion, Prev: Searching the History List, Up: History Functions + +2.3.6 Managing the History File +------------------------------- + +The History library can read the history from and write it to a file. +This section documents the functions for managing a history file. + + -- Function: int read_history (const char *filename) + Add the contents of FILENAME to the history list, one entry at a + time. If FILENAME is ‘NULL’, this reads from ‘~/.history’, if it + exists. This attempts to determine whether the history file + includes timestamp information, and assigns timestamps to the + history entries it reads if so. Returns 0 if successful, or + ‘errno’ if not. + + -- Function: int read_history_range (const char *filename, int from, + int to) + Read a range of lines from FILENAME, adding them to the history + list. Start reading at line FROM and end at TO. If FROM is zero, + start at the beginning. If TO is less than FROM, this reads until + the end of the file. This attempts to determine whether the + history file includes timestamp information, and assigns timestamps + to the history entries it reads if so. If FILENAME is ‘NULL’, this + reads from ‘~/.history’, if it exists. Returns 0 if successful, or + ‘errno’ if not. + + -- Function: int write_history (const char *filename) + Write the current history to FILENAME, overwriting FILENAME if + necessary. This writes timestamp information if the + ‘history_write_timestamps’ variable is set to a non-zero value. If + FILENAME is ‘NULL’, then write the history list to ‘~/.history’. + Returns 0 on success, or ‘errno’ on a read or write error. + + -- Function: int append_history (int nelements, const char *filename) + Append the last NELEMENTS of the history list to FILENAME. This + writes timestamp information if the ‘history_write_timestamps’ + variable is set to a non-zero value. If FILENAME is ‘NULL’, then + append to ‘~/.history’. Returns 0 on success, or ‘errno’ on a read + or write error. + + -- Function: int history_truncate_file (const char *filename, int + nlines) + Truncate the history file FILENAME, leaving only the last NLINES + lines. If FILENAME is ‘NULL’, this truncates ‘~/.history’. + Returns 0 on success, or ‘errno’ on failure. + + +File: history.info, Node: History Expansion, Prev: Managing the History File, Up: History Functions + +2.3.7 History Expansion +----------------------- + +These functions implement history expansion. + + -- Function: int history_expand (const char *string, char **output) + Expand STRING, placing the result into OUTPUT, a pointer to a + string (*note History Interaction::). Returns: + ‘0’ + If no expansions took place (or, if the only change in the + text was the removal of escape characters preceding the + history expansion character); + ‘1’ + if expansions did take place; + ‘-1’ + if there was an error in expansion; + ‘2’ + if the returned line should be displayed, but not executed, as + with the ‘:p’ modifier (*note Modifiers::). + + If an error occurred during expansion, then OUTPUT contains a + descriptive error message. + + -- Function: char * get_history_event (const char *string, int *cindex, + int qchar) + Returns the text of the history event beginning at STRING + + *CINDEX. Modifies *CINDEX to point to after the event specifier. + At function entry, CINDEX points to the index into STRING where the + history event specification begins. QCHAR is a character that is + allowed to end the event specification in addition to the "normal" + terminating characters. + + -- Function: char ** history_tokenize (const char *string) + Return an array of tokens parsed out of STRING, much as the shell + might. The tokens are split on the characters in the + HISTORY_WORD_DELIMITERS variable, and shell quoting conventions are + obeyed as described below. + + -- Function: char * history_arg_extract (int first, int last, const + char *string) + Extract a string segment consisting of the FIRST through LAST + arguments present in STRING. This splits STRING into arguments + using ‘history_tokenize’. + + +File: history.info, Node: History Variables, Next: History Programming Example, Prev: History Functions, Up: Programming with GNU History + +2.4 History Variables +===================== + +This section describes the externally-visible variables exported by the +GNU History Library. + + -- Variable: int history_base + The logical offset of the first entry in the history list. + + -- Variable: int history_length + The number of entries currently stored in the history list. + + -- Variable: int history_max_entries + The maximum number of history entries. This must be changed using + ‘stifle_history()’. + + -- Variable: int history_write_timestamps + If non-zero, timestamps are written to the history file, so they + can be preserved between sessions. The default value is 0, meaning + that timestamps are not saved. + + The current timestamp format uses the value of HISTORY_COMMENT_CHAR + to delimit timestamp entries in the history file. If that variable + does not have a value (the default), the history library will not + write timestamps. + + -- Variable: char history_expansion_char + The character that introduces a history event. The default is ‘!’. + Setting this to 0 inhibits history expansion. + + -- Variable: char history_subst_char + The character that invokes word substitution if found at the start + of a line. The default is ‘^’. + + -- Variable: char history_comment_char + During tokenization, if this character appears as the first + character of a word, then it and all subsequent characters up to a + newline are ignored, suppressing history expansion for the + remainder of the line. This is disabled by default. + + -- Variable: char * history_word_delimiters + The characters that separate tokens for ‘history_tokenize()’. The + default value is ‘" \t\n()<>;&|"’. + + -- Variable: char * history_search_delimiter_chars + The list of additional characters which can delimit a history + search string, in addition to space, TAB, ‘:’ and ‘?’ in the case + of a substring search. The default is empty. + + -- Variable: char * history_no_expand_chars + The list of characters which inhibit history expansion if found + immediately following HISTORY_EXPANSION_CHAR. The default is + space, tab, newline, carriage return, and ‘=’. + + -- Variable: int history_quotes_inhibit_expansion + If non-zero, the history expansion code implements shell-like + quoting: single-quoted words are not scanned for the history + expansion character or the history comment character, and + double-quoted words may have history expansion performed, since + single quotes are not special within double quotes. The default + value is 0. + + -- Variable: int history_quoting_state + An application may set this variable to indicate that the current + line being expanded is subject to existing quoting. If set to ‘'’, + history expansion assumes that the line is single-quoted and + inhibit expansion until it reads an unquoted closing single quote; + if set to ‘"’, history expansion assumes the line is double quoted + until it reads an unquoted closing double quote. If set to 0, the + default, history expansion assumes the line is not quoted and + treats quote characters within the line as described above. This + is only effective if HISTORY_QUOTES_INHIBIT_EXPANSION is set. This + is intended for use by applications like Bash which allow quoted + strings to span multiple lines. + + -- Variable: rl_linebuf_func_t * history_inhibit_expansion_function + This should be set to the address of a function that takes two + arguments: a ‘char *’ (STRING) and an ‘int’ index into that string + (I). It should return a non-zero value if the history expansion + starting at STRING[I] should not be performed; zero if the + expansion should be done. It is intended for use by applications + like Bash that use the history expansion character for additional + purposes. By default, this variable is set to ‘NULL’. + + +File: history.info, Node: History Programming Example, Prev: History Variables, Up: Programming with GNU History + +2.5 History Programming Example +=============================== + +The following program demonstrates simple use of the GNU History +Library. + + #include + #include + + int + main (int argc, char **argv) + { + char line[1024], *t; + int len, done = 0; + + line[0] = 0; + + using_history (); + while (!done) + { + printf ("history$ "); + fflush (stdout); + t = fgets (line, sizeof (line) - 1, stdin); + if (t && *t) + { + len = strlen (t); + if (t[len - 1] == '\n') + t[len - 1] = '\0'; + } + + if (!t) + strcpy (line, "quit"); + + if (line[0]) + { + char *expansion; + int result; + + result = history_expand (line, &expansion); + if (result) + fprintf (stderr, "%s\n", expansion); + + if (result < 0 || result == 2) + { + free (expansion); + continue; + } + + add_history (expansion); + strncpy (line, expansion, sizeof (line) - 1); + free (expansion); + } + + if (strcmp (line, "quit") == 0) + done = 1; + else if (strcmp (line, "save") == 0) + write_history ("history_file"); + else if (strcmp (line, "read") == 0) + read_history ("history_file"); + else if (strcmp (line, "list") == 0) + { + register HIST_ENTRY **the_list; + register int i; + + the_list = history_list (); + if (the_list) + for (i = 0; the_list[i]; i++) + printf ("%d: %s\n", i + history_base, the_list[i]->line); + } + else if (strncmp (line, "delete", 6) == 0) + { + int which; + if ((sscanf (line + 6, "%d", &which)) == 1) + { + HIST_ENTRY *entry = remove_history (which); + if (!entry) + fprintf (stderr, "No such entry %d\n", which); + else + { + free (entry->line); + free (entry); + } + } + else + { + fprintf (stderr, "non-numeric arg given to `delete'\n"); + } + } + } + } + + +File: history.info, Node: GNU Free Documentation License, Next: Concept Index, Prev: Programming with GNU History, Up: Top + +Appendix A GNU Free Documentation License +***************************************** + + Version 1.3, 3 November 2008 + + Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + 0. PREAMBLE + + The purpose of this License is to make a manual, textbook, or other + functional and useful document “free” in the sense of freedom: to + assure everyone the effective freedom to copy and redistribute it, + with or without modifying it, either commercially or + noncommercially. Secondarily, this License preserves for the + author and publisher a way to get credit for their work, while not + being considered responsible for modifications made by others. + + This License is a kind of "copyleft", which means that derivative + works of the document must themselves be free in the same sense. + It complements the GNU General Public License, which is a copyleft + license designed for free software. + + We have designed this License in order to use it for manuals for + free software, because free software needs free documentation: a + free program should come with manuals providing the same freedoms + that the software does. But this License is not limited to + software manuals; it can be used for any textual work, regardless + of subject matter or whether it is published as a printed book. We + recommend this License principally for works whose purpose is + instruction or reference. + + 1. APPLICABILITY AND DEFINITIONS + + This License applies to any manual or other work, in any medium, + that contains a notice placed by the copyright holder saying it can + be distributed under the terms of this License. Such a notice + grants a world-wide, royalty-free license, unlimited in duration, + to use that work under the conditions stated herein. The + "Document", below, refers to any such manual or work. Any member + of the public is a licensee, and is addressed as "you". You accept + the license if you copy, modify or distribute the work in a way + requiring permission under copyright law. + + A "Modified Version" of the Document means any work containing the + Document or a portion of it, either copied verbatim, or with + modifications and/or translated into another language. + + A "Secondary Section" is a named appendix or a front-matter section + of the Document that deals exclusively with the relationship of the + publishers or authors of the Document to the Document's overall + subject (or to related matters) and contains nothing that could + fall directly within that overall subject. (Thus, if the Document + is in part a textbook of mathematics, a Secondary Section may not + explain any mathematics.) The relationship could be a matter of + historical connection with the subject or with related matters, or + of legal, commercial, philosophical, ethical or political position + regarding them. + + The "Invariant Sections" are certain Secondary Sections whose + titles are designated, as being those of Invariant Sections, in the + notice that says that the Document is released under this License. + If a section does not fit the above definition of Secondary then it + is not allowed to be designated as Invariant. The Document may + contain zero Invariant Sections. If the Document does not identify + any Invariant Sections then there are none. + + The "Cover Texts" are certain short passages of text that are + listed, as Front-Cover Texts or Back-Cover Texts, in the notice + that says that the Document is released under this License. A + Front-Cover Text may be at most 5 words, and a Back-Cover Text may + be at most 25 words. + + A "Transparent" copy of the Document means a machine-readable copy, + represented in a format whose specification is available to the + general public, that is suitable for revising the document + straightforwardly with generic text editors or (for images composed + of pixels) generic paint programs or (for drawings) some widely + available drawing editor, and that is suitable for input to text + formatters or for automatic translation to a variety of formats + suitable for input to text formatters. A copy made in an otherwise + Transparent file format whose markup, or absence of markup, has + been arranged to thwart or discourage subsequent modification by + readers is not Transparent. An image format is not Transparent if + used for any substantial amount of text. A copy that is not + "Transparent" is called "Opaque". + + Examples of suitable formats for Transparent copies include plain + ASCII without markup, Texinfo input format, LaTeX input format, + SGML or XML using a publicly available DTD, and standard-conforming + simple HTML, PostScript or PDF designed for human modification. + Examples of transparent image formats include PNG, XCF and JPG. + Opaque formats include proprietary formats that can be read and + edited only by proprietary word processors, SGML or XML for which + the DTD and/or processing tools are not generally available, and + the machine-generated HTML, PostScript or PDF produced by some word + processors for output purposes only. + + The "Title Page" means, for a printed book, the title page itself, + plus such following pages as are needed to hold, legibly, the + material this License requires to appear in the title page. For + works in formats which do not have any title page as such, "Title + Page" means the text near the most prominent appearance of the + work's title, preceding the beginning of the body of the text. + + The "publisher" means any person or entity that distributes copies + of the Document to the public. + + A section "Entitled XYZ" means a named subunit of the Document + whose title either is precisely XYZ or contains XYZ in parentheses + following text that translates XYZ in another language. (Here XYZ + stands for a specific section name mentioned below, such as + "Acknowledgements", "Dedications", "Endorsements", or "History".) + To "Preserve the Title" of such a section when you modify the + Document means that it remains a section "Entitled XYZ" according + to this definition. + + The Document may include Warranty Disclaimers next to the notice + which states that this License applies to the Document. These + Warranty Disclaimers are considered to be included by reference in + this License, but only as regards disclaiming warranties: any other + implication that these Warranty Disclaimers may have is void and + has no effect on the meaning of this License. + + 2. VERBATIM COPYING + + You may copy and distribute the Document in any medium, either + commercially or noncommercially, provided that this License, the + copyright notices, and the license notice saying this License + applies to the Document are reproduced in all copies, and that you + add no other conditions whatsoever to those of this License. You + may not use technical measures to obstruct or control the reading + or further copying of the copies you make or distribute. However, + you may accept compensation in exchange for copies. If you + distribute a large enough number of copies you must also follow the + conditions in section 3. + + You may also lend copies, under the same conditions stated above, + and you may publicly display copies. + + 3. COPYING IN QUANTITY + + If you publish printed copies (or copies in media that commonly + have printed covers) of the Document, numbering more than 100, and + the Document's license notice requires Cover Texts, you must + enclose the copies in covers that carry, clearly and legibly, all + these Cover Texts: Front-Cover Texts on the front cover, and + Back-Cover Texts on the back cover. Both covers must also clearly + and legibly identify you as the publisher of these copies. The + front cover must present the full title with all words of the title + equally prominent and visible. You may add other material on the + covers in addition. Copying with changes limited to the covers, as + long as they preserve the title of the Document and satisfy these + conditions, can be treated as verbatim copying in other respects. + + If the required texts for either cover are too voluminous to fit + legibly, you should put the first ones listed (as many as fit + reasonably) on the actual cover, and continue the rest onto + adjacent pages. + + If you publish or distribute Opaque copies of the Document + numbering more than 100, you must either include a machine-readable + Transparent copy along with each Opaque copy, or state in or with + each Opaque copy a computer-network location from which the general + network-using public has access to download using public-standard + network protocols a complete Transparent copy of the Document, free + of added material. If you use the latter option, you must take + reasonably prudent steps, when you begin distribution of Opaque + copies in quantity, to ensure that this Transparent copy will + remain thus accessible at the stated location until at least one + year after the last time you distribute an Opaque copy (directly or + through your agents or retailers) of that edition to the public. + + It is requested, but not required, that you contact the authors of + the Document well before redistributing any large number of copies, + to give them a chance to provide you with an updated version of the + Document. + + 4. MODIFICATIONS + + You may copy and distribute a Modified Version of the Document + under the conditions of sections 2 and 3 above, provided that you + release the Modified Version under precisely this License, with the + Modified Version filling the role of the Document, thus licensing + distribution and modification of the Modified Version to whoever + possesses a copy of it. In addition, you must do these things in + the Modified Version: + + A. Use in the Title Page (and on the covers, if any) a title + distinct from that of the Document, and from those of previous + versions (which should, if there were any, be listed in the + History section of the Document). You may use the same title + as a previous version if the original publisher of that + version gives permission. + + B. List on the Title Page, as authors, one or more persons or + entities responsible for authorship of the modifications in + the Modified Version, together with at least five of the + principal authors of the Document (all of its principal + authors, if it has fewer than five), unless they release you + from this requirement. + + C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. + + D. Preserve all the copyright notices of the Document. + + E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. + + F. Include, immediately after the copyright notices, a license + notice giving the public permission to use the Modified + Version under the terms of this License, in the form shown in + the Addendum below. + + G. Preserve in that license notice the full lists of Invariant + Sections and required Cover Texts given in the Document's + license notice. + + H. Include an unaltered copy of this License. + + I. Preserve the section Entitled "History", Preserve its Title, + and add to it an item stating at least the title, year, new + authors, and publisher of the Modified Version as given on the + Title Page. If there is no section Entitled "History" in the + Document, create one stating the title, year, authors, and + publisher of the Document as given on its Title Page, then add + an item describing the Modified Version as stated in the + previous sentence. + + J. Preserve the network location, if any, given in the Document + for public access to a Transparent copy of the Document, and + likewise the network locations given in the Document for + previous versions it was based on. These may be placed in the + "History" section. You may omit a network location for a work + that was published at least four years before the Document + itself, or if the original publisher of the version it refers + to gives permission. + + K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section + all the substance and tone of each of the contributor + acknowledgements and/or dedications given therein. + + L. Preserve all the Invariant Sections of the Document, unaltered + in their text and in their titles. Section numbers or the + equivalent are not considered part of the section titles. + + M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. + + N. Do not retitle any existing section to be Entitled + "Endorsements" or to conflict in title with any Invariant + Section. + + O. Preserve any Warranty Disclaimers. + + If the Modified Version includes new front-matter sections or + appendices that qualify as Secondary Sections and contain no + material copied from the Document, you may at your option designate + some or all of these sections as invariant. To do this, add their + titles to the list of Invariant Sections in the Modified Version's + license notice. These titles must be distinct from any other + section titles. + + You may add a section Entitled "Endorsements", provided it contains + nothing but endorsements of your Modified Version by various + parties--for example, statements of peer review or that the text + has been approved by an organization as the authoritative + definition of a standard. + + You may add a passage of up to five words as a Front-Cover Text, + and a passage of up to 25 words as a Back-Cover Text, to the end of + the list of Cover Texts in the Modified Version. Only one passage + of Front-Cover Text and one of Back-Cover Text may be added by (or + through arrangements made by) any one entity. If the Document + already includes a cover text for the same cover, previously added + by you or by arrangement made by the same entity you are acting on + behalf of, you may not add another; but you may replace the old + one, on explicit permission from the previous publisher that added + the old one. + + The author(s) and publisher(s) of the Document do not by this + License give permission to use their names for publicity for or to + assert or imply endorsement of any Modified Version. + + 5. COMBINING DOCUMENTS + + You may combine the Document with other documents released under + this License, under the terms defined in section 4 above for + modified versions, provided that you include in the combination all + of the Invariant Sections of all of the original documents, + unmodified, and list them all as Invariant Sections of your + combined work in its license notice, and that you preserve all + their Warranty Disclaimers. + + The combined work need only contain one copy of this License, and + multiple identical Invariant Sections may be replaced with a single + copy. If there are multiple Invariant Sections with the same name + but different contents, make the title of each such section unique + by adding at the end of it, in parentheses, the name of the + original author or publisher of that section if known, or else a + unique number. Make the same adjustment to the section titles in + the list of Invariant Sections in the license notice of the + combined work. + + In the combination, you must combine any sections Entitled + "History" in the various original documents, forming one section + Entitled "History"; likewise combine any sections Entitled + "Acknowledgements", and any sections Entitled "Dedications". You + must delete all sections Entitled "Endorsements." + + 6. COLLECTIONS OF DOCUMENTS + + You may make a collection consisting of the Document and other + documents released under this License, and replace the individual + copies of this License in the various documents with a single copy + that is included in the collection, provided that you follow the + rules of this License for verbatim copying of each of the documents + in all other respects. + + You may extract a single document from such a collection, and + distribute it individually under this License, provided you insert + a copy of this License into the extracted document, and follow this + License in all other respects regarding verbatim copying of that + document. + + 7. AGGREGATION WITH INDEPENDENT WORKS + + A compilation of the Document or its derivatives with other + separate and independent documents or works, in or on a volume of a + storage or distribution medium, is called an "aggregate" if the + copyright resulting from the compilation is not used to limit the + legal rights of the compilation's users beyond what the individual + works permit. When the Document is included in an aggregate, this + License does not apply to the other works in the aggregate which + are not themselves derivative works of the Document. + + If the Cover Text requirement of section 3 is applicable to these + copies of the Document, then if the Document is less than one half + of the entire aggregate, the Document's Cover Texts may be placed + on covers that bracket the Document within the aggregate, or the + electronic equivalent of covers if the Document is in electronic + form. Otherwise they must appear on printed covers that bracket + the whole aggregate. + + 8. TRANSLATION + + Translation is considered a kind of modification, so you may + distribute translations of the Document under the terms of section + 4. Replacing Invariant Sections with translations requires special + permission from their copyright holders, but you may include + translations of some or all Invariant Sections in addition to the + original versions of these Invariant Sections. You may include a + translation of this License, and all the license notices in the + Document, and any Warranty Disclaimers, provided that you also + include the original English version of this License and the + original versions of those notices and disclaimers. In case of a + disagreement between the translation and the original version of + this License or a notice or disclaimer, the original version will + prevail. + + If a section in the Document is Entitled "Acknowledgements", + "Dedications", or "History", the requirement (section 4) to + Preserve its Title (section 1) will typically require changing the + actual title. + + 9. TERMINATION + + You may not copy, modify, sublicense, or distribute the Document + except as expressly provided under this License. Any attempt + otherwise to copy, modify, sublicense, or distribute it is void, + and will automatically terminate your rights under this License. + + However, if you cease all violation of this License, then your + license from a particular copyright holder is reinstated (a) + provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and (b) permanently, if the + copyright holder fails to notify you of the violation by some + reasonable means prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is + reinstated permanently if the copyright holder notifies you of the + violation by some reasonable means, this is the first time you have + received notice of violation of this License (for any work) from + that copyright holder, and you cure the violation prior to 30 days + after your receipt of the notice. + + Termination of your rights under this section does not terminate + the licenses of parties who have received copies or rights from you + under this License. If your rights have been terminated and not + permanently reinstated, receipt of a copy of some or all of the + same material does not give you any rights to use it. + + 10. FUTURE REVISIONS OF THIS LICENSE + + The Free Software Foundation may publish new, revised versions of + the GNU Free Documentation License from time to time. Such new + versions will be similar in spirit to the present version, but may + differ in detail to address new problems or concerns. See + . + + Each version of the License is given a distinguishing version + number. If the Document specifies that a particular numbered + version of this License "or any later version" applies to it, you + have the option of following the terms and conditions either of + that specified version or of any later version that has been + published (not as a draft) by the Free Software Foundation. If the + Document does not specify a version number of this License, you may + choose any version ever published (not as a draft) by the Free + Software Foundation. If the Document specifies that a proxy can + decide which future versions of this License can be used, that + proxy's public statement of acceptance of a version permanently + authorizes you to choose that version for the Document. + + 11. RELICENSING + + "Massive Multiauthor Collaboration Site" (or "MMC Site") means any + World Wide Web server that publishes copyrightable works and also + provides prominent facilities for anybody to edit those works. A + public wiki that anybody can edit is an example of such a server. + A "Massive Multiauthor Collaboration" (or "MMC") contained in the + site means any set of copyrightable works thus published on the MMC + site. + + "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 + license published by Creative Commons Corporation, a not-for-profit + corporation with a principal place of business in San Francisco, + California, as well as future copyleft versions of that license + published by that same organization. + + "Incorporate" means to publish or republish a Document, in whole or + in part, as part of another Document. + + An MMC is "eligible for relicensing" if it is licensed under this + License, and if all works that were first published under this + License somewhere other than this MMC, and subsequently + incorporated in whole or in part into the MMC, (1) had no cover + texts or invariant sections, and (2) were thus incorporated prior + to November 1, 2008. + + The operator of an MMC Site may republish an MMC contained in the + site under CC-BY-SA on the same site at any time before August 1, + 2009, provided the MMC is eligible for relicensing. + +ADDENDUM: How to use this License for your documents +==================================================== + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and license +notices just after the title page: + + Copyright (C) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. + + If you have Invariant Sections, Front-Cover Texts and Back-Cover +Texts, replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with + the Front-Cover Texts being LIST, and with the Back-Cover Texts + being LIST. + + If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + + If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of free +software license, such as the GNU General Public License, to permit +their use in free software. + + +File: history.info, Node: Concept Index, Next: Function and Variable Index, Prev: GNU Free Documentation License, Up: Top + +Appendix B Concept Index +************************ + +[index] +* Menu: + +* anchored search: Searching the History List. + (line 10) +* event designators: Event Designators. (line 6) +* history events: Event Designators. (line 10) +* history expansion: History Interaction. (line 6) +* History Searching: Searching the History List. + (line 6) + + +File: history.info, Node: Function and Variable Index, Prev: Concept Index, Up: Top + +Appendix C Function and Variable Index +************************************** + +[index] +* Menu: + +* add_history: History List Management. + (line 9) +* add_history_time: History List Management. + (line 16) +* append_history: Managing the History File. + (line 35) +* clear_history: History List Management. + (line 39) +* current_history: Information About the History List. + (line 17) +* free_history_entry: History List Management. + (line 27) +* get_history_event: History Expansion. (line 26) +* history_arg_extract: History Expansion. (line 41) +* history_base: History Variables. (line 9) +* history_comment_char: History Variables. (line 37) +* history_expand: History Expansion. (line 8) +* history_expansion_char: History Variables. (line 29) +* history_get: Information About the History List. + (line 21) +* history_get_history_state: Initializing History and State Management. + (line 14) +* history_get_time: Information About the History List. + (line 28) +* history_inhibit_expansion_function: History Variables. (line 78) +* history_is_stifled: History List Management. + (line 52) +* history_length: History Variables. (line 12) +* history_list: Information About the History List. + (line 9) +* history_max_entries: History Variables. (line 15) +* history_no_expand_chars: History Variables. (line 52) +* history_quotes_inhibit_expansion: History Variables. (line 57) +* history_quoting_state: History Variables. (line 65) +* history_search: Searching the History List. + (line 11) +* history_search_delimiter_chars: History Variables. (line 47) +* history_search_pos: Searching the History List. + (line 30) +* history_search_prefix: Searching the History List. + (line 20) +* history_set_history_state: Initializing History and State Management. + (line 18) +* history_set_pos: Moving Around the History List. + (line 9) +* history_subst_char: History Variables. (line 33) +* history_tokenize: History Expansion. (line 35) +* history_total_bytes: Information About the History List. + (line 32) +* history_truncate_file: Managing the History File. + (line 42) +* history_word_delimiters: History Variables. (line 43) +* history_write_timestamps: History Variables. (line 19) +* next_history: Moving Around the History List. + (line 19) +* previous_history: Moving Around the History List. + (line 14) +* read_history: Managing the History File. + (line 9) +* read_history_range: Managing the History File. + (line 17) +* remove_history: History List Management. + (line 20) +* replace_history_entry: History List Management. + (line 32) +* stifle_history: History List Management. + (line 42) +* unstifle_history: History List Management. + (line 46) +* using_history: Initializing History and State Management. + (line 10) +* where_history: Information About the History List. + (line 14) +* write_history: Managing the History File. + (line 28) + + + +Tag Table: +Node: Top848 +Node: Using History Interactively1493 +Node: History Interaction2001 +Node: Event Designators4715 +Node: Word Designators6217 +Node: Modifiers8612 +Node: Programming with GNU History10259 +Node: Introduction to History11002 +Node: History Storage12734 +Node: History Functions13914 +Node: Initializing History and State Management14903 +Node: History List Management15706 +Node: Information About the History List18137 +Node: Moving Around the History List19750 +Node: Searching the History List20830 +Node: Managing the History File22776 +Node: History Expansion25246 +Node: History Variables27219 +Node: History Programming Example31334 +Node: GNU Free Documentation License33988 +Node: Concept Index59163 +Node: Function and Variable Index59868 + +End Tag Table + + +Local Variables: +coding: utf-8 +End: diff --git a/miniconda3/envs/ladir/share/info/libffi.info b/miniconda3/envs/ladir/share/info/libffi.info new file mode 100644 index 0000000000000000000000000000000000000000..6b9580ad68506e8d93928880cb01c372c3ad69ce --- /dev/null +++ b/miniconda3/envs/ladir/share/info/libffi.info @@ -0,0 +1,1060 @@ +This is libffi.info, produced by makeinfo version 6.8 from libffi.texi. + +This manual is for libffi, a portable foreign function interface +library. + + Copyright (C) 2008-2019, 2021, 2022 Anthony Green and Red Hat, Inc. + + Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + + The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +INFO-DIR-SECTION Development +START-INFO-DIR-ENTRY +* libffi: (libffi). Portable foreign function interface library. +END-INFO-DIR-ENTRY + + +File: libffi.info, Node: Top, Next: Introduction, Up: (dir) + +libffi +****** + +This manual is for libffi, a portable foreign function interface +library. + + Copyright (C) 2008-2019, 2021, 2022 Anthony Green and Red Hat, Inc. + + Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + + The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +* Menu: + +* Introduction:: What is libffi? +* Using libffi:: How to use libffi. +* Memory Usage:: Where memory for closures comes from. +* Missing Features:: Things libffi can't do. +* Index:: Index. + + +File: libffi.info, Node: Introduction, Next: Using libffi, Prev: Top, Up: Top + +1 What is libffi? +***************** + +Compilers for high level languages generate code that follow certain +conventions. These conventions are necessary, in part, for separate +compilation to work. One such convention is the "calling convention". +The calling convention is a set of assumptions made by the compiler +about where function arguments will be found on entry to a function. A +calling convention also specifies where the return value for a function +is found. The calling convention is also sometimes called the "ABI" or +"Application Binary Interface". + + Some programs may not know at the time of compilation what arguments +are to be passed to a function. For instance, an interpreter may be +told at run-time about the number and types of arguments used to call a +given function. 'libffi' can be used in such programs to provide a +bridge from the interpreter program to compiled code. + + The 'libffi' library provides a portable, high level programming +interface to various calling conventions. This allows a programmer to +call any function specified by a call interface description at run time. + + FFI stands for Foreign Function Interface. A foreign function +interface is the popular name for the interface that allows code written +in one language to call code written in another language. The 'libffi' +library really only provides the lowest, machine dependent layer of a +fully featured foreign function interface. A layer must exist above +'libffi' that handles type conversions for values passed between the two +languages. + + +File: libffi.info, Node: Using libffi, Next: Memory Usage, Prev: Introduction, Up: Top + +2 Using libffi +************** + +* Menu: + +* The Basics:: The basic libffi API. +* Simple Example:: A simple example. +* Types:: libffi type descriptions. +* Multiple ABIs:: Different passing styles on one platform. +* The Closure API:: Writing a generic function. +* Closure Example:: A closure example. +* Thread Safety:: Thread safety. + + +File: libffi.info, Node: The Basics, Next: Simple Example, Up: Using libffi + +2.1 The Basics +============== + +'libffi' assumes that you have a pointer to the function you wish to +call and that you know the number and types of arguments to pass it, as +well as the return type of the function. + + The first thing you must do is create an 'ffi_cif' object that +matches the signature of the function you wish to call. This is a +separate step because it is common to make multiple calls using a single +'ffi_cif'. The "cif" in 'ffi_cif' stands for Call InterFace. To +prepare a call interface object, use the function 'ffi_prep_cif'. + + -- Function: ffi_status ffi_prep_cif (ffi_cif *CIF, ffi_abi ABI, + unsigned int NARGS, ffi_type *RTYPE, ffi_type **ARGTYPES) + This initializes CIF according to the given parameters. + + ABI is the ABI to use; normally 'FFI_DEFAULT_ABI' is what you want. + *note Multiple ABIs:: for more information. + + NARGS is the number of arguments that this function accepts. + + RTYPE is a pointer to an 'ffi_type' structure that describes the + return type of the function. *Note Types::. + + ARGTYPES is a vector of 'ffi_type' pointers. ARGTYPES must have + NARGS elements. If NARGS is 0, this argument is ignored. + + 'ffi_prep_cif' returns a 'libffi' status code, of type + 'ffi_status'. This will be either 'FFI_OK' if everything worked + properly; 'FFI_BAD_TYPEDEF' if one of the 'ffi_type' objects is + incorrect; or 'FFI_BAD_ABI' if the ABI parameter is invalid. + + If the function being called is variadic (varargs) then +'ffi_prep_cif_var' must be used instead of 'ffi_prep_cif'. + + -- Function: ffi_status ffi_prep_cif_var (ffi_cif *CIF, ffi_abi ABI, + unsigned int NFIXEDARGS, unsigned int NTOTALARGS, ffi_type + *RTYPE, ffi_type **ARGTYPES) + This initializes CIF according to the given parameters for a call + to a variadic function. In general its operation is the same as + for 'ffi_prep_cif' except that: + + NFIXEDARGS is the number of fixed arguments, prior to any variadic + arguments. It must be greater than zero. + + NTOTALARGS the total number of arguments, including variadic and + fixed arguments. ARGTYPES must have this many elements. + + 'ffi_prep_cif_var' will return 'FFI_BAD_ARGTYPE' if any of the + variable argument types are 'ffi_type_float' (promote to + 'ffi_type_double' first), or any integer type small than an int + (promote to an int-sized type first). + + Note that, different cif's must be prepped for calls to the same + function when different numbers of arguments are passed. + + Also note that a call to 'ffi_prep_cif_var' with + NFIXEDARGS=NOTOTALARGS is NOT equivalent to a call to + 'ffi_prep_cif'. + + Note that the resulting 'ffi_cif' holds pointers to all the +'ffi_type' objects that were used during initialization. You must +ensure that these type objects have a lifetime at least as long as that +of the 'ffi_cif'. + + To call a function using an initialized 'ffi_cif', use the 'ffi_call' +function: + + -- Function: void ffi_call (ffi_cif *CIF, void *FN, void *RVALUE, void + **AVALUES) + This calls the function FN according to the description given in + CIF. CIF must have already been prepared using 'ffi_prep_cif'. + + RVALUE is a pointer to a chunk of memory that will hold the result + of the function call. This must be large enough to hold the + result, no smaller than the system register size (generally 32 or + 64 bits), and must be suitably aligned; it is the caller's + responsibility to ensure this. If CIF declares that the function + returns 'void' (using 'ffi_type_void'), then RVALUE is ignored. + + In most situations, 'libffi' will handle promotion according to the + ABI. However, for historical reasons, there is a special case with + return values that must be handled by your code. In particular, + for integral (not 'struct') types that are narrower than the system + register size, the return value will be widened by 'libffi'. + 'libffi' provides a type, 'ffi_arg', that can be used as the return + type. For example, if the CIF was defined with a return type of + 'char', 'libffi' will try to store a full 'ffi_arg' into the return + value. + + AVALUES is a vector of 'void *' pointers that point to the memory + locations holding the argument values for a call. If CIF declares + that the function has no arguments (i.e., NARGS was 0), then + AVALUES is ignored. + + Note that while the return value must be register-sized, arguments + should exactly match their declared type. For example, if an + argument is a 'short', then the entry in AVALUES should point to an + object declared as 'short'; but if the return type is 'short', then + RVALUE should point to an object declared as a larger type - + usually 'ffi_arg'. + + +File: libffi.info, Node: Simple Example, Next: Types, Prev: The Basics, Up: Using libffi + +2.2 Simple Example +================== + +Here is a trivial example that calls 'puts' a few times. + + #include + #include + + int main() + { + ffi_cif cif; + ffi_type *args[1]; + void *values[1]; + char *s; + ffi_arg rc; + + /* Initialize the argument info vectors */ + args[0] = &ffi_type_pointer; + values[0] = &s; + + /* Initialize the cif */ + if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 1, + &ffi_type_sint, args) == FFI_OK) + { + s = "Hello World!"; + ffi_call(&cif, puts, &rc, values); + /* rc now holds the result of the call to puts */ + + /* values holds a pointer to the function's arg, so to + call puts() again all we need to do is change the + value of s */ + s = "This is cool!"; + ffi_call(&cif, puts, &rc, values); + } + + return 0; + } + + +File: libffi.info, Node: Types, Next: Multiple ABIs, Prev: Simple Example, Up: Using libffi + +2.3 Types +========= + +* Menu: + +* Primitive Types:: Built-in types. +* Structures:: Structure types. +* Size and Alignment:: Size and alignment of types. +* Arrays Unions Enums:: Arrays, unions, and enumerations. +* Type Example:: Structure type example. +* Complex:: Complex types. +* Complex Type Example:: Complex type example. + + +File: libffi.info, Node: Primitive Types, Next: Structures, Up: Types + +2.3.1 Primitive Types +--------------------- + +'Libffi' provides a number of built-in type descriptors that can be used +to describe argument and return types: + +'ffi_type_void' + The type 'void'. This cannot be used for argument types, only for + return values. + +'ffi_type_uint8' + An unsigned, 8-bit integer type. + +'ffi_type_sint8' + A signed, 8-bit integer type. + +'ffi_type_uint16' + An unsigned, 16-bit integer type. + +'ffi_type_sint16' + A signed, 16-bit integer type. + +'ffi_type_uint32' + An unsigned, 32-bit integer type. + +'ffi_type_sint32' + A signed, 32-bit integer type. + +'ffi_type_uint64' + An unsigned, 64-bit integer type. + +'ffi_type_sint64' + A signed, 64-bit integer type. + +'ffi_type_float' + The C 'float' type. + +'ffi_type_double' + The C 'double' type. + +'ffi_type_uchar' + The C 'unsigned char' type. + +'ffi_type_schar' + The C 'signed char' type. (Note that there is not an exact + equivalent to the C 'char' type in 'libffi'; ordinarily you should + either use 'ffi_type_schar' or 'ffi_type_uchar' depending on + whether 'char' is signed.) + +'ffi_type_ushort' + The C 'unsigned short' type. + +'ffi_type_sshort' + The C 'short' type. + +'ffi_type_uint' + The C 'unsigned int' type. + +'ffi_type_sint' + The C 'int' type. + +'ffi_type_ulong' + The C 'unsigned long' type. + +'ffi_type_slong' + The C 'long' type. + +'ffi_type_longdouble' + On platforms that have a C 'long double' type, this is defined. On + other platforms, it is not. + +'ffi_type_pointer' + A generic 'void *' pointer. You should use this for all pointers, + regardless of their real type. + +'ffi_type_complex_float' + The C '_Complex float' type. + +'ffi_type_complex_double' + The C '_Complex double' type. + +'ffi_type_complex_longdouble' + The C '_Complex long double' type. On platforms that have a C + 'long double' type, this is defined. On other platforms, it is + not. + + Each of these is of type 'ffi_type', so you must take the address +when passing to 'ffi_prep_cif'. + + +File: libffi.info, Node: Structures, Next: Size and Alignment, Prev: Primitive Types, Up: Types + +2.3.2 Structures +---------------- + +'libffi' is perfectly happy passing structures back and forth. You must +first describe the structure to 'libffi' by creating a new 'ffi_type' +object for it. + + -- Data type: ffi_type + The 'ffi_type' has the following members: + 'size_t size' + This is set by 'libffi'; you should initialize it to zero. + + 'unsigned short alignment' + This is set by 'libffi'; you should initialize it to zero. + + 'unsigned short type' + For a structure, this should be set to 'FFI_TYPE_STRUCT'. + + 'ffi_type **elements' + This is a 'NULL'-terminated array of pointers to 'ffi_type' + objects. There is one element per field of the struct. + + Note that 'libffi' has no special support for bit-fields. You + must manage these manually. + + The 'size' and 'alignment' fields will be filled in by 'ffi_prep_cif' +or 'ffi_prep_cif_var', as needed. + + +File: libffi.info, Node: Size and Alignment, Next: Arrays Unions Enums, Prev: Structures, Up: Types + +2.3.3 Size and Alignment +------------------------ + +'libffi' will set the 'size' and 'alignment' fields of an 'ffi_type' +object for you. It does so using its knowledge of the ABI. + + You might expect that you can simply read these fields for a type +that has been laid out by 'libffi'. However, there are some caveats. + + * The size or alignment of some of the built-in types may vary + depending on the chosen ABI. + + * The size and alignment of a new structure type will not be set by + 'libffi' until it has been passed to 'ffi_prep_cif' or + 'ffi_get_struct_offsets'. + + * A structure type cannot be shared across ABIs. Instead each ABI + needs its own copy of the structure type. + + So, before examining these fields, it is safest to pass the +'ffi_type' object to 'ffi_prep_cif' or 'ffi_get_struct_offsets' first. +This function will do all the needed setup. + + ffi_type *desired_type; + ffi_abi desired_abi; + ... + ffi_cif cif; + if (ffi_prep_cif (&cif, desired_abi, 0, desired_type, NULL) == FFI_OK) + { + size_t size = desired_type->size; + unsigned short alignment = desired_type->alignment; + } + + 'libffi' also provides a way to get the offsets of the members of a +structure. + + -- Function: ffi_status ffi_get_struct_offsets (ffi_abi abi, ffi_type + *struct_type, size_t *offsets) + Compute the offset of each element of the given structure type. + ABI is the ABI to use; this is needed because in some cases the + layout depends on the ABI. + + OFFSETS is an out parameter. The caller is responsible for + providing enough space for all the results to be written - one + element per element type in STRUCT_TYPE. If OFFSETS is 'NULL', + then the type will be laid out but not otherwise modified. This + can be useful for accessing the type's size or layout, as mentioned + above. + + This function returns 'FFI_OK' on success; 'FFI_BAD_ABI' if ABI is + invalid; or 'FFI_BAD_TYPEDEF' if STRUCT_TYPE is invalid in some + way. Note that only 'FFI_STRUCT' types are valid here. + + +File: libffi.info, Node: Arrays Unions Enums, Next: Type Example, Prev: Size and Alignment, Up: Types + +2.3.4 Arrays, Unions, and Enumerations +-------------------------------------- + +2.3.4.1 Arrays +.............. + +'libffi' does not have direct support for arrays or unions. However, +they can be emulated using structures. + + To emulate an array, simply create an 'ffi_type' using +'FFI_TYPE_STRUCT' with as many members as there are elements in the +array. + + ffi_type array_type; + ffi_type **elements + int i; + + elements = malloc ((n + 1) * sizeof (ffi_type *)); + for (i = 0; i < n; ++i) + elements[i] = array_element_type; + elements[n] = NULL; + + array_type.size = array_type.alignment = 0; + array_type.type = FFI_TYPE_STRUCT; + array_type.elements = elements; + + Note that arrays cannot be passed or returned by value in C - +structure types created like this should only be used to refer to +members of real 'FFI_TYPE_STRUCT' objects. + + However, a phony array type like this will not cause any errors from +'libffi' if you use it as an argument or return type. This may be +confusing. + +2.3.4.2 Unions +.............. + +A union can also be emulated using 'FFI_TYPE_STRUCT'. In this case, +however, you must make sure that the size and alignment match the real +requirements of the union. + + One simple way to do this is to ensue that each element type is laid +out. Then, give the new structure type a single element; the size of +the largest element; and the largest alignment seen as well. + + This example uses the 'ffi_prep_cif' trick to ensure that each +element type is laid out. + + ffi_abi desired_abi; + ffi_type union_type; + ffi_type **union_elements; + + int i; + ffi_type element_types[2]; + + element_types[1] = NULL; + + union_type.size = union_type.alignment = 0; + union_type.type = FFI_TYPE_STRUCT; + union_type.elements = element_types; + + for (i = 0; union_elements[i]; ++i) + { + ffi_cif cif; + if (ffi_prep_cif (&cif, desired_abi, 0, union_elements[i], NULL) == FFI_OK) + { + if (union_elements[i]->size > union_type.size) + { + union_type.size = union_elements[i]; + size = union_elements[i]->size; + } + if (union_elements[i]->alignment > union_type.alignment) + union_type.alignment = union_elements[i]->alignment; + } + } + +2.3.4.3 Enumerations +.................... + +'libffi' does not have any special support for C 'enum's. Although any +given 'enum' is implemented using a specific underlying integral type, +exactly which type will be used cannot be determined by 'libffi' - it +may depend on the values in the enumeration or on compiler flags such as +'-fshort-enums'. *Note (gcc)Structures unions enumerations and +bit-fields implementation::, for more information about how GCC handles +enumerations. + + +File: libffi.info, Node: Type Example, Next: Complex, Prev: Arrays Unions Enums, Up: Types + +2.3.5 Type Example +------------------ + +The following example initializes a 'ffi_type' object representing the +'tm' struct from Linux's 'time.h'. + + Here is how the struct is defined: + + struct tm { + int tm_sec; + int tm_min; + int tm_hour; + int tm_mday; + int tm_mon; + int tm_year; + int tm_wday; + int tm_yday; + int tm_isdst; + /* Those are for future use. */ + long int __tm_gmtoff__; + __const char *__tm_zone__; + }; + + Here is the corresponding code to describe this struct to 'libffi': + + { + ffi_type tm_type; + ffi_type *tm_type_elements[12]; + int i; + + tm_type.size = tm_type.alignment = 0; + tm_type.type = FFI_TYPE_STRUCT; + tm_type.elements = &tm_type_elements; + + for (i = 0; i < 9; i++) + tm_type_elements[i] = &ffi_type_sint; + + tm_type_elements[9] = &ffi_type_slong; + tm_type_elements[10] = &ffi_type_pointer; + tm_type_elements[11] = NULL; + + /* tm_type can now be used to represent tm argument types and + return types for ffi_prep_cif() */ + } + + +File: libffi.info, Node: Complex, Next: Complex Type Example, Prev: Type Example, Up: Types + +2.3.6 Complex Types +------------------- + +'libffi' supports the complex types defined by the C99 standard +('_Complex float', '_Complex double' and '_Complex long double' with the +built-in type descriptors 'ffi_type_complex_float', +'ffi_type_complex_double' and 'ffi_type_complex_longdouble'. + + Custom complex types like '_Complex int' can also be used. An +'ffi_type' object has to be defined to describe the complex type to +'libffi'. + + -- Data type: ffi_type + 'size_t size' + This must be manually set to the size of the complex type. + + 'unsigned short alignment' + This must be manually set to the alignment of the complex + type. + + 'unsigned short type' + For a complex type, this must be set to 'FFI_TYPE_COMPLEX'. + + 'ffi_type **elements' + + This is a 'NULL'-terminated array of pointers to 'ffi_type' + objects. The first element is set to the 'ffi_type' of the + complex's base type. The second element must be set to + 'NULL'. + + The section *note Complex Type Example:: shows a way to determine the +'size' and 'alignment' members in a platform independent way. + + For platforms that have no complex support in 'libffi' yet, the +functions 'ffi_prep_cif' and 'ffi_prep_args' abort the program if they +encounter a complex type. + + +File: libffi.info, Node: Complex Type Example, Prev: Complex, Up: Types + +2.3.7 Complex Type Example +-------------------------- + +This example demonstrates how to use complex types: + + #include + #include + #include + + void complex_fn(_Complex float cf, + _Complex double cd, + _Complex long double cld) + { + printf("cf=%f+%fi\ncd=%f+%fi\ncld=%f+%fi\n", + (float)creal (cf), (float)cimag (cf), + (float)creal (cd), (float)cimag (cd), + (float)creal (cld), (float)cimag (cld)); + } + + int main() + { + ffi_cif cif; + ffi_type *args[3]; + void *values[3]; + _Complex float cf; + _Complex double cd; + _Complex long double cld; + + /* Initialize the argument info vectors */ + args[0] = &ffi_type_complex_float; + args[1] = &ffi_type_complex_double; + args[2] = &ffi_type_complex_longdouble; + values[0] = &cf; + values[1] = &cd; + values[2] = &cld; + + /* Initialize the cif */ + if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 3, + &ffi_type_void, args) == FFI_OK) + { + cf = 1.0 + 20.0 * I; + cd = 300.0 + 4000.0 * I; + cld = 50000.0 + 600000.0 * I; + /* Call the function */ + ffi_call(&cif, (void (*)(void))complex_fn, 0, values); + } + + return 0; + } + + This is an example for defining a custom complex type descriptor for +compilers that support them: + + /* + * This macro can be used to define new complex type descriptors + * in a platform independent way. + * + * name: Name of the new descriptor is ffi_type_complex_. + * type: The C base type of the complex type. + */ + #define FFI_COMPLEX_TYPEDEF(name, type, ffitype) \ + static ffi_type *ffi_elements_complex_##name [2] = { \ + (ffi_type *)(&ffitype), NULL \ + }; \ + struct struct_align_complex_##name { \ + char c; \ + _Complex type x; \ + }; \ + ffi_type ffi_type_complex_##name = { \ + sizeof(_Complex type), \ + offsetof(struct struct_align_complex_##name, x), \ + FFI_TYPE_COMPLEX, \ + (ffi_type **)ffi_elements_complex_##name \ + } + + /* Define new complex type descriptors using the macro: */ + /* ffi_type_complex_sint */ + FFI_COMPLEX_TYPEDEF(sint, int, ffi_type_sint); + /* ffi_type_complex_uchar */ + FFI_COMPLEX_TYPEDEF(uchar, unsigned char, ffi_type_uint8); + + The new type descriptors can then be used like one of the built-in +type descriptors in the previous example. + + +File: libffi.info, Node: Multiple ABIs, Next: The Closure API, Prev: Types, Up: Using libffi + +2.4 Multiple ABIs +================= + +A given platform may provide multiple different ABIs at once. For +instance, the x86 platform has both 'stdcall' and 'fastcall' functions. + + 'libffi' provides some support for this. However, this is +necessarily platform-specific. + + +File: libffi.info, Node: The Closure API, Next: Closure Example, Prev: Multiple ABIs, Up: Using libffi + +2.5 The Closure API +=================== + +'libffi' also provides a way to write a generic function - a function +that can accept and decode any combination of arguments. This can be +useful when writing an interpreter, or to provide wrappers for arbitrary +functions. + + This facility is called the "closure API". Closures are not supported +on all platforms; you can check the 'FFI_CLOSURES' define to determine +whether they are supported on the current platform. + + Because closures work by assembling a tiny function at runtime, they +require special allocation on platforms that have a non-executable heap. +Memory management for closures is handled by a pair of functions: + + -- Function: void *ffi_closure_alloc (size_t SIZE, void **CODE) + Allocate a chunk of memory holding SIZE bytes. This returns a + pointer to the writable address, and sets *CODE to the + corresponding executable address. + + SIZE should be sufficient to hold a 'ffi_closure' object. + + -- Function: void ffi_closure_free (void *WRITABLE) + Free memory allocated using 'ffi_closure_alloc'. The argument is + the writable address that was returned. + + Once you have allocated the memory for a closure, you must construct +a 'ffi_cif' describing the function call. Finally you can prepare the +closure function: + + -- Function: ffi_status ffi_prep_closure_loc (ffi_closure *CLOSURE, + ffi_cif *CIF, void (*FUN) (ffi_cif *CIF, void *RET, void + **ARGS, void *USER_DATA), void *USER_DATA, void *CODELOC) + Prepare a closure function. The arguments to + 'ffi_prep_closure_loc' are: + + CLOSURE + The address of a 'ffi_closure' object; this is the writable + address returned by 'ffi_closure_alloc'. + + CIF + The 'ffi_cif' describing the function parameters. Note that + this object, and the types to which it refers, must be kept + alive until the closure itself is freed. + + USER_DATA + An arbitrary datum that is passed, uninterpreted, to your + closure function. + + CODELOC + The executable address returned by 'ffi_closure_alloc'. + + FUN + The function which will be called when the closure is invoked. + It is called with the arguments: + + CIF + The 'ffi_cif' passed to 'ffi_prep_closure_loc'. + + RET + A pointer to the memory used for the function's return + value. + + If the function is declared as returning 'void', then + this value is garbage and should not be used. + + Otherwise, FUN must fill the object to which this points, + following the same special promotion behavior as + 'ffi_call'. That is, in most cases, RET points to an + object of exactly the size of the type specified when CIF + was constructed. However, integral types narrower than + the system register size are widened. In these cases + your program may assume that RET points to an 'ffi_arg' + object. + + ARGS + A vector of pointers to memory holding the arguments to + the function. + + USER_DATA + The same USER_DATA that was passed to + 'ffi_prep_closure_loc'. + + 'ffi_prep_closure_loc' will return 'FFI_OK' if everything went ok, + and one of the other 'ffi_status' values on error. + + After calling 'ffi_prep_closure_loc', you can cast CODELOC to the + appropriate pointer-to-function type. + + You may see old code referring to 'ffi_prep_closure'. This function +is deprecated, as it cannot handle the need for separate writable and +executable addresses. + + +File: libffi.info, Node: Closure Example, Next: Thread Safety, Prev: The Closure API, Up: Using libffi + +2.6 Closure Example +=================== + +A trivial example that creates a new 'puts' by binding 'fputs' with +'stdout'. + + #include + #include + + /* Acts like puts with the file given at time of enclosure. */ + void puts_binding(ffi_cif *cif, void *ret, void* args[], + void *stream) + { + *(ffi_arg *)ret = fputs(*(char **)args[0], (FILE *)stream); + } + + typedef int (*puts_t)(char *); + + int main() + { + ffi_cif cif; + ffi_type *args[1]; + ffi_closure *closure; + + void *bound_puts; + int rc; + + /* Allocate closure and bound_puts */ + closure = ffi_closure_alloc(sizeof(ffi_closure), &bound_puts); + + if (closure) + { + /* Initialize the argument info vectors */ + args[0] = &ffi_type_pointer; + + /* Initialize the cif */ + if (ffi_prep_cif(&cif, FFI_DEFAULT_ABI, 1, + &ffi_type_sint, args) == FFI_OK) + { + /* Initialize the closure, setting stream to stdout */ + if (ffi_prep_closure_loc(closure, &cif, puts_binding, + stdout, bound_puts) == FFI_OK) + { + rc = ((puts_t)bound_puts)("Hello World!"); + /* rc now holds the result of the call to fputs */ + } + } + } + + /* Deallocate both closure, and bound_puts */ + ffi_closure_free(closure); + + return 0; + } + + + +File: libffi.info, Node: Thread Safety, Prev: Closure Example, Up: Using libffi + +2.7 Thread Safety +================= + +'libffi' is not completely thread-safe. However, many parts are, and if +you follow some simple rules, you can use it safely in a multi-threaded +program. + + * 'ffi_prep_cif' may modify the 'ffi_type' objects passed to it. It + is best to ensure that only a single thread prepares a given + 'ffi_cif' at a time. + + * On some platforms, 'ffi_prep_cif' may modify the size and alignment + of some types, depending on the chosen ABI. On these platforms, if + you switch between ABIs, you must ensure that there is only one + call to 'ffi_prep_cif' at a time. + + Currently the only affected platform is PowerPC and the only + affected type is 'long double'. + + +File: libffi.info, Node: Memory Usage, Next: Missing Features, Prev: Using libffi, Up: Top + +3 Memory Usage +************** + +Note that memory allocated by 'ffi_closure_alloc' and freed by +'ffi_closure_free' does not come from the same general pool of memory +that 'malloc' and 'free' use. To accomodate security settings, 'libffi' +may aquire memory, for example, by mapping temporary files into multiple +places in the address space (once to write out the closure, a second to +execute it). The search follows this list, using the first that works: + + * A anonymous mapping (i.e. not file-backed) + + * 'memfd_create()', if the kernel supports it. + + * A file created in the directory referenced by the environment + variable 'LIBFFI_TMPDIR'. + + * Likewise for the environment variable 'TMPDIR'. + + * A file created in '/tmp'. + + * A file created in '/var/tmp'. + + * A file created in '/dev/shm'. + + * A file created in the user's home directory ('$HOME'). + + * A file created in any directory listed in '/etc/mtab'. + + * A file created in any directory listed in '/proc/mounts'. + + If security settings prohibit using any of these for closures, +'ffi_closure_alloc' will fail. + + +File: libffi.info, Node: Missing Features, Next: Index, Prev: Memory Usage, Up: Top + +4 Missing Features +****************** + +'libffi' is missing a few features. We welcome patches to add support +for these. + + * Variadic closures. + + * There is no support for bit fields in structures. + + * The "raw" API is undocumented. + + * The Go API is undocumented. + + +File: libffi.info, Node: Index, Prev: Missing Features, Up: Top + +Index +***** + +[index] +* Menu: + +* ABI: Introduction. (line 13) +* Application Binary Interface: Introduction. (line 13) +* calling convention: Introduction. (line 13) +* cif: The Basics. (line 14) +* closure API: The Closure API. (line 13) +* closures: The Closure API. (line 13) +* FFI: Introduction. (line 31) +* ffi_call: The Basics. (line 72) +* FFI_CLOSURES: The Closure API. (line 13) +* ffi_closure_alloc: The Closure API. (line 19) +* ffi_closure_free: The Closure API. (line 26) +* ffi_get_struct_offsets: Size and Alignment. (line 39) +* ffi_prep_cif: The Basics. (line 16) +* ffi_prep_cif_var: The Basics. (line 39) +* ffi_prep_closure_loc: The Closure API. (line 34) +* ffi_status: The Basics. (line 16) +* ffi_status <1>: The Basics. (line 39) +* ffi_status <2>: Size and Alignment. (line 39) +* ffi_status <3>: The Closure API. (line 34) +* ffi_type: Structures. (line 10) +* ffi_type <1>: Structures. (line 10) +* ffi_type <2>: Complex. (line 15) +* ffi_type <3>: Complex. (line 15) +* ffi_type_complex_double: Primitive Types. (line 82) +* ffi_type_complex_float: Primitive Types. (line 79) +* ffi_type_complex_longdouble: Primitive Types. (line 85) +* ffi_type_double: Primitive Types. (line 41) +* ffi_type_float: Primitive Types. (line 38) +* ffi_type_longdouble: Primitive Types. (line 71) +* ffi_type_pointer: Primitive Types. (line 75) +* ffi_type_schar: Primitive Types. (line 47) +* ffi_type_sint: Primitive Types. (line 62) +* ffi_type_sint16: Primitive Types. (line 23) +* ffi_type_sint32: Primitive Types. (line 29) +* ffi_type_sint64: Primitive Types. (line 35) +* ffi_type_sint8: Primitive Types. (line 17) +* ffi_type_slong: Primitive Types. (line 68) +* ffi_type_sshort: Primitive Types. (line 56) +* ffi_type_uchar: Primitive Types. (line 44) +* ffi_type_uint: Primitive Types. (line 59) +* ffi_type_uint16: Primitive Types. (line 20) +* ffi_type_uint32: Primitive Types. (line 26) +* ffi_type_uint64: Primitive Types. (line 32) +* ffi_type_uint8: Primitive Types. (line 14) +* ffi_type_ulong: Primitive Types. (line 65) +* ffi_type_ushort: Primitive Types. (line 53) +* ffi_type_void: Primitive Types. (line 10) +* Foreign Function Interface: Introduction. (line 31) +* void: The Basics. (line 72) +* void <1>: The Closure API. (line 19) +* void <2>: The Closure API. (line 26) + + + +Tag Table: +Node: Top1400 +Node: Introduction2935 +Node: Using libffi4567 +Node: The Basics5096 +Node: Simple Example10024 +Node: Types11055 +Node: Primitive Types11566 +Node: Structures13687 +Node: Size and Alignment14726 +Node: Arrays Unions Enums16923 +Node: Type Example19852 +Node: Complex21143 +Node: Complex Type Example22561 +Node: Multiple ABIs25613 +Node: The Closure API25984 +Node: Closure Example29810 +Node: Thread Safety31442 +Node: Memory Usage32243 +Node: Missing Features33438 +Node: Index33803 + +End Tag Table + + +Local Variables: +coding: utf-8 +End: diff --git a/miniconda3/envs/ladir/share/info/libgomp.info b/miniconda3/envs/ladir/share/info/libgomp.info new file mode 100644 index 0000000000000000000000000000000000000000..52357ea6f6a97cedb7a214be13468bc67483af61 --- /dev/null +++ b/miniconda3/envs/ladir/share/info/libgomp.info @@ -0,0 +1,8676 @@ +This is libgomp.info, produced by makeinfo version 6.5 from +libgomp.texi. + +Copyright (C) 2006-2025 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with the +Invariant Sections being "Funding Free Software", the Front-Cover texts +being (a) (see below), and with the Back-Cover Texts being (b) (see +below). A copy of the license is included in the section entitled "GNU +Free Documentation License". + + (a) The FSF's Front-Cover Text is: + + A GNU Manual + + (b) The FSF's Back-Cover Text is: + + You have freedom to copy and modify this GNU Manual, like GNU +software. Copies published by the Free Software Foundation raise funds +for GNU development. +INFO-DIR-SECTION GNU Libraries +START-INFO-DIR-ENTRY +* libgomp: (libgomp). GNU Offloading and Multi Processing Runtime Library. +END-INFO-DIR-ENTRY + + This manual documents libgomp, the GNU Offloading and Multi +Processing Runtime library. This is the GNU implementation of the +OpenMP and OpenACC APIs for parallel and accelerator programming in +C/C++ and Fortran. + + Published by the Free Software Foundation 51 Franklin Street, Fifth +Floor Boston, MA 02110-1301 USA + + Copyright (C) 2006-2025 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with the +Invariant Sections being "Funding Free Software", the Front-Cover texts +being (a) (see below), and with the Back-Cover Texts being (b) (see +below). A copy of the license is included in the section entitled "GNU +Free Documentation License". + + (a) The FSF's Front-Cover Text is: + + A GNU Manual + + (b) The FSF's Back-Cover Text is: + + You have freedom to copy and modify this GNU Manual, like GNU +software. Copies published by the Free Software Foundation raise funds +for GNU development. + + +File: libgomp.info, Node: Top, Next: Enabling OpenMP + +Introduction +************ + +This manual documents the usage of libgomp, the GNU Offloading and Multi +Processing Runtime Library. This includes the GNU implementation of the +OpenMP (https://www.openmp.org) Application Programming Interface (API) +for multi-platform shared-memory parallel programming in C/C++ and +Fortran, and the GNU implementation of the OpenACC +(https://www.openacc.org) Application Programming Interface (API) for +offloading of code to accelerator devices in C/C++ and Fortran. + + Originally, libgomp implemented the GNU OpenMP Runtime Library. +Based on this, support for OpenACC and offloading (both OpenACC and +OpenMP 4's target construct) has been added later on, and the library's +name changed to GNU Offloading and Multi Processing Runtime Library. + +* Menu: + +* Enabling OpenMP:: How to enable OpenMP for your applications. +* OpenMP Implementation Status:: List of implemented features by OpenMP version +* OpenMP Runtime Library Routines: Runtime Library Routines. + The OpenMP runtime application programming + interface. +* OpenMP Environment Variables: Environment Variables. + Influencing OpenMP runtime behavior with + environment variables. +* Enabling OpenACC:: How to enable OpenACC for your + applications. +* OpenACC Runtime Library Routines:: The OpenACC runtime application + programming interface. +* OpenACC Environment Variables:: Influencing OpenACC runtime behavior with + environment variables. +* CUDA Streams Usage:: Notes on the implementation of + asynchronous operations. +* OpenACC Library Interoperability:: OpenACC library interoperability with the + NVIDIA CUBLAS library. +* OpenACC Profiling Interface:: +* OpenMP-Implementation Specifics:: Notes specifics of this OpenMP + implementation +* Offload-Target Specifics:: Notes on offload-target specific internals +* The libgomp ABI:: Notes on the external ABI presented by libgomp. +* Reporting Bugs:: How to report bugs in the GNU Offloading and + Multi Processing Runtime Library. +* Copying:: GNU general public license says + how you can copy and share libgomp. +* GNU Free Documentation License:: + How you can copy and share this manual. +* Funding:: How to help assure continued work for free + software. +* Library Index:: Index of this documentation. + + +File: libgomp.info, Node: Enabling OpenMP, Next: OpenMP Implementation Status, Up: Top + +1 Enabling OpenMP +***************** + +To activate the OpenMP extensions for C/C++ and Fortran, the +compile-time flag '-fopenmp' must be specified. For C and C++, this +enables the handling of the OpenMP directives using '#pragma omp' and +the '[[omp::directive(...)]]', '[[omp::sequence(...)]]' and +'[[omp::decl(...)]]' attributes. For Fortran, it enables for free +source form the '!$omp' sentinel for directives and the '!$' conditional +compilation sentinel and for fixed source form the 'c$omp', '*$omp' and +'!$omp' sentinels for directives and the 'c$', '*$' and '!$' conditional +compilation sentinels. The flag also arranges for automatic linking of +the OpenMP runtime library (*note Runtime Library Routines::). + + The '-fopenmp-simd' flag can be used to enable a subset of OpenMP +directives that do not require the linking of either the OpenMP runtime +library or the POSIX threads library. + + A complete description of all OpenMP directives may be found in the +OpenMP Application Program Interface (https://www.openmp.org) manuals. +See also *note OpenMP Implementation Status::. + + +File: libgomp.info, Node: OpenMP Implementation Status, Next: Runtime Library Routines, Prev: Enabling OpenMP, Up: Top + +2 OpenMP Implementation Status +****************************** + +* Menu: + +* OpenMP 4.5:: Feature completion status to 4.5 specification +* OpenMP 5.0:: Feature completion status to 5.0 specification +* OpenMP 5.1:: Feature completion status to 5.1 specification +* OpenMP 5.2:: Feature completion status to 5.2 specification +* OpenMP 6.0:: Feature completion status to 6.0 specification + +The '_OPENMP' preprocessor macro and Fortran's 'openmp_version' +parameter, provided by 'omp_lib.h' and the 'omp_lib' module, have the +value '201511' (i.e. OpenMP 4.5). + + +File: libgomp.info, Node: OpenMP 4.5, Next: OpenMP 5.0, Up: OpenMP Implementation Status + +2.1 OpenMP 4.5 +============== + +The OpenMP 4.5 specification is fully supported. + + +File: libgomp.info, Node: OpenMP 5.0, Next: OpenMP 5.1, Prev: OpenMP 4.5, Up: OpenMP Implementation Status + +2.2 OpenMP 5.0 +============== + +New features listed in Appendix B of the OpenMP specification +------------------------------------------------------------- + +Description Status Comments +----------------------------------------------------------------------- +Array shaping N +Array sections with non-unit strides in C N +and C++ +Iterators Y +'metadirective' directive Y +'declare variant' directive Y +TARGET-OFFLOAD-VAR ICV and Y +'OMP_TARGET_OFFLOAD' env variable +Nested-parallel changes to Y +MAX-ACTIVE-LEVELS-VAR ICV +'requires' directive Y See also + *note Offload-Target Specifics:: +'teams' construct outside an enclosing Y +target region +Non-rectangular loop nests P Full support for + C/C++, partial + for Fortran + (PR110735 + (https://gcc.gnu.org/PR110735)) +'!=' as relational-op in canonical loop Y +form for C/C++ +'nonmonotonic' as default loop schedule Y +modifier for worksharing-loop constructs +Collapse of associated loops that are Y +imperfectly nested loops +Clauses 'if', 'nontemporal' and Y +'order(concurrent)' in 'simd' construct +'atomic' constructs in 'simd' Y +'loop' construct Y +'order(concurrent)' clause Y +'scan' directive and 'in_scan' modifier Y +for the 'reduction' clause +'in_reduction' clause on 'task' Y +constructs +'in_reduction' clause on 'target' P 'nowait' only +constructs stub +'task_reduction' clause with 'taskgroup' Y +'task' modifier to 'reduction' clause Y +'affinity' clause to 'task' construct Y Stub only +'detach' clause to 'task' construct Y +'omp_fulfill_event' runtime routine Y +'reduction' and 'in_reduction' clauses on Y +'taskloop' and 'taskloop simd' constructs +'taskloop' construct cancelable by Y +'cancel' construct +'mutexinoutset' _dependence-type_ for Y +'depend' clause +Predefined memory spaces, memory Y See also +allocators, allocator traits *note Memory allocation:: +Memory management routines Y +'allocate' directive P C++ unsupported; + see also + *note Memory allocation:: +'allocate' clause P Clause has no + effect on + 'target' + (PR113436 + (https://gcc.gnu.org/PR113436)) +'use_device_addr' clause on 'target data' Y +'ancestor' modifier on 'device' clause Y +Implicit declare target directive Y +Discontiguous array section with 'target N +update' construct +C/C++'s lvalue expressions in 'to', Y +'from' and 'map' clauses +C/C++'s lvalue expressions in 'depend' Y +clauses +Nested 'declare target' directive Y +Combined 'master' constructs Y +'depend' clause on 'taskwait' Y +Weak memory ordering clauses on 'atomic' Y +and 'flush' construct +'hint' clause on the 'atomic' construct Y Stub only +'depobj' construct and depend objects Y +Lock hints were renamed to Y +synchronization hints +'conditional' modifier to 'lastprivate' Y +clause +Map-order clarifications P +'close' _map-type-modifier_ Y +Mapping C/C++ pointer variables and to P +assign the address of device memory +mapped by an array section +Mapping of Fortran pointer and Y +allocatable variables, including pointer +and allocatable components of variables +'defaultmap' extensions Y +'declare mapper' directive N +'omp_get_supported_active_levels' routine Y +Runtime routines and environment Y +variables to display runtime thread +affinity information +'omp_pause_resource' and Y +'omp_pause_resource_all' runtime routines +'omp_get_device_num' runtime routine Y +OMPT interface N +OMPD interface N + +Other new OpenMP 5.0 features +----------------------------- + +Description Status Comments +----------------------------------------------------------------------- +Supporting C++'s range-based for loop Y + + +File: libgomp.info, Node: OpenMP 5.1, Next: OpenMP 5.2, Prev: OpenMP 5.0, Up: OpenMP Implementation Status + +2.3 OpenMP 5.1 +============== + +New features listed in Appendix B of the OpenMP specification +------------------------------------------------------------- + +Description Status Comments +----------------------------------------------------------------------- +OpenMP directive as C++ attribute Y +specifiers +'omp_all_memory' reserved locator Y +_target_device trait_ in OpenMP Context Y +'target_device' selector set in context Y +selectors +C/C++'s 'declare variant' directive: N +elision support of preprocessed code +'declare variant': new clauses Y +'adjust_args' and 'append_args' +'dispatch' construct Y +device-specific ICV settings with Y +environment variables +'assume' and 'assumes' directives Y +'nothing' directive Y +'error' directive Y +'masked' construct Y +'scope' directive Y +Loop transformation constructs Y +'strict' modifier in the 'grainsize' and Y +'num_tasks' clauses of the 'taskloop' +construct +'align' clause in 'allocate' directive P Only C and + Fortran +'align' modifier in 'allocate' clause Y +'thread_limit' clause to 'target' Y +construct +'has_device_addr' clause to 'target' Y +construct +Iterators in 'target update' motion N +clauses and 'map' clauses +Indirect calls to the device version of a Y +procedure or function in 'target' regions +'interop' directive Y Cf. + *note Offload-Target Specifics:: +'omp_interop_t' object support in runtime Y +routines +'nowait' clause in 'taskwait' directive Y +Extensions to the 'atomic' directive Y +'seq_cst' clause on a 'flush' construct Y +'inoutset' argument to the 'depend' Y +clause +'private' and 'firstprivate' argument to Y +'default' clause in C and C++ +'present' argument to 'defaultmap' clause Y +'omp_set_num_teams', Y +'omp_set_teams_thread_limit', +'omp_get_max_teams', +'omp_get_teams_thread_limit' runtime +routines +'omp_target_is_accessible' runtime Y +routine +'omp_target_memcpy_async' and Y +'omp_target_memcpy_rect_async' runtime +routines +'omp_get_mapped_ptr' runtime routine Y +'omp_calloc', 'omp_realloc', Y +'omp_aligned_alloc' and +'omp_aligned_calloc' runtime routines +'omp_alloctrait_key_t' enum: Y +'omp_atv_serialized' added, +'omp_atv_default' changed +'omp_display_env' runtime routine Y +'ompt_scope_endpoint_t' enum: N +'ompt_scope_beginend' +'ompt_sync_region_t' enum additions N +'ompt_state_t' enum: N +'ompt_state_wait_barrier_implementation' +and 'ompt_state_wait_barrier_teams' +'ompt_callback_target_data_op_emi_t', N +'ompt_callback_target_emi_t', +'ompt_callback_target_map_emi_t' and +'ompt_callback_target_submit_emi_t' +'ompt_callback_error_t' type N +'OMP_PLACES' syntax extensions Y +'OMP_NUM_TEAMS' and Y +'OMP_TEAMS_THREAD_LIMIT' environment +variables + +Other new OpenMP 5.1 features +----------------------------- + +Description Status Comments +----------------------------------------------------------------------- +Support of strictly structured blocks in Y +Fortran +Support of structured block sequences in Y +C/C++ +'unconstrained' and 'reproducible' Y +modifiers on 'order' clause +Support 'begin/end declare target' syntax Y +in C/C++ +Pointer predetermined firstprivate N +getting initialized to address of +matching mapped list item per 5.1, Sect. +2.21.7.2 +For Fortran, diagnose placing declarative N +before/between 'USE', 'IMPORT', and +'IMPLICIT' as invalid +Optional comma between directive and Y +clause in the '#pragma' form +'indirect' clause in 'declare target' Y +'device_type(nohost)'/'device_type(host)' N +for variables +'present' modifier to the 'map', 'to' and Y +'from' clauses +Changed interaction between 'declare Y +target' and OpenMP context +Dynamic selector support in Y +'metadirective' +Dynamic selector support in 'declare P Fortran rejects +variant' non-constant + expressions in + dynamic + selectors; C/C++ + reject + expressions + using argument + variables. + (PR113904 + (https://gcc.gnu.org/PR113904)) + + +File: libgomp.info, Node: OpenMP 5.2, Next: OpenMP 6.0, Prev: OpenMP 5.1, Up: OpenMP Implementation Status + +2.4 OpenMP 5.2 +============== + +New features listed in Appendix B of the OpenMP specification +------------------------------------------------------------- + +Description Status Comments +----------------------------------------------------------------------- +'omp_in_explicit_task' routine and Y +EXPLICIT-TASK-VAR ICV +'omp'/'ompx'/'omx' sentinels and N/A warning for +'omp_'/'ompx_' namespaces 'ompx/omx' + sentinels(1) +Clauses on 'end' directive can be on Y +directive +'destroy' clause with destroy-var Y +argument on 'depobj' +Deprecation of no-argument 'destroy' N/A undeprecated in +clause on 'depobj' OpenMP 6 +'linear' clause syntax changes and 'step' Y +modifier +Deprecation of minus operator for N +reductions +Deprecation of separating 'map' modifiers N +without comma +'declare mapper' with iterator and N +'present' modifiers +If a matching mapped list item is not Y +found in the data environment, the +pointer retains its original value +New 'enter' clause as alias for 'to' on Y +declare target directive +Deprecation of 'to' clause on declare N +target directive +Extended list of directives permitted in Y +Fortran pure procedures +New 'allocators' directive for Fortran Y +Deprecation of 'allocate' directive for N +Fortran allocatables/pointers +Optional paired 'end' directive with Y +'dispatch' +New 'memspace' and 'traits' modifiers for N +'uses_allocators' +Deprecation of traits array following the N +allocator_handle expression in +'uses_allocators' +New 'otherwise' clause as alias for Y +'default' on metadirectives +Deprecation of 'default' clause on N Both 'otherwise' +metadirectives and 'default' + are accepted + without + diagnostics. +Deprecation of delimited form of 'declare N +target' +Reproducible semantics changed for N +'order(concurrent)' +'allocate' and 'firstprivate' clauses on Y +'scope' +'ompt_callback_work' N +Default map-type for the 'map' clause in Y +'target enter/exit data' +New 'doacross' clause as alias for Y +'depend' with 'source'/'sink' modifier +Deprecation of 'depend' with N +'source'/'sink' modifier +'omp_cur_iteration' keyword Y + +Other new OpenMP 5.2 features +----------------------------- + +Description Status Comments +----------------------------------------------------------------------- +For Fortran, optional comma between N +directive and clause +Conforming device numbers and Y +'omp_initial_device' and +'omp_invalid_device' enum/PARAMETER +Initial value of DEFAULT-DEVICE-VAR ICV Y +with 'OMP_TARGET_OFFLOAD=mandatory' +'all' as _implicit-behavior_ for Y +'defaultmap' +_interop_types_ in any position of the Y +modifier list for the 'init' clause of +the 'interop' construct +Invoke virtual member functions of C++ N +objects created on the host device on +other devices +'mapper' as map-type modifier in 'declare N +mapper' + + ---------- Footnotes ---------- + + (1) The 'ompx' sentinel as C/C++ pragma and C++ attributes are warned +for with '-Wunknown-pragmas' (implied by '-Wall') and '-Wattributes' +(enabled by default), respectively; for Fortran free-source code, there +is a warning enabled by default and, for fixed-source code, the 'omx' +sentinel is warned for with '-Wsurprising' (enabled by '-Wall'). +Unknown clauses are always rejected with an error. + + +File: libgomp.info, Node: OpenMP 6.0, Prev: OpenMP 5.2, Up: OpenMP Implementation Status + +2.5 OpenMP 6.0 +============== + +New features listed in Appendix B of the OpenMP specification +------------------------------------------------------------- + +Features deprecated in versions 5.0, 5.1 N/A Backward +and 5.2 were removed compatibility +Full support for C23 was added P +Full support for C++23 was added P +Full support for Fortran 2023 was added P +'_ALL' suffix to the device-scope P Host device +environment variables number wrongly + accepted +'num_threads' clause now accepts a list N +Abstract names added for N +'OMP_NUM_THREADS', 'OMP_THREAD_LIMIT' and +'OMP_TEAMS_THREAD_LIMIT' +Supporting increments with abstract names N +in 'OMP_PLACES' +Extension of 'OMP_DEFAULT_DEVICE' and new N +'OMP_AVAILABLE_DEVICES' environment vars +New 'uid' trait for target devices and N +for 'OMP_AVAILABLE_DEVICES' and +'OMP_DEFAULT_DEVICE' +New 'OMP_THREADS_RESERVE' environment N +variable +The 'decl' attribute was added to the C++ Y +attribute syntax +The OpenMP directive syntax was extended Y +to include C23 attribute specifiers +Support for pure directives in Fortran's N +'do concurrent' +All inarguable clauses take now an N +optional Boolean argument +The 'adjust_args' clause was extended to N +specify the argument by position and +supports variadic arguments +For Fortran, _locator list_ can be also N +function reference with data pointer +result +Concept of _assumed-size arrays_ in C and N +C++ +_directive-name-modifier_ accepted in all N +clauses +Extension of 'interop' operation of Y +'append_args', allowing all modifiers of +the 'init' clause +New argument-free version of 'depobj' N +with repeatable clauses and the 'init' +clause +Undeprecate omitting the argument to the Y +'depend' clause of the argument version +of the 'depend' construct +For Fortran, atomic with BLOCK construct N +and, for C/C++, with unlimited curly +braces supported +For Fortran, atomic with pointer N +comparison +For Fortran, atomic with enum and N +enumeration types +For Fortran, atomic compare with storing N +the comparison result +Canonical loop sequences and new N +'looprange' clause +For Fortran, handling polymorphic types P 'private' not +in data-sharing-attribute clauses supported +For Fortran, rejecting polymorphic types N not diagnosed +in data-mapping clauses (and mostly + unsupported) +New 'taskgraph' construct including N +'saved' modifier and 'replayable' clause +'default' clause on the 'target' N +directive and accepting variable +categories +Semantic change regarding the reference N +count update with 'use_device_ptr' and +'use_device_addr' +Support for inductions N +Reduction over private variables with N +'reduction' clause +Implicit reduction identifiers of C++ N +classes +New 'init_complete' clause to the 'scan' N +directive +'ref' modifier to the 'map' clause N +New 'storage' map-type modifier; N +context-dependent 'alloc' and 'release' +are aliases +Change of the _map-type_ property from N +_ultimate_ to _default_ +'self' modifier to 'map' and 'self' as N +'defaultmap' argument +Mapping of _assumed-size arrays_ in C, N +C++ and Fortran +'delete' as delete-modifier not as map N +type +For Fortran, the 'automap' modifier to N +the 'enter' clause of 'declare_target' +'groupprivate' directive N +'local' clause to 'declare_target' N +directive +'part_size' allocator trait for N +'interleaved' allocator partitions +'pin_device', 'preferred_device' and N +'target_access' allocator traits +'access' allocator trait changes N +New 'partitioner' value to 'partition' N +allocator trait +Semicolon-separated list to N +'uses_allocators' +New 'need_device_addr' modifier to N +'adjust_args' clause +'interop' clause to 'dispatch' Y +Scope requirement changes for N +'declare_target' +'message' and 'severity' clauses to N +'parallel' directive +'self_maps' clause to 'requires' Y +directive +'no_openmp_constructs' assumptions clause N +Restriction for 'ordered' regarding N +loop-transforming directives +'apply' clause to loop-transforming N +constructs +Non-constant values in the 'sizes' clause N +'fuse' loop-transformation construct N +'interchange' loop-transformation N +construct +'reverse' loop-transformation construct N +'split' loop-transformation construct N +'stripe' loop-transformation construct N +'tile' permitting association of grid and N +inter-tile loops +'strict' modifier keyword to N +'num_threads' +'safesync' clause to the 'parallel' N +construct +'omp_curr_progress_width' identifier N +'omp_get_max_progress_width' runtime N +routine +Lifted restrictions on N +'order(concurrent)' and, hence, the +'loop' construct +'atomic' permitted in a construct with N +'order(concurrent)' +Lifted restrictions on N +not-strictly-nested regions with +'order(concurrent)' +'workdistribute' directive for Fortran N +Fortran 'DO CONCURRENT' as associated N +loop in a 'loop' construct +New 'task_iteration' directive inside N +'taskloop' +'threadset' clause in task-generating N +constructs +New 'priority' clause to 'target', N +'target_enter_data', 'target_data', +'target_exit_data' and 'target_update' +New 'device_type' clause to the 'target' N +directive +'target_data' as composite construct N +'nowait' clause with reverse-offload N +'target' directives +Extended _prefer-type_ modifier to 'init' Y +clause +Boolean argument to 'nowait' and N +'nogroup' may be non constant +'memscope' clause to 'atomic' and 'flush' N +New 'transparent' clause for N +multi-generational task-dependence graphs +The 'cancel' construct now completes N +tasks with unfulfilled events +'omp_fulfill_event' routine was N +restricted regarding fulfillment of event +variables +Added rule for compound-directive names, N +permitting many more combinations +'omp_is_free_agent' and N +'omp_ancestor_is_free_agent' routines +'omp_get_device_from_uid' and Y +'omp_get_uid_from_device' routines +'omp_get_device_num_teams', N +'omp_set_device_num_teams', +'omp_get_device_teams_thread_limit', and +'omp_set_device_teams_thread_limit' +routines +'omp_target_memset' and N +'omp_target_memset_async' routines +Fortran version of the interop runtime Y +routines +Routines for obtaining memory N +spaces/allocators for shared/device +memory +'omp_get_memspace_num_resources' routine N +'omp_get_memspace_pagesize' routine N +'omp_get_submemspace' routine N +'omp_init_mempartitioner', N +'omp_destroy_mempartitioner', +'omp_init_mempartition', +'omp_destroy_mempartition', +'omp_mempartition_set_part', +'omp_mempartition_get_user_data' routines +Deprecation of the 'target_data_op', N +'target', 'target_map' and +'target_submit' callbacks and as values +that 'set_callback' must return +'ompt_target_data_transfer' and N +'ompt_target_data_transfer_async' values +in 'ompt_target_data_op_t' enum +The values N +'ompt_target_data_transfer_to_device', +'ompt_target_data_transfer_from_device', +'ompt_target_data_transfer_to_device_async' +and +'ompt_target_data_transfer_from_device_async' +of the 'target_data_op' OMPT type were +deprecated +'ompt_get_buffer_limits' OMPT routine N + +Deprecated features, unless listed above +---------------------------------------- + +Deprecation of omitting the optional N +white space to separate adjacent keywords +in the directive-name in Fortran (fixed +and free source form) +Deprecation of the combiner expression in N +the 'declare_reduction' argument +Deprecation of the Fortran include file N +'omp_lib.h' + +Other new OpenMP 6.0 features +----------------------------- + +Multi-word directives now use underscore N +by default +Relaxed Fortran restrictions to the N +'aligned' clause +Mapping lambda captures N +New 'omp_pause_stop_tool' constant for N +omp_pause_resource +In Fortran (fixed and free source form), N +spaces between directive names are +mandatory +Update of the map-type decay for mapping N +and 'declare_mapper' + + +File: libgomp.info, Node: Runtime Library Routines, Next: Environment Variables, Prev: OpenMP Implementation Status, Up: Top + +3 OpenMP Runtime Library Routines +********************************* + +The runtime routines described here are defined by Section 18 of the +OpenMP specification in version 5.2. + +* Menu: + +* Thread Team Routines:: +* Thread Affinity Routines:: +* Teams Region Routines:: +* Tasking Routines:: +* Resource Relinquishing Routines:: +* Device Information Routines:: +* Device Memory Routines:: +* Lock Routines:: +* Timing Routines:: +* Event Routine:: +* Interoperability Routines:: +* Memory Management Routines:: +* Environment Display Routine:: + + +File: libgomp.info, Node: Thread Team Routines, Next: Thread Affinity Routines, Up: Runtime Library Routines + +3.1 Thread Team Routines +======================== + +Routines controlling threads in the current contention group. They have +C linkage and do not throw exceptions. + +* Menu: + +* omp_set_num_threads:: Set upper team size limit +* omp_get_num_threads:: Size of the active team +* omp_get_max_threads:: Maximum number of threads of parallel region +* omp_get_thread_num:: Current thread ID +* omp_in_parallel:: Whether a parallel region is active +* omp_set_dynamic:: Enable/disable dynamic teams +* omp_get_dynamic:: Dynamic teams setting +* omp_get_cancellation:: Whether cancellation support is enabled +* omp_set_nested:: Enable/disable nested parallel regions +* omp_get_nested:: Nested parallel regions +* omp_set_schedule:: Set the runtime scheduling method +* omp_get_schedule:: Obtain the runtime scheduling method +* omp_get_teams_thread_limit:: Maximum number of threads imposed by teams +* omp_get_supported_active_levels:: Maximum number of active regions supported +* omp_set_max_active_levels:: Limits the number of active parallel regions +* omp_get_max_active_levels:: Current maximum number of active regions +* omp_get_level:: Number of parallel regions +* omp_get_ancestor_thread_num:: Ancestor thread ID +* omp_get_team_size:: Number of threads in a team +* omp_get_active_level:: Number of active parallel regions + + +File: libgomp.info, Node: omp_set_num_threads, Next: omp_get_num_threads, Up: Thread Team Routines + +3.1.1 'omp_set_num_threads' - Set upper team size limit +------------------------------------------------------- + +_Description_: + Specifies the number of threads used by default in subsequent + parallel sections, if those do not specify a 'num_threads' clause. + The argument of 'omp_set_num_threads' shall be a positive integer. + +_C/C++_: + _Prototype_: 'void omp_set_num_threads(int num_threads);' + +_Fortran_: + _Interface_: 'subroutine omp_set_num_threads(num_threads)' + 'integer, intent(in) :: num_threads' + +_See also_: + *note OMP_NUM_THREADS::, *note omp_get_num_threads::, *note + omp_get_max_threads:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.1. + + +File: libgomp.info, Node: omp_get_num_threads, Next: omp_get_max_threads, Prev: omp_set_num_threads, Up: Thread Team Routines + +3.1.2 'omp_get_num_threads' - Size of the active team +----------------------------------------------------- + +_Description_: + Returns the number of threads in the current team. In a sequential + section of the program 'omp_get_num_threads' returns 1. + + The default team size may be initialized at startup by the + 'OMP_NUM_THREADS' environment variable. At runtime, the size of + the current team may be set either by the 'NUM_THREADS' clause or + by 'omp_set_num_threads'. If none of the above were used to define + a specific value and 'OMP_DYNAMIC' is disabled, one thread per CPU + online is used. + +_C/C++_: + _Prototype_: 'int omp_get_num_threads(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_num_threads()' + +_See also_: + *note omp_get_max_threads::, *note omp_set_num_threads::, *note + OMP_NUM_THREADS:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.2. + + +File: libgomp.info, Node: omp_get_max_threads, Next: omp_get_thread_num, Prev: omp_get_num_threads, Up: Thread Team Routines + +3.1.3 'omp_get_max_threads' - Maximum number of threads of parallel region +-------------------------------------------------------------------------- + +_Description_: + Return the maximum number of threads used for the current parallel + region that does not use the clause 'num_threads'. + +_C/C++_: + _Prototype_: 'int omp_get_max_threads(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_max_threads()' + +_See also_: + *note omp_set_num_threads::, *note omp_set_dynamic::, *note + omp_get_thread_limit:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.3. + + +File: libgomp.info, Node: omp_get_thread_num, Next: omp_in_parallel, Prev: omp_get_max_threads, Up: Thread Team Routines + +3.1.4 'omp_get_thread_num' - Current thread ID +---------------------------------------------- + +_Description_: + Returns a unique thread identification number within the current + team. In a sequential parts of the program, 'omp_get_thread_num' + always returns 0. In parallel regions the return value varies from + 0 to 'omp_get_num_threads'-1 inclusive. The return value of the + primary thread of a team is always 0. + +_C/C++_: + _Prototype_: 'int omp_get_thread_num(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_thread_num()' + +_See also_: + *note omp_get_num_threads::, *note omp_get_ancestor_thread_num:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.4. + + +File: libgomp.info, Node: omp_in_parallel, Next: omp_set_dynamic, Prev: omp_get_thread_num, Up: Thread Team Routines + +3.1.5 'omp_in_parallel' - Whether a parallel region is active +------------------------------------------------------------- + +_Description_: + This function returns 'true' if currently running in parallel, + 'false' otherwise. Here, 'true' and 'false' represent their + language-specific counterparts. + +_C/C++_: + _Prototype_: 'int omp_in_parallel(void);' + +_Fortran_: + _Interface_: 'logical function omp_in_parallel()' + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.6. + + +File: libgomp.info, Node: omp_set_dynamic, Next: omp_get_dynamic, Prev: omp_in_parallel, Up: Thread Team Routines + +3.1.6 'omp_set_dynamic' - Enable/disable dynamic teams +------------------------------------------------------ + +_Description_: + Enable or disable the dynamic adjustment of the number of threads + within a team. The function takes the language-specific equivalent + of 'true' and 'false', where 'true' enables dynamic adjustment of + team sizes and 'false' disables it. + +_C/C++_: + _Prototype_: 'void omp_set_dynamic(int dynamic_threads);' + +_Fortran_: + _Interface_: 'subroutine omp_set_dynamic(dynamic_threads)' + 'logical, intent(in) :: dynamic_threads' + +_See also_: + *note OMP_DYNAMIC::, *note omp_get_dynamic:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.7. + + +File: libgomp.info, Node: omp_get_dynamic, Next: omp_get_cancellation, Prev: omp_set_dynamic, Up: Thread Team Routines + +3.1.7 'omp_get_dynamic' - Dynamic teams setting +----------------------------------------------- + +_Description_: + This function returns 'true' if enabled, 'false' otherwise. Here, + 'true' and 'false' represent their language-specific counterparts. + + The dynamic team setting may be initialized at startup by the + 'OMP_DYNAMIC' environment variable or at runtime using + 'omp_set_dynamic'. If undefined, dynamic adjustment is disabled by + default. + +_C/C++_: + _Prototype_: 'int omp_get_dynamic(void);' + +_Fortran_: + _Interface_: 'logical function omp_get_dynamic()' + +_See also_: + *note omp_set_dynamic::, *note OMP_DYNAMIC:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.8. + + +File: libgomp.info, Node: omp_get_cancellation, Next: omp_set_nested, Prev: omp_get_dynamic, Up: Thread Team Routines + +3.1.8 'omp_get_cancellation' - Whether cancellation support is enabled +---------------------------------------------------------------------- + +_Description_: + This function returns 'true' if cancellation is activated, 'false' + otherwise. Here, 'true' and 'false' represent their + language-specific counterparts. Unless 'OMP_CANCELLATION' is set + true, cancellations are deactivated. + +_C/C++_: + _Prototype_: 'int omp_get_cancellation(void);' + +_Fortran_: + _Interface_: 'logical function omp_get_cancellation()' + +_See also_: + *note OMP_CANCELLATION:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.9. + + +File: libgomp.info, Node: omp_set_nested, Next: omp_get_nested, Prev: omp_get_cancellation, Up: Thread Team Routines + +3.1.9 'omp_set_nested' - Enable/disable nested parallel regions +--------------------------------------------------------------- + +_Description_: + Enable or disable nested parallel regions, i.e., whether team + members are allowed to create new teams. The function takes the + language-specific equivalent of 'true' and 'false', where 'true' + enables dynamic adjustment of team sizes and 'false' disables it. + + Enabling nested parallel regions also sets the maximum number of + active nested regions to the maximum supported. Disabling nested + parallel regions sets the maximum number of active nested regions + to one. + + Note that the 'omp_set_nested' API routine was deprecated in the + OpenMP specification 5.0 in favor of 'omp_set_max_active_levels'. + +_C/C++_: + _Prototype_: 'void omp_set_nested(int nested);' + +_Fortran_: + _Interface_: 'subroutine omp_set_nested(nested)' + 'logical, intent(in) :: nested' + +_See also_: + *note omp_get_nested::, *note omp_set_max_active_levels::, *note + OMP_MAX_ACTIVE_LEVELS::, *note OMP_NESTED:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.10. + + +File: libgomp.info, Node: omp_get_nested, Next: omp_set_schedule, Prev: omp_set_nested, Up: Thread Team Routines + +3.1.10 'omp_get_nested' - Nested parallel regions +------------------------------------------------- + +_Description_: + This function returns 'true' if nested parallel regions are + enabled, 'false' otherwise. Here, 'true' and 'false' represent + their language-specific counterparts. + + The state of nested parallel regions at startup depends on several + environment variables. If 'OMP_MAX_ACTIVE_LEVELS' is defined and + is set to greater than one, then nested parallel regions will be + enabled. If not defined, then the value of the 'OMP_NESTED' + environment variable will be followed if defined. If neither are + defined, then if either 'OMP_NUM_THREADS' or 'OMP_PROC_BIND' are + defined with a list of more than one value, then nested parallel + regions are enabled. If none of these are defined, then nested + parallel regions are disabled by default. + + Nested parallel regions can be enabled or disabled at runtime using + 'omp_set_nested', or by setting the maximum number of nested + regions with 'omp_set_max_active_levels' to one to disable, or + above one to enable. + + Note that the 'omp_get_nested' API routine was deprecated in the + OpenMP specification 5.0 in favor of 'omp_get_max_active_levels'. + +_C/C++_: + _Prototype_: 'int omp_get_nested(void);' + +_Fortran_: + _Interface_: 'logical function omp_get_nested()' + +_See also_: + *note omp_get_max_active_levels::, *note omp_set_nested::, *note + OMP_MAX_ACTIVE_LEVELS::, *note OMP_NESTED:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.11. + + +File: libgomp.info, Node: omp_set_schedule, Next: omp_get_schedule, Prev: omp_get_nested, Up: Thread Team Routines + +3.1.11 'omp_set_schedule' - Set the runtime scheduling method +------------------------------------------------------------- + +_Description_: + Sets the runtime scheduling method. The KIND argument can have the + value 'omp_sched_static', 'omp_sched_dynamic', 'omp_sched_guided' + or 'omp_sched_auto'. Except for 'omp_sched_auto', the chunk size + is set to the value of CHUNK_SIZE if positive, or to the default + value if zero or negative. For 'omp_sched_auto' the CHUNK_SIZE + argument is ignored. + +_C/C++_ + _Prototype_: 'void omp_set_schedule(omp_sched_t kind, int + chunk_size);' + +_Fortran_: + _Interface_: 'subroutine omp_set_schedule(kind, chunk_size)' + 'integer(kind=omp_sched_kind) kind' + 'integer chunk_size' + +_See also_: + *note omp_get_schedule:: *note OMP_SCHEDULE:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.12. + + +File: libgomp.info, Node: omp_get_schedule, Next: omp_get_teams_thread_limit, Prev: omp_set_schedule, Up: Thread Team Routines + +3.1.12 'omp_get_schedule' - Obtain the runtime scheduling method +---------------------------------------------------------------- + +_Description_: + Obtain the runtime scheduling method. The KIND argument is set to + 'omp_sched_static', 'omp_sched_dynamic', 'omp_sched_guided' or + 'omp_sched_auto'. The second argument, CHUNK_SIZE, is set to the + chunk size. + +_C/C++_ + _Prototype_: 'void omp_get_schedule(omp_sched_t *kind, int + *chunk_size);' + +_Fortran_: + _Interface_: 'subroutine omp_get_schedule(kind, chunk_size)' + 'integer(kind=omp_sched_kind) kind' + 'integer chunk_size' + +_See also_: + *note omp_set_schedule::, *note OMP_SCHEDULE:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.13. + + +File: libgomp.info, Node: omp_get_teams_thread_limit, Next: omp_get_supported_active_levels, Prev: omp_get_schedule, Up: Thread Team Routines + +3.1.13 'omp_get_teams_thread_limit' - Maximum number of threads imposed by teams +-------------------------------------------------------------------------------- + +_Description_: + Return the maximum number of threads that are able to participate + in each team created by a teams construct. + +_C/C++_: + _Prototype_: 'int omp_get_teams_thread_limit(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_teams_thread_limit()' + +_See also_: + *note omp_set_teams_thread_limit::, *note OMP_TEAMS_THREAD_LIMIT:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.4.6. + + +File: libgomp.info, Node: omp_get_supported_active_levels, Next: omp_set_max_active_levels, Prev: omp_get_teams_thread_limit, Up: Thread Team Routines + +3.1.14 'omp_get_supported_active_levels' - Maximum number of active regions supported +------------------------------------------------------------------------------------- + +_Description_: + This function returns the maximum number of nested, active parallel + regions supported by this implementation. + +_C/C++_ + _Prototype_: 'int omp_get_supported_active_levels(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_supported_active_levels()' + +_See also_: + *note omp_get_max_active_levels::, *note + omp_set_max_active_levels:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.2.15. + + +File: libgomp.info, Node: omp_set_max_active_levels, Next: omp_get_max_active_levels, Prev: omp_get_supported_active_levels, Up: Thread Team Routines + +3.1.15 'omp_set_max_active_levels' - Limits the number of active parallel regions +--------------------------------------------------------------------------------- + +_Description_: + This function limits the maximum allowed number of nested, active + parallel regions. MAX_LEVELS must be less or equal to the value + returned by 'omp_get_supported_active_levels'. + +_C/C++_ + _Prototype_: 'void omp_set_max_active_levels(int max_levels);' + +_Fortran_: + _Interface_: 'subroutine omp_set_max_active_levels(max_levels)' + 'integer max_levels' + +_See also_: + *note omp_get_max_active_levels::, *note omp_get_active_level::, + *note omp_get_supported_active_levels:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.15. + + +File: libgomp.info, Node: omp_get_max_active_levels, Next: omp_get_level, Prev: omp_set_max_active_levels, Up: Thread Team Routines + +3.1.16 'omp_get_max_active_levels' - Current maximum number of active regions +----------------------------------------------------------------------------- + +_Description_: + This function obtains the maximum allowed number of nested, active + parallel regions. + +_C/C++_ + _Prototype_: 'int omp_get_max_active_levels(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_max_active_levels()' + +_See also_: + *note omp_set_max_active_levels::, *note omp_get_active_level:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.16. + + +File: libgomp.info, Node: omp_get_level, Next: omp_get_ancestor_thread_num, Prev: omp_get_max_active_levels, Up: Thread Team Routines + +3.1.17 'omp_get_level' - Obtain the current nesting level +--------------------------------------------------------- + +_Description_: + This function returns the nesting level for the parallel blocks, + which enclose the calling call. + +_C/C++_ + _Prototype_: 'int omp_get_level(void);' + +_Fortran_: + _Interface_: 'integer function omp_level()' + +_See also_: + *note omp_get_active_level:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.17. + + +File: libgomp.info, Node: omp_get_ancestor_thread_num, Next: omp_get_team_size, Prev: omp_get_level, Up: Thread Team Routines + +3.1.18 'omp_get_ancestor_thread_num' - Ancestor thread ID +--------------------------------------------------------- + +_Description_: + This function returns the thread identification number for the + given nesting level of the current thread. For values of LEVEL + outside zero to 'omp_get_level' -1 is returned; if LEVEL is + 'omp_get_level' the result is identical to 'omp_get_thread_num'. + +_C/C++_ + _Prototype_: 'int omp_get_ancestor_thread_num(int level);' + +_Fortran_: + _Interface_: 'integer function omp_get_ancestor_thread_num(level)' + 'integer level' + +_See also_: + *note omp_get_level::, *note omp_get_thread_num::, *note + omp_get_team_size:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.18. + + +File: libgomp.info, Node: omp_get_team_size, Next: omp_get_active_level, Prev: omp_get_ancestor_thread_num, Up: Thread Team Routines + +3.1.19 'omp_get_team_size' - Number of threads in a team +-------------------------------------------------------- + +_Description_: + This function returns the number of threads in a thread team to + which either the current thread or its ancestor belongs. For + values of LEVEL outside zero to 'omp_get_level', -1 is returned; if + LEVEL is zero, 1 is returned, and for 'omp_get_level', the result + is identical to 'omp_get_num_threads'. + +_C/C++_: + _Prototype_: 'int omp_get_team_size(int level);' + +_Fortran_: + _Interface_: 'integer function omp_get_team_size(level)' + 'integer level' + +_See also_: + *note omp_get_num_threads::, *note omp_get_level::, *note + omp_get_ancestor_thread_num:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.19. + + +File: libgomp.info, Node: omp_get_active_level, Prev: omp_get_team_size, Up: Thread Team Routines + +3.1.20 'omp_get_active_level' - Number of parallel regions +---------------------------------------------------------- + +_Description_: + This function returns the nesting level for the active parallel + blocks, which enclose the calling call. + +_C/C++_ + _Prototype_: 'int omp_get_active_level(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_active_level()' + +_See also_: + *note omp_get_level::, *note omp_get_max_active_levels::, *note + omp_set_max_active_levels:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.20. + + +File: libgomp.info, Node: Thread Affinity Routines, Next: Teams Region Routines, Prev: Thread Team Routines, Up: Runtime Library Routines + +3.2 Thread Affinity Routines +============================ + +Routines controlling and accessing thread-affinity policies. They have +C linkage and do not throw exceptions. + +* Menu: + +* omp_get_proc_bind:: Whether threads may be moved between CPUs + + +File: libgomp.info, Node: omp_get_proc_bind, Up: Thread Affinity Routines + +3.2.1 'omp_get_proc_bind' - Whether threads may be moved between CPUs +--------------------------------------------------------------------- + +_Description_: + This functions returns the currently active thread affinity policy, + which is set via 'OMP_PROC_BIND'. Possible values are + 'omp_proc_bind_false', 'omp_proc_bind_true', + 'omp_proc_bind_primary', 'omp_proc_bind_master', + 'omp_proc_bind_close' and 'omp_proc_bind_spread', where + 'omp_proc_bind_master' is an alias for 'omp_proc_bind_primary'. + +_C/C++_: + _Prototype_: 'omp_proc_bind_t omp_get_proc_bind(void);' + +_Fortran_: + _Interface_: 'integer(kind=omp_proc_bind_kind) function + omp_get_proc_bind()' + +_See also_: + *note OMP_PROC_BIND::, *note OMP_PLACES::, *note + GOMP_CPU_AFFINITY::, + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.22. + + +File: libgomp.info, Node: Teams Region Routines, Next: Tasking Routines, Prev: Thread Affinity Routines, Up: Runtime Library Routines + +3.3 Teams Region Routines +========================= + +Routines controlling the league of teams that are executed in a 'teams' +region. They have C linkage and do not throw exceptions. + +* Menu: + +* omp_get_num_teams:: Number of teams +* omp_get_team_num:: Get team number +* omp_set_num_teams:: Set upper teams limit for teams region +* omp_get_max_teams:: Maximum number of teams for teams region +* omp_set_teams_thread_limit:: Set upper thread limit for teams construct +* omp_get_thread_limit:: Maximum number of threads + + +File: libgomp.info, Node: omp_get_num_teams, Next: omp_get_team_num, Up: Teams Region Routines + +3.3.1 'omp_get_num_teams' - Number of teams +------------------------------------------- + +_Description_: + Returns the number of teams in the current team region. + +_C/C++_: + _Prototype_: 'int omp_get_num_teams(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_num_teams()' + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.32. + + +File: libgomp.info, Node: omp_get_team_num, Next: omp_set_num_teams, Prev: omp_get_num_teams, Up: Teams Region Routines + +3.3.2 'omp_get_team_num' - Get team number +------------------------------------------ + +_Description_: + Returns the team number of the calling thread. + +_C/C++_: + _Prototype_: 'int omp_get_team_num(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_team_num()' + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.33. + + +File: libgomp.info, Node: omp_set_num_teams, Next: omp_get_max_teams, Prev: omp_get_team_num, Up: Teams Region Routines + +3.3.3 'omp_set_num_teams' - Set upper teams limit for teams construct +--------------------------------------------------------------------- + +_Description_: + Specifies the upper bound for number of teams created by the teams + construct which does not specify a 'num_teams' clause. The + argument of 'omp_set_num_teams' shall be a positive integer. + +_C/C++_: + _Prototype_: 'void omp_set_num_teams(int num_teams);' + +_Fortran_: + _Interface_: 'subroutine omp_set_num_teams(num_teams)' + 'integer, intent(in) :: num_teams' + +_See also_: + *note OMP_NUM_TEAMS::, *note omp_get_num_teams::, *note + omp_get_max_teams:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.4.3. + + +File: libgomp.info, Node: omp_get_max_teams, Next: omp_set_teams_thread_limit, Prev: omp_set_num_teams, Up: Teams Region Routines + +3.3.4 'omp_get_max_teams' - Maximum number of teams of teams region +------------------------------------------------------------------- + +_Description_: + Return the maximum number of teams used for the teams region that + does not use the clause 'num_teams'. + +_C/C++_: + _Prototype_: 'int omp_get_max_teams(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_max_teams()' + +_See also_: + *note omp_set_num_teams::, *note omp_get_num_teams:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.4.4. + + +File: libgomp.info, Node: omp_set_teams_thread_limit, Next: omp_get_thread_limit, Prev: omp_get_max_teams, Up: Teams Region Routines + +3.3.5 'omp_set_teams_thread_limit' - Set upper thread limit for teams construct +------------------------------------------------------------------------------- + +_Description_: + Specifies the upper bound for number of threads that are available + for each team created by the teams construct which does not specify + a 'thread_limit' clause. The argument of + 'omp_set_teams_thread_limit' shall be a positive integer. + +_C/C++_: + _Prototype_: 'void omp_set_teams_thread_limit(int thread_limit);' + +_Fortran_: + _Interface_: 'subroutine omp_set_teams_thread_limit(thread_limit)' + 'integer, intent(in) :: thread_limit' + +_See also_: + *note OMP_TEAMS_THREAD_LIMIT::, *note omp_get_teams_thread_limit::, + *note omp_get_thread_limit:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.4.5. + + +File: libgomp.info, Node: omp_get_thread_limit, Prev: omp_set_teams_thread_limit, Up: Teams Region Routines + +3.3.6 'omp_get_thread_limit' - Maximum number of threads +-------------------------------------------------------- + +_Description_: + Return the maximum number of threads of the program. + +_C/C++_: + _Prototype_: 'int omp_get_thread_limit(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_thread_limit()' + +_See also_: + *note omp_get_max_threads::, *note OMP_THREAD_LIMIT:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.14. + + +File: libgomp.info, Node: Tasking Routines, Next: Resource Relinquishing Routines, Prev: Teams Region Routines, Up: Runtime Library Routines + +3.4 Tasking Routines +==================== + +Routines relating to explicit tasks. They have C linkage and do not +throw exceptions. + +* Menu: + +* omp_get_max_task_priority:: Maximum task priority value that can be set +* omp_in_explicit_task:: Whether a given task is an explicit task +* omp_in_final:: Whether in final or included task region + + +File: libgomp.info, Node: omp_get_max_task_priority, Next: omp_in_explicit_task, Up: Tasking Routines + +3.4.1 'omp_get_max_task_priority' - Maximum priority value +---------------------------------------------------------- + +that can be set for tasks. +_Description_: + This function obtains the maximum allowed priority number for + tasks. + +_C/C++_ + _Prototype_: 'int omp_get_max_task_priority(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_max_task_priority()' + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.29. + + +File: libgomp.info, Node: omp_in_explicit_task, Next: omp_in_final, Prev: omp_get_max_task_priority, Up: Tasking Routines + +3.4.2 'omp_in_explicit_task' - Whether a given task is an explicit task +----------------------------------------------------------------------- + +_Description_: + The function returns the EXPLICIT-TASK-VAR ICV; it returns true + when the encountering task was generated by a task-generating + construct such as 'target', 'task' or 'taskloop'. Otherwise, the + encountering task is in an implicit task region such as generated + by the implicit or explicit 'parallel' region and + 'omp_in_explicit_task' returns false. + +_C/C++_ + _Prototype_: 'int omp_in_explicit_task(void);' + +_Fortran_: + _Interface_: 'logical function omp_in_explicit_task()' + +_Reference_: + OpenMP specification v5.2 (https://www.openmp.org), Section 18.5.2. + + +File: libgomp.info, Node: omp_in_final, Prev: omp_in_explicit_task, Up: Tasking Routines + +3.4.3 'omp_in_final' - Whether in final or included task region +--------------------------------------------------------------- + +_Description_: + This function returns 'true' if currently running in a final or + included task region, 'false' otherwise. Here, 'true' and 'false' + represent their language-specific counterparts. + +_C/C++_: + _Prototype_: 'int omp_in_final(void);' + +_Fortran_: + _Interface_: 'logical function omp_in_final()' + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.21. + + +File: libgomp.info, Node: Resource Relinquishing Routines, Next: Device Information Routines, Prev: Tasking Routines, Up: Runtime Library Routines + +3.5 Resource Relinquishing Routines +=================================== + +Routines releasing resources used by the OpenMP runtime. They have C +linkage and do not throw exceptions. + +* Menu: + +* omp_pause_resource:: Release OpenMP resources on a device +* omp_pause_resource_all:: Release OpenMP resources on all devices + + +File: libgomp.info, Node: omp_pause_resource, Next: omp_pause_resource_all, Up: Resource Relinquishing Routines + +3.5.1 'omp_pause_resource' - Release OpenMP resources on a device +----------------------------------------------------------------- + +_Description_: + Free resources used by the OpenMP program and the runtime library + on and for the device specified by DEVICE_NUM; on success, zero is + returned and non-zero otherwise. + + The value of DEVICE_NUM must be a conforming device number. The + routine may not be called from within any explicit region and all + explicit threads that do not bind to the implicit parallel region + have finalized execution. + +_C/C++_: + _Prototype_: 'int omp_pause_resource(omp_pause_resource_t kind, int + device_num);' + +_Fortran_: + _Interface_: 'integer function omp_pause_resource(kind, device_num)' + 'integer (kind=omp_pause_resource_kind) kind' + 'integer device_num' + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.2.43. + + +File: libgomp.info, Node: omp_pause_resource_all, Prev: omp_pause_resource, Up: Resource Relinquishing Routines + +3.5.2 'omp_pause_resource_all' - Release OpenMP resources on all devices +------------------------------------------------------------------------ + +_Description_: + Free resources used by the OpenMP program and the runtime library + on all devices, including the host. On success, zero is returned + and non-zero otherwise. + + The routine may not be called from within any explicit region and + all explicit threads that do not bind to the implicit parallel + region have finalized execution. + +_C/C++_: + _Prototype_: 'int omp_pause_resource(omp_pause_resource_t kind);' + +_Fortran_: + _Interface_: 'integer function omp_pause_resource(kind)' + 'integer (kind=omp_pause_resource_kind) kind' + +_See also_: + *note omp_pause_resource:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.2.44. + + +File: libgomp.info, Node: Device Information Routines, Next: Device Memory Routines, Prev: Resource Relinquishing Routines, Up: Runtime Library Routines + +3.6 Device Information Routines +=============================== + +Routines related to devices available to an OpenMP program. They have C +linkage and do not throw exceptions. + +* Menu: + +* omp_get_num_procs:: Number of processors online +* omp_set_default_device:: Set the default device for target regions +* omp_get_default_device:: Get the default device for target regions +* omp_get_num_devices:: Number of target devices +* omp_get_device_num:: Get device that current thread is running on +* omp_get_device_from_uid:: Obtain the device number to a unique id +* omp_get_uid_from_device:: Obtain the unique id of a device +* omp_is_initial_device:: Whether executing on the host device +* omp_get_initial_device:: Device number of host device + + +File: libgomp.info, Node: omp_get_num_procs, Next: omp_set_default_device, Up: Device Information Routines + +3.6.1 'omp_get_num_procs' - Number of processors online +------------------------------------------------------- + +_Description_: + Returns the number of processors online on that device. + +_C/C++_: + _Prototype_: 'int omp_get_num_procs(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_num_procs()' + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.5. + + +File: libgomp.info, Node: omp_set_default_device, Next: omp_get_default_device, Prev: omp_get_num_procs, Up: Device Information Routines + +3.6.2 'omp_set_default_device' - Set the default device for target regions +-------------------------------------------------------------------------- + +_Description_: + Get the value of the _default-device-var_ ICV, which is used for + target regions without a device clause. The argument shall be a + nonnegative device number, 'omp_initial_device', or + 'omp_invalid_device'. + + The effect of running this routine in a 'target' region is + unspecified. + +_C/C++_: + _Prototype_: 'void omp_set_default_device(int device_num);' + +_Fortran_: + _Interface_: 'subroutine omp_set_default_device(device_num)' + 'integer device_num' + +_See also_: + *note OMP_DEFAULT_DEVICE::, *note omp_get_default_device:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.29. + + +File: libgomp.info, Node: omp_get_default_device, Next: omp_get_num_devices, Prev: omp_set_default_device, Up: Device Information Routines + +3.6.3 'omp_get_default_device' - Get the default device for target regions +-------------------------------------------------------------------------- + +_Description_: + Get the value of the _default-device-var_ ICV, which is used for + target regions without a device clause. The value is either a + nonnegative device number, 'omp_initial_device' or + 'omp_invalid_device'. Note that for the host, the ICV can have two + values: either the value of the named constant 'omp_initial_device' + or the value returned by the 'omp_get_num_devices' routine. + + The effect of running this routine in a 'target' region is + unspecified. + +_C/C++_: + _Prototype_: 'int omp_get_default_device(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_default_device()' + +_See also_: + *note OMP_DEFAULT_DEVICE::, *note omp_set_default_device::, *note + omp_get_initial_device:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.30. + + +File: libgomp.info, Node: omp_get_num_devices, Next: omp_get_device_num, Prev: omp_get_default_device, Up: Device Information Routines + +3.6.4 'omp_get_num_devices' - Number of target devices +------------------------------------------------------ + +_Description_: + Returns the number of available non-host devices. + + The effect of running this routine in a 'target' region is + unspecified. + +_C/C++_: + _Prototype_: 'int omp_get_num_devices(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_num_devices()' + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.31. + + +File: libgomp.info, Node: omp_get_device_num, Next: omp_get_device_from_uid, Prev: omp_get_num_devices, Up: Device Information Routines + +3.6.5 'omp_get_device_num' - Return device number of current device +------------------------------------------------------------------- + +_Description_: + This function returns a device number that represents the device + that the current thread is executing on. When called on the host, + it returns the same value as returned by the + 'omp_get_initial_device' function as required since OpenMP 5.0. + +_C/C++_ + _Prototype_: 'int omp_get_device_num(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_device_num()' + +_See also_: + *note omp_get_initial_device:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.2.37. + + +File: libgomp.info, Node: omp_get_device_from_uid, Next: omp_get_uid_from_device, Prev: omp_get_device_num, Up: Device Information Routines + +3.6.6 'omp_get_device_from_uid' - Obtain the device number to a unique id +------------------------------------------------------------------------- + +_Description_: + This function returns the device number associated with the passed + unique-identifier (UID) string. If no device with this UID is + available, the value 'omp_invalid_device' is returned. The effect + of running this routine in a 'target' region is unspecified. + + GCC treats the UID string case sensitive; for the initial device, + GCC currently only accepts the value 'OMP_INITIAL_DEVICE' and + returns for it the value of 'omp_initial_device'. + +_C/C++_: + _Prototype_: 'int omp_get_device_from_uid(const char *uid);' + +_Fortran_: + _Interface_: 'integer function omp_get_device_from_uid(uid)' + 'character(len=*), intent(in) :: uid' + +_See also_: + *note omp_get_uid_from_device::, *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v6.0 (https://www.openmp.org), Section 24.7 + + +File: libgomp.info, Node: omp_get_uid_from_device, Next: omp_is_initial_device, Prev: omp_get_device_from_uid, Up: Device Information Routines + +3.6.7 'omp_get_uid_from_device' - Obtain the unique id of a device +------------------------------------------------------------------ + +_Description_: + This function returns a pointer to a string that represents a + unique identifier (UID) for the device specified by DEVICE_NUM. It + returns a 'NULL' (C/C++) or a disassociated pointer (Fortran) for + 'omp_invalid_device'. The effect of running this routine in a + 'target' region is unspecified. + + GCC currently returns for initial device the value + 'OMP_INITIAL_DEVICE'. + +_C/C++_: + _Prototype_: 'const char *omp_get_uid_from_device(int device_num);' + +_Fortran_: + _Interface_: 'character(:) function + omp_get_uid_from_device(device_num)' + _Interface_: 'pointer :: omp_get_uid_from_device' + 'integer, intent(in) :: device_num' + +_See also_: + *note omp_get_uid_from_device::, *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v6.0 (https://www.openmp.org), Section 24.8 + + +File: libgomp.info, Node: omp_is_initial_device, Next: omp_get_initial_device, Prev: omp_get_uid_from_device, Up: Device Information Routines + +3.6.8 'omp_is_initial_device' - Whether executing on the host device +-------------------------------------------------------------------- + +_Description_: + This function returns 'true' if currently running on the host + device, 'false' otherwise. Here, 'true' and 'false' represent + their language-specific counterparts. + + Note that in GCC this function call is already folded to a constant + in the compiler; compile with '-fno-builtin-omp_is_initial_device' + if a run-time function is desired. + +_C/C++_: + _Prototype_: 'int omp_is_initial_device(void);' + +_Fortran_: + _Interface_: 'logical function omp_is_initial_device()' + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.34. + + +File: libgomp.info, Node: omp_get_initial_device, Prev: omp_is_initial_device, Up: Device Information Routines + +3.6.9 'omp_get_initial_device' - Return device number of initial device +----------------------------------------------------------------------- + +_Description_: + This function returns a device number that represents the host + device. Since OpenMP 5.1, this is equal to the value returned by + the 'omp_get_num_devices' function; since OpenMP 6.0 it may also + return the value of 'omp_initial_device'. + + The effect of running this routine in a 'target' region is + unspecified. + +_C/C++_ + _Prototype_: 'int omp_get_initial_device(void);' + +_Fortran_: + _Interface_: 'integer function omp_get_initial_device()' + +_See also_: + *note omp_get_num_devices:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.2.35. + + +File: libgomp.info, Node: Device Memory Routines, Next: Lock Routines, Prev: Device Information Routines, Up: Runtime Library Routines + +3.7 Device Memory Routines +========================== + +Routines related to memory allocation and managing corresponding +pointers on devices. They have C linkage and do not throw exceptions. + +* Menu: + +* omp_target_alloc:: Allocate device memory +* omp_target_free:: Free device memory +* omp_target_is_present:: Check whether storage is mapped +* omp_target_is_accessible:: Check whether memory is device accessible +* omp_target_memcpy:: Copy data between devices +* omp_target_memcpy_async:: Copy data between devices asynchronously +* omp_target_memcpy_rect:: Copy a subvolume of data between devices +* omp_target_memcpy_rect_async:: Copy a subvolume of data between devices asynchronously +* omp_target_associate_ptr:: Associate a device pointer with a host pointer +* omp_target_disassociate_ptr:: Remove device-host pointer association +* omp_get_mapped_ptr:: Return device pointer to a host pointer + + +File: libgomp.info, Node: omp_target_alloc, Next: omp_target_free, Up: Device Memory Routines + +3.7.1 'omp_target_alloc' - Allocate device memory +------------------------------------------------- + +_Description_: + This routine allocates SIZE bytes of memory in the device + environment associated with the device number DEVICE_NUM. If + successful, a device pointer is returned, otherwise a null pointer. + + In GCC, when the device is the host or the device shares memory + with the host, the memory is allocated on the host; in that case, + when SIZE is zero, either NULL or a unique pointer value that can + later be successfully passed to 'omp_target_free' is returned. + When the allocation is not performed on the host, a null pointer is + returned when SIZE is zero; in that case, additionally a diagnostic + might be printed to standard error (stderr). + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'void *omp_target_alloc(size_t size, int device_num)' + +_Fortran_: + _Interface_: 'type(c_ptr) function omp_target_alloc(size, device_num) + bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_int, + c_size_t' + 'integer(c_size_t), value :: size' + 'integer(c_int), value :: device_num' + +_See also_: + *note omp_target_free::, *note omp_target_associate_ptr:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.1 + + +File: libgomp.info, Node: omp_target_free, Next: omp_target_is_present, Prev: omp_target_alloc, Up: Device Memory Routines + +3.7.2 'omp_target_free' - Free device memory +-------------------------------------------- + +_Description_: + This routine frees memory allocated by the 'omp_target_alloc' + routine. The DEVICE_PTR argument must be either a null pointer or + a device pointer returned by 'omp_target_alloc' for the specified + 'device_num'. The device number DEVICE_NUM must be a conforming + device number. + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'void omp_target_free(void *device_ptr, int device_num)' + +_Fortran_: + _Interface_: 'subroutine omp_target_free(device_ptr, device_num) + bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_int' + 'type(c_ptr), value :: device_ptr' + 'integer(c_int), value :: device_num' + +_See also_: + *note omp_target_alloc::, *note omp_target_disassociate_ptr:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.2 + + +File: libgomp.info, Node: omp_target_is_present, Next: omp_target_is_accessible, Prev: omp_target_free, Up: Device Memory Routines + +3.7.3 'omp_target_is_present' - Check whether storage is mapped +--------------------------------------------------------------- + +_Description_: + This routine tests whether storage, identified by the host pointer + PTR is mapped to the device specified by DEVICE_NUM. If so, it + returns a nonzero value and otherwise zero. + + In GCC, this includes self mapping such that + 'omp_target_is_present' returns _true_ when DEVICE_NUM specifies + the host or when the host and the device share memory. If PTR is a + null pointer, TRUE is returned and if DEVICE_NUM is an invalid + device number, FALSE is returned. + + If those conditions do not apply, _true_ is returned if the + association has been established by an explicit or implicit 'map' + clause, the 'declare target' directive or a call to the + 'omp_target_associate_ptr' routine. + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'int omp_target_is_present(const void *ptr,' + ' int device_num)' + +_Fortran_: + _Interface_: 'integer(c_int) function omp_target_is_present(ptr, &' + ' device_num) bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_int' + 'type(c_ptr), value :: ptr' + 'integer(c_int), value :: device_num' + +_See also_: + *note omp_target_associate_ptr:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.3 + + +File: libgomp.info, Node: omp_target_is_accessible, Next: omp_target_memcpy, Prev: omp_target_is_present, Up: Device Memory Routines + +3.7.4 'omp_target_is_accessible' - Check whether memory is device accessible +---------------------------------------------------------------------------- + +_Description_: + This routine tests whether memory, starting at the address given by + PTR and extending SIZE bytes, is accessibly on the device specified + by DEVICE_NUM. If so, it returns a nonzero value and otherwise + zero. + + The address given by PTR is interpreted to be in the address space + of the device and SIZE must be positive. + + Note that GCC's current implementation assumes that PTR is a valid + host pointer. Therefore, all addresses given by PTR are assumed to + be accessible on the initial device. And, to err on the safe side, + this memory is only available on a non-host device that can access + all host memory ([uniform] shared memory access). + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'int omp_target_is_accessible(const void *ptr,' + ' size_t size,' + ' int device_num)' + +_Fortran_: + _Interface_: 'integer(c_int) function omp_target_is_accessible(ptr, + &' + ' size, device_num) bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_size_t, + c_int' + 'type(c_ptr), value :: ptr' + 'integer(c_size_t), value :: size' + 'integer(c_int), value :: device_num' + +_See also_: + *note omp_target_associate_ptr:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.4 + + +File: libgomp.info, Node: omp_target_memcpy, Next: omp_target_memcpy_async, Prev: omp_target_is_accessible, Up: Device Memory Routines + +3.7.5 'omp_target_memcpy' - Copy data between devices +----------------------------------------------------- + +_Description_: + This routine copies LENGTH of bytes of data from the device + identified by device number SRC_DEVICE_NUM to device + DST_DEVICE_NUM. The data is copied from the source device from the + address provided by SRC, shifted by the offset of SRC_OFFSET bytes, + to the destination device's DST address shifted by DST_OFFSET. The + routine returns zero on success and non-zero otherwise. + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'int omp_target_memcpy(void *dst,' + ' const void *src,' + ' size_t length,' + ' size_t dst_offset,' + ' size_t src_offset,' + ' int dst_device_num,' + ' int src_device_num)' + +_Fortran_: + _Interface_: 'integer(c_int) function omp_target_memcpy( &' + ' dst, src, length, dst_offset, src_offset, &' + ' dst_device_num, src_device_num) bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_size_t, + c_int' + 'type(c_ptr), value :: dst, src' + 'integer(c_size_t), value :: length, dst_offset, + src_offset' + 'integer(c_int), value :: dst_device_num, + src_device_num' + +_See also_: + *note omp_target_memcpy_async::, *note omp_target_memcpy_rect:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.5 + + +File: libgomp.info, Node: omp_target_memcpy_async, Next: omp_target_memcpy_rect, Prev: omp_target_memcpy, Up: Device Memory Routines + +3.7.6 'omp_target_memcpy_async' - Copy data between devices asynchronously +-------------------------------------------------------------------------- + +_Description_: + This routine copies asynchronously LENGTH of bytes of data from the + device identified by device number SRC_DEVICE_NUM to device + DST_DEVICE_NUM. The data is copied from the source device from the + address provided by SRC, shifted by the offset of SRC_OFFSET bytes, + to the destination device's DST address shifted by DST_OFFSET. + Task dependence is expressed by passing an array of depend objects + to DEPOBJ_LIST, where the number of array elements is passed as + DEPOBJ_COUNT; if the count is zero, the DEPOBJ_LIST argument is + ignored. In C++ and Fortran, the DEPOBJ_LIST argument can also be + omitted in that case. The routine returns zero if the copying + process has successfully been started and non-zero otherwise. + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'int omp_target_memcpy_async(void *dst,' + ' const void *src,' + ' size_t length,' + ' size_t dst_offset,' + ' size_t src_offset,' + ' int dst_device_num,' + ' int src_device_num,' + ' int depobj_count,' + ' omp_depend_t *depobj_list)' + +_Fortran_: + _Interface_: 'integer(c_int) function omp_target_memcpy_async( &' + ' dst, src, length, dst_offset, src_offset, &' + ' dst_device_num, src_device_num, &' + ' depobj_count, depobj_list) bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_size_t, + c_int' + 'type(c_ptr), value :: dst, src' + 'integer(c_size_t), value :: length, dst_offset, + src_offset' + 'integer(c_int), value :: dst_device_num, + src_device_num, depobj_count' + 'integer(omp_depend_kind), optional :: depobj_list(*)' + +_See also_: + *note omp_target_memcpy::, *note omp_target_memcpy_rect_async:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.7 + + +File: libgomp.info, Node: omp_target_memcpy_rect, Next: omp_target_memcpy_rect_async, Prev: omp_target_memcpy_async, Up: Device Memory Routines + +3.7.7 'omp_target_memcpy_rect' - Copy a subvolume of data between devices +------------------------------------------------------------------------- + +_Description_: + This routine copies a subvolume of data from the device identified + by device number SRC_DEVICE_NUM to device DST_DEVICE_NUM. The + array has NUM_DIMS dimensions and each array element has a size of + ELEMENT_SIZE bytes. The VOLUME array specifies how many elements + per dimension are copied. The full sizes of the destination and + source arrays are given by the DST_DIMENSIONS and SRC_DIMENSIONS + arguments, respectively. The offset per dimension to the first + element to be copied is given by the DST_OFFSET and SRC_OFFSET + arguments. The routine returns zero on success and non-zero + otherwise. + + The OpenMP specification only requires that NUM_DIMS up to three is + supported. In order to find implementation-specific maximally + supported number of dimensions, the routine returns this value when + invoked with a null pointer to both the DST and SRC arguments. As + GCC supports arbitrary dimensions, it returns 'INT_MAX'. + + The device-number arguments must be conforming device numbers, the + SRC and DST must be either both null pointers or all of the + following must be fulfilled: ELEMENT_SIZE and NUM_DIMS must be + positive and the VOLUME, offset and dimension arrays must have at + least NUM_DIMS dimensions. + + Running this routine in a 'target' region is not supported except + on the initial device. + +_C/C++_ + _Prototype_: 'int omp_target_memcpy_rect(void *dst,' + ' const void *src,' + ' size_t element_size,' + ' int num_dims,' + ' const size_t *volume,' + ' const size_t *dst_offset,' + ' const size_t *src_offset,' + ' const size_t *dst_dimensions,' + ' const size_t *src_dimensions,' + ' int dst_device_num,' + ' int src_device_num)' + +_Fortran_: + _Interface_: 'integer(c_int) function omp_target_memcpy_rect( &' + ' dst, src, element_size, num_dims, volume, &' + ' dst_offset, src_offset, dst_dimensions, &' + ' src_dimensions, dst_device_num, src_device_num) + bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_size_t, + c_int' + 'type(c_ptr), value :: dst, src' + 'integer(c_size_t), value :: element_size, dst_offset, + src_offset' + 'integer(c_size_t), value :: volume, dst_dimensions, + src_dimensions' + 'integer(c_int), value :: num_dims, dst_device_num, + src_device_num' + +_See also_: + *note omp_target_memcpy_rect_async::, *note omp_target_memcpy::, + *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.6 + + +File: libgomp.info, Node: omp_target_memcpy_rect_async, Next: omp_target_associate_ptr, Prev: omp_target_memcpy_rect, Up: Device Memory Routines + +3.7.8 'omp_target_memcpy_rect_async' - Copy a subvolume of data between devices asynchronously +---------------------------------------------------------------------------------------------- + +_Description_: + This routine copies asynchronously a subvolume of data from the + device identified by device number SRC_DEVICE_NUM to device + DST_DEVICE_NUM. The array has NUM_DIMS dimensions and each array + element has a size of ELEMENT_SIZE bytes. The VOLUME array + specifies how many elements per dimension are copied. The full + sizes of the destination and source arrays are given by the + DST_DIMENSIONS and SRC_DIMENSIONS arguments, respectively. The + offset per dimension to the first element to be copied is given by + the DST_OFFSET and SRC_OFFSET arguments. Task dependence is + expressed by passing an array of depend objects to DEPOBJ_LIST, + where the number of array elements is passed as DEPOBJ_COUNT; if + the count is zero, the DEPOBJ_LIST argument is ignored. In C++ and + Fortran, the DEPOBJ_LIST argument can also be omitted in that case. + The routine returns zero on success and non-zero otherwise. + + The OpenMP specification only requires that NUM_DIMS up to three is + supported. In order to find implementation-specific maximally + supported number of dimensions, the routine returns this value when + invoked with a null pointer to both the DST and SRC arguments. As + GCC supports arbitrary dimensions, it returns 'INT_MAX'. + + The device-number arguments must be conforming device numbers, the + SRC and DST must be either both null pointers or all of the + following must be fulfilled: ELEMENT_SIZE and NUM_DIMS must be + positive and the VOLUME, offset and dimension arrays must have at + least NUM_DIMS dimensions. + + Running this routine in a 'target' region is not supported except + on the initial device. + +_C/C++_ + _Prototype_: 'int omp_target_memcpy_rect_async(void *dst,' + ' const void *src,' + ' size_t element_size,' + ' int num_dims,' + ' const size_t *volume,' + ' const size_t *dst_offset,' + ' const size_t *src_offset,' + ' const size_t *dst_dimensions,' + ' const size_t *src_dimensions,' + ' int dst_device_num,' + ' int src_device_num,' + ' int depobj_count,' + ' omp_depend_t *depobj_list)' + +_Fortran_: + _Interface_: 'integer(c_int) function omp_target_memcpy_rect_async( + &' + ' dst, src, element_size, num_dims, volume, &' + ' dst_offset, src_offset, dst_dimensions, &' + ' src_dimensions, dst_device_num, src_device_num, &' + ' depobj_count, depobj_list) bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_size_t, + c_int' + 'type(c_ptr), value :: dst, src' + 'integer(c_size_t), value :: element_size, dst_offset, + src_offset' + 'integer(c_size_t), value :: volume, dst_dimensions, + src_dimensions' + 'integer(c_int), value :: num_dims, dst_device_num, + src_device_num' + 'integer(c_int), value :: depobj_count' + 'integer(omp_depend_kind), optional :: depobj_list(*)' + +_See also_: + *note omp_target_memcpy_rect::, *note omp_target_memcpy_async::, + *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.8 + + +File: libgomp.info, Node: omp_target_associate_ptr, Next: omp_target_disassociate_ptr, Prev: omp_target_memcpy_rect_async, Up: Device Memory Routines + +3.7.9 'omp_target_associate_ptr' - Associate a device pointer with a host pointer +--------------------------------------------------------------------------------- + +_Description_: + This routine associates storage on the host with storage on a + device identified by DEVICE_NUM. The device pointer is usually + obtained by calling 'omp_target_alloc' or by other means (but not + by using the 'map' clauses or the 'declare target' directive). The + host pointer should point to memory that has a storage size of at + least SIZE. + + The DEVICE_OFFSET parameter specifies the offset into DEVICE_PTR + that is used as the base address for the device side of the + mapping; the storage size should be at least DEVICE_OFFSET plus + SIZE. + + After the association, the host pointer can be used in a 'map' + clause and in the 'to' and 'from' clauses of the 'target update' + directive to transfer data between the associated pointers. The + reference count of such associated storage is infinite. The + association can be removed by calling 'omp_target_disassociate_ptr' + which should be done before the lifetime of either storage ends. + + The routine returns nonzero ('EINVAL') when the DEVICE_NUM invalid, + for when the initial device or the associated device shares memory + with the host. 'omp_target_associate_ptr' returns zero if HOST_PTR + points into already associated storage that is fully inside of a + previously associated memory. Otherwise, if the association was + successful zero is returned; if none of the cases above apply, + nonzero ('EINVAL') is returned. + + The 'omp_target_is_present' routine can be used to test whether + associated storage for a device pointer exists. + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'int omp_target_associate_ptr(const void *host_ptr,' + ' const void *device_ptr,' + ' size_t size,' + ' size_t device_offset,' + ' int device_num)' + +_Fortran_: + _Interface_: 'integer(c_int) function + omp_target_associate_ptr(host_ptr, &' + ' device_ptr, size, device_offset, device_num) bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_int, + c_size_t' + 'type(c_ptr), value :: host_ptr, device_ptr' + 'integer(c_size_t), value :: size, device_offset' + 'integer(c_int), value :: device_num' + +_See also_: + *note omp_target_disassociate_ptr::, *note omp_target_is_present::, + *note omp_target_alloc:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.9 + + +File: libgomp.info, Node: omp_target_disassociate_ptr, Next: omp_get_mapped_ptr, Prev: omp_target_associate_ptr, Up: Device Memory Routines + +3.7.10 'omp_target_disassociate_ptr' - Remove device-host pointer association +----------------------------------------------------------------------------- + +_Description_: + This routine removes the storage association established by calling + 'omp_target_associate_ptr' and sets the reference count to zero, + even if 'omp_target_associate_ptr' was invoked multiple times for + for host pointer 'ptr'. If applicable, the device memory needs to + be freed by the user. + + If an associated device storage location for the DEVICE_NUM was + found and has infinite reference count, the association is removed + and zero is returned. In all other cases, nonzero ('EINVAL') is + returned and no other action is taken. + + Note that passing a host pointer where the association to the + device pointer was established with the 'declare target' directive + yields undefined behavior. + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'int omp_target_disassociate_ptr(const void *ptr,' + ' int device_num)' + +_Fortran_: + _Interface_: 'integer(c_int) function + omp_target_disassociate_ptr(ptr, &' + ' device_num) bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_int' + 'type(c_ptr), value :: ptr' + 'integer(c_int), value :: device_num' + +_See also_: + *note omp_target_associate_ptr:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.10 + + +File: libgomp.info, Node: omp_get_mapped_ptr, Prev: omp_target_disassociate_ptr, Up: Device Memory Routines + +3.7.11 'omp_get_mapped_ptr' - Return device pointer to a host pointer +--------------------------------------------------------------------- + +_Description_: + If the device number is refers to the initial device or to a device + with memory accessible from the host (shared memory), the + 'omp_get_mapped_ptr' routines returns the value of the passed PTR. + Otherwise, if associated storage to the passed host pointer PTR + exists on device associated with DEVICE_NUM, it returns that + pointer. In all other cases and in cases of an error, a null + pointer is returned. + + The association of storage location is established either via an + explicit or implicit 'map' clause, the 'declare target' directive + or the 'omp_target_associate_ptr' routine. + + Running this routine in a 'target' region except on the initial + device is not supported. + +_C/C++_ + _Prototype_: 'void *omp_get_mapped_ptr(const void *ptr, int + device_num);' + +_Fortran_: + _Interface_: 'type(c_ptr) function omp_get_mapped_ptr(ptr, + device_num) bind(C)' + 'use, intrinsic :: iso_c_binding, only: c_ptr, c_int' + 'type(c_ptr), value :: ptr' + 'integer(c_int), value :: device_num' + +_See also_: + *note omp_target_associate_ptr:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.8.11 + + +File: libgomp.info, Node: Lock Routines, Next: Timing Routines, Prev: Device Memory Routines, Up: Runtime Library Routines + +3.8 Lock Routines +================= + +Initialize, set, test, unset and destroy simple and nested locks. The +routines have C linkage and do not throw exceptions. + +* Menu: + +* omp_init_lock:: Initialize simple lock +* omp_init_nest_lock:: Initialize nested lock +* omp_destroy_lock:: Destroy simple lock +* omp_destroy_nest_lock:: Destroy nested lock +* omp_set_lock:: Wait for and set simple lock +* omp_set_nest_lock:: Wait for and set simple lock +* omp_unset_lock:: Unset simple lock +* omp_unset_nest_lock:: Unset nested lock +* omp_test_lock:: Test and set simple lock if available +* omp_test_nest_lock:: Test and set nested lock if available + + +File: libgomp.info, Node: omp_init_lock, Next: omp_init_nest_lock, Up: Lock Routines + +3.8.1 'omp_init_lock' - Initialize simple lock +---------------------------------------------- + +_Description_: + Initialize a simple lock. After initialization, the lock is in an + unlocked state. + +_C/C++_: + _Prototype_: 'void omp_init_lock(omp_lock_t *lock);' + +_Fortran_: + _Interface_: 'subroutine omp_init_lock(svar)' + 'integer(omp_lock_kind), intent(out) :: svar' + +_See also_: + *note omp_destroy_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.1. + + +File: libgomp.info, Node: omp_init_nest_lock, Next: omp_destroy_lock, Prev: omp_init_lock, Up: Lock Routines + +3.8.2 'omp_init_nest_lock' - Initialize nested lock +--------------------------------------------------- + +_Description_: + Initialize a nested lock. After initialization, the lock is in an + unlocked state and the nesting count is set to zero. + +_C/C++_: + _Prototype_: 'void omp_init_nest_lock(omp_nest_lock_t *lock);' + +_Fortran_: + _Interface_: 'subroutine omp_init_nest_lock(nvar)' + 'integer(omp_nest_lock_kind), intent(out) :: nvar' + +_See also_: + *note omp_destroy_nest_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.1. + + +File: libgomp.info, Node: omp_destroy_lock, Next: omp_destroy_nest_lock, Prev: omp_init_nest_lock, Up: Lock Routines + +3.8.3 'omp_destroy_lock' - Destroy simple lock +---------------------------------------------- + +_Description_: + Destroy a simple lock. In order to be destroyed, a simple lock + must be in the unlocked state. + +_C/C++_: + _Prototype_: 'void omp_destroy_lock(omp_lock_t *lock);' + +_Fortran_: + _Interface_: 'subroutine omp_destroy_lock(svar)' + 'integer(omp_lock_kind), intent(inout) :: svar' + +_See also_: + *note omp_init_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.3. + + +File: libgomp.info, Node: omp_destroy_nest_lock, Next: omp_set_lock, Prev: omp_destroy_lock, Up: Lock Routines + +3.8.4 'omp_destroy_nest_lock' - Destroy nested lock +--------------------------------------------------- + +_Description_: + Destroy a nested lock. In order to be destroyed, a nested lock + must be in the unlocked state and its nesting count must equal + zero. + +_C/C++_: + _Prototype_: 'void omp_destroy_nest_lock(omp_nest_lock_t *);' + +_Fortran_: + _Interface_: 'subroutine omp_destroy_nest_lock(nvar)' + 'integer(omp_nest_lock_kind), intent(inout) :: nvar' + +_See also_: + *note omp_init_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.3. + + +File: libgomp.info, Node: omp_set_lock, Next: omp_set_nest_lock, Prev: omp_destroy_nest_lock, Up: Lock Routines + +3.8.5 'omp_set_lock' - Wait for and set simple lock +--------------------------------------------------- + +_Description_: + Before setting a simple lock, the lock variable must be initialized + by 'omp_init_lock'. The calling thread is blocked until the lock + is available. If the lock is already held by the current thread, a + deadlock occurs. + +_C/C++_: + _Prototype_: 'void omp_set_lock(omp_lock_t *lock);' + +_Fortran_: + _Interface_: 'subroutine omp_set_lock(svar)' + 'integer(omp_lock_kind), intent(inout) :: svar' + +_See also_: + *note omp_init_lock::, *note omp_test_lock::, *note + omp_unset_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.4. + + +File: libgomp.info, Node: omp_set_nest_lock, Next: omp_unset_lock, Prev: omp_set_lock, Up: Lock Routines + +3.8.6 'omp_set_nest_lock' - Wait for and set nested lock +-------------------------------------------------------- + +_Description_: + Before setting a nested lock, the lock variable must be initialized + by 'omp_init_nest_lock'. The calling thread is blocked until the + lock is available. If the lock is already held by the current + thread, the nesting count for the lock is incremented. + +_C/C++_: + _Prototype_: 'void omp_set_nest_lock(omp_nest_lock_t *lock);' + +_Fortran_: + _Interface_: 'subroutine omp_set_nest_lock(nvar)' + 'integer(omp_nest_lock_kind), intent(inout) :: nvar' + +_See also_: + *note omp_init_nest_lock::, *note omp_unset_nest_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.4. + + +File: libgomp.info, Node: omp_unset_lock, Next: omp_unset_nest_lock, Prev: omp_set_nest_lock, Up: Lock Routines + +3.8.7 'omp_unset_lock' - Unset simple lock +------------------------------------------ + +_Description_: + A simple lock about to be unset must have been locked by + 'omp_set_lock' or 'omp_test_lock' before. In addition, the lock + must be held by the thread calling 'omp_unset_lock'. Then, the + lock becomes unlocked. If one or more threads attempted to set the + lock before, one of them is chosen to, again, set the lock to + itself. + +_C/C++_: + _Prototype_: 'void omp_unset_lock(omp_lock_t *lock);' + +_Fortran_: + _Interface_: 'subroutine omp_unset_lock(svar)' + 'integer(omp_lock_kind), intent(inout) :: svar' + +_See also_: + *note omp_set_lock::, *note omp_test_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.5. + + +File: libgomp.info, Node: omp_unset_nest_lock, Next: omp_test_lock, Prev: omp_unset_lock, Up: Lock Routines + +3.8.8 'omp_unset_nest_lock' - Unset nested lock +----------------------------------------------- + +_Description_: + A nested lock about to be unset must have been locked by + 'omp_set_nested_lock' or 'omp_test_nested_lock' before. In + addition, the lock must be held by the thread calling + 'omp_unset_nested_lock'. If the nesting count drops to zero, the + lock becomes unlocked. If one ore more threads attempted to set + the lock before, one of them is chosen to, again, set the lock to + itself. + +_C/C++_: + _Prototype_: 'void omp_unset_nest_lock(omp_nest_lock_t *lock);' + +_Fortran_: + _Interface_: 'subroutine omp_unset_nest_lock(nvar)' + 'integer(omp_nest_lock_kind), intent(inout) :: nvar' + +_See also_: + *note omp_set_nest_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.5. + + +File: libgomp.info, Node: omp_test_lock, Next: omp_test_nest_lock, Prev: omp_unset_nest_lock, Up: Lock Routines + +3.8.9 'omp_test_lock' - Test and set simple lock if available +------------------------------------------------------------- + +_Description_: + Before setting a simple lock, the lock variable must be initialized + by 'omp_init_lock'. Contrary to 'omp_set_lock', 'omp_test_lock' + does not block if the lock is not available. This function returns + 'true' upon success, 'false' otherwise. Here, 'true' and 'false' + represent their language-specific counterparts. + +_C/C++_: + _Prototype_: 'int omp_test_lock(omp_lock_t *lock);' + +_Fortran_: + _Interface_: 'logical function omp_test_lock(svar)' + 'integer(omp_lock_kind), intent(inout) :: svar' + +_See also_: + *note omp_init_lock::, *note omp_set_lock::, *note omp_set_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.6. + + +File: libgomp.info, Node: omp_test_nest_lock, Prev: omp_test_lock, Up: Lock Routines + +3.8.10 'omp_test_nest_lock' - Test and set nested lock if available +------------------------------------------------------------------- + +_Description_: + Before setting a nested lock, the lock variable must be initialized + by 'omp_init_nest_lock'. Contrary to 'omp_set_nest_lock', + 'omp_test_nest_lock' does not block if the lock is not available. + If the lock is already held by the current thread, the new nesting + count is returned. Otherwise, the return value equals zero. + +_C/C++_: + _Prototype_: 'int omp_test_nest_lock(omp_nest_lock_t *lock);' + +_Fortran_: + _Interface_: 'logical function omp_test_nest_lock(nvar)' + 'integer(omp_nest_lock_kind), intent(inout) :: nvar' + +_See also_: + *note omp_init_lock::, *note omp_set_lock::, *note omp_set_lock:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.3.6. + + +File: libgomp.info, Node: Timing Routines, Next: Event Routine, Prev: Lock Routines, Up: Runtime Library Routines + +3.9 Timing Routines +=================== + +Portable, thread-based, wall clock timer. The routines have C linkage +and do not throw exceptions. + +* Menu: + +* omp_get_wtick:: Get timer precision. +* omp_get_wtime:: Elapsed wall clock time. + + +File: libgomp.info, Node: omp_get_wtick, Next: omp_get_wtime, Up: Timing Routines + +3.9.1 'omp_get_wtick' - Get timer precision +------------------------------------------- + +_Description_: + Gets the timer precision, i.e., the number of seconds between two + successive clock ticks. + +_C/C++_: + _Prototype_: 'double omp_get_wtick(void);' + +_Fortran_: + _Interface_: 'double precision function omp_get_wtick()' + +_See also_: + *note omp_get_wtime:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.4.2. + + +File: libgomp.info, Node: omp_get_wtime, Prev: omp_get_wtick, Up: Timing Routines + +3.9.2 'omp_get_wtime' - Elapsed wall clock time +----------------------------------------------- + +_Description_: + Elapsed wall clock time in seconds. The time is measured per + thread, no guarantee can be made that two distinct threads measure + the same time. Time is measured from some "time in the past", + which is an arbitrary time guaranteed not to change during the + execution of the program. + +_C/C++_: + _Prototype_: 'double omp_get_wtime(void);' + +_Fortran_: + _Interface_: 'double precision function omp_get_wtime()' + +_See also_: + *note omp_get_wtick:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 3.4.1. + + +File: libgomp.info, Node: Event Routine, Next: Interoperability Routines, Prev: Timing Routines, Up: Runtime Library Routines + +3.10 Event Routine +================== + +Support for event objects. The routine has C linkage and do not throw +exceptions. + +* Menu: + +* omp_fulfill_event:: Fulfill and destroy an OpenMP event. + + +File: libgomp.info, Node: omp_fulfill_event, Up: Event Routine + +3.10.1 'omp_fulfill_event' - Fulfill and destroy an OpenMP event +---------------------------------------------------------------- + +_Description_: + Fulfill the event associated with the event handle argument. + Currently, it is only used to fulfill events generated by detach + clauses on task constructs - the effect of fulfilling the event is + to allow the task to complete. + + The result of calling 'omp_fulfill_event' with an event handle + other than that generated by a detach clause is undefined. Calling + it with an event handle that has already been fulfilled is also + undefined. + +_C/C++_: + _Prototype_: 'void omp_fulfill_event(omp_event_handle_t event);' + +_Fortran_: + _Interface_: 'subroutine omp_fulfill_event(event)' + 'integer (kind=omp_event_handle_kind) :: event' + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.5.1. + + +File: libgomp.info, Node: Interoperability Routines, Next: Memory Management Routines, Prev: Event Routine, Up: Runtime Library Routines + +3.11 Interoperability Routines +============================== + +Routines to obtain properties from an object of OpenMP interop type. +They have C linkage and do not throw exceptions. + +* Menu: + +* omp_get_num_interop_properties:: Get the number of implementation-specific properties +* omp_get_interop_int:: Obtain integer-valued interoperability property +* omp_get_interop_ptr:: Obtain pointer-valued interoperability property +* omp_get_interop_str:: Obtain string-valued interoperability property +* omp_get_interop_name:: Obtain the name of an interop_property value as string +* omp_get_interop_type_desc:: Obtain type and description to an interop_property +* omp_get_interop_rc_desc:: Obtain error string to an interop_rc error code + + +File: libgomp.info, Node: omp_get_num_interop_properties, Next: omp_get_interop_int, Up: Interoperability Routines + +3.11.1 'omp_get_num_interop_properties' - Get the number of implementation-specific properties +---------------------------------------------------------------------------------------------- + +_Description_: + The 'omp_get_num_interop_properties' function returns the number of + implementation-defined interoperability properties available for + the passed INTEROP, extending the OpenMP-defined properties. The + available OpenMP interop_property-type values range from + 'omp_ipr_first' to the value returned by + 'omp_get_num_interop_properties' minus one. + + No implementation-defined properties are currently defined in GCC. + +_C/C++_: + _Prototype_: 'int omp_get_num_interop_properties(const omp_interop_t + interop)' + +_Fortran_: + _Interface_: 'integer function + omp_get_num_interop_properties(interop)' + 'integer(omp_interop_kind), intent(in) :: interop' + +_See also_: + *note omp_get_interop_name::, *note omp_get_interop_type_desc:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.12.1, + OpenMP specification v6.0 (https://www.openmp.org), Section 26.1 + + +File: libgomp.info, Node: omp_get_interop_int, Next: omp_get_interop_ptr, Prev: omp_get_num_interop_properties, Up: Interoperability Routines + +3.11.2 'omp_get_interop_int' - Obtain integer-valued interoperability property +------------------------------------------------------------------------------ + +_Description_: + The 'omp_get_interop_int' function returns the integer value + associated with the PROPERTY_ID interoperability property of the + passed INTEROP object. The RET_CODE argument is optional, i.e. it + can be omitted in C++ and Fortran or used with 'NULL' as argument + in C and C++. If successful, RET_CODE (if present) is set to + 'omp_irc_success'. + + In GCC, the effect of running this routine in a 'target' region + that is not the initial device is unspecified. + +_C/C++_: + _Prototype_: 'omp_intptr_t omp_get_interop_int(const omp_interop_t + interop, omp_interop_property_t property_id, + omp_interop_rc_t *ret_code)' + +_Fortran_: + _Interface_: 'integer(c_intptr_t) function + omp_get_interop_int(interop, property_id, ret_code)' + 'use, intrinsic :: iso_c_binding, only : c_intptr_t' + 'integer(omp_interop_kind), intent(in) :: interop' + 'integer(omp_interop_property_kind) property_id' + 'integer(omp_interop_rc_kind), optional, intent(out) :: + ret_code' + +_See also_: + *note omp_get_interop_ptr::, *note omp_get_interop_str::, *note + omp_get_interop_rc_desc::, *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.12.2, + OpenMP specification v6.0 (https://www.openmp.org), Section 26.2 + + +File: libgomp.info, Node: omp_get_interop_ptr, Next: omp_get_interop_str, Prev: omp_get_interop_int, Up: Interoperability Routines + +3.11.3 'omp_get_interop_ptr' - Obtain pointer-valued interoperability property +------------------------------------------------------------------------------ + +_Description_: + The 'omp_get_interop_int' function returns the pointer value + associated with the PROPERTY_ID interoperability property of the + passed INTEROP object. The RET_CODE argument is optional, i.e. it + can be omitted in C++ and Fortran or used with 'NULL' as argument + in C and C++. If successful, RET_CODE (if present) is set to + 'omp_irc_success'. + + In GCC, the effect of running this routine in a 'target' region + that is not the initial device is unspecified. + +_C/C++_: + _Prototype_: 'void *omp_get_interop_ptr(const omp_interop_t interop, + omp_interop_property_t property_id, omp_interop_rc_t + *ret_code)' + +_Fortran_: + _Interface_: 'type(c_ptr) function omp_get_interop_int(interop, + property_id, ret_code)' + 'use, intrinsic :: iso_c_binding, only : c_ptr' + 'integer(omp_interop_kind), intent(in) :: interop' + 'integer(omp_interop_property_kind) property_id' + 'integer(omp_interop_rc_kind), optional, intent(out) :: + ret_code' + +_See also_: + *note omp_get_interop_int::, *note omp_get_interop_str::, *note + omp_get_interop_rc_desc::, *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.12.3, + OpenMP specification v6.0 (https://www.openmp.org), Section 26.3 + + +File: libgomp.info, Node: omp_get_interop_str, Next: omp_get_interop_name, Prev: omp_get_interop_ptr, Up: Interoperability Routines + +3.11.4 'omp_get_interop_str' - Obtain string-valued interoperability property +----------------------------------------------------------------------------- + +_Description_: + The 'omp_get_interop_str' function returns the string value + associated with the PROPERTY_ID interoperability property of the + passed INTEROP object. The RET_CODE argument is optional, i.e. it + can be omitted in C++ and Fortran or used with 'NULL' as argument + in C and C++. If successful, RET_CODE (if present) is set to + 'omp_irc_success'. + + In GCC, the effect of running this routine in a 'target' region + that is not the initial device is unspecified. + +_C/C++_: + _Prototype_: 'const char *omp_get_interop_str(const omp_interop_t + interop, omp_interop_property_t property_id, + omp_interop_rc_t *ret_code)' + +_Fortran_: + _Interface_: 'character(:) function omp_get_interop_str(interop, + property_id, ret_code)' + 'pointer :: omp_get_interop_str' + 'integer(omp_interop_kind), intent(in) :: interop' + 'integer(omp_interop_property_kind) property_id' + 'integer(omp_interop_rc_kind), optional, intent(out) :: + ret_code' + +_See also_: + *note omp_get_interop_int::, *note omp_get_interop_ptr::, *note + omp_get_interop_rc_desc::, *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.12.4, + OpenMP specification v6.0 (https://www.openmp.org), Section 26.4 + + +File: libgomp.info, Node: omp_get_interop_name, Next: omp_get_interop_type_desc, Prev: omp_get_interop_str, Up: Interoperability Routines + +3.11.5 'omp_get_interop_name' - Obtain the name of an 'interop_property' value as string +---------------------------------------------------------------------------------------- + +_Description_: + The 'omp_get_interop_name' function returns the name of the + property itself as string; for the properties specified by the + OpenMP specification, the name matches the name of the named + constant with the 'omp_ipr_' prefix removed. + +_C/C++_: + _Prototype_: 'const char *omp_get_interop_name(const omp_interop_t + interop, omp_interop_property_t property_id)' + +_Fortran_: + _Interface_: 'character(:) function omp_get_interop_name(interop, + property_id)' + 'pointer :: omp_get_interop_name' + 'integer(omp_interop_kind), intent(in) :: interop' + 'integer(omp_interop_property_kind) property_id' + +_See also_: + *note omp_get_num_interop_properties::, *note + omp_get_interop_type_desc:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.12.5, + OpenMP specification v6.0 (https://www.openmp.org), Section 26.5 + + +File: libgomp.info, Node: omp_get_interop_type_desc, Next: omp_get_interop_rc_desc, Prev: omp_get_interop_name, Up: Interoperability Routines + +3.11.6 'omp_get_interop_type_desc' - Obtain type and description to an 'interop_property' +----------------------------------------------------------------------------------------- + +_Description_: + The 'omp_get_interop_type_desc' function returns a string that + describes in human-readable form the data type associated with the + PROPERTY_ID interoperability property of the passed INTEROP object. + + In GCC, this function returns the name of the C/C++ data type for + this property or 'N/A' if this property is not available for the + given foreign runtime. If INTEROP is 'omp_interop_none' or for + invalid property values, a null pointer is returned. The effect of + running this routine in a 'target' region that is not the initial + device is unspecified. + +_C/C++_: + _Prototype_: 'const char *omp_get_interop_type_desc(const + omp_interop_t interop, omp_interop_property_t + property_id)' + +_Fortran_: + _Interface_: 'character(:) function + omp_get_interop_type_desc(interop, property_id)' + 'pointer :: omp_get_interop_type_desc' + 'integer(omp_interop_kind), intent(in) :: interop' + 'integer(omp_interop_property_kind) property_id' + +_See also_: + *note omp_get_num_interop_properties::, *note + omp_get_interop_name::, *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.12.6, + OpenMP specification v6.0 (https://www.openmp.org), Section 26.6 + + +File: libgomp.info, Node: omp_get_interop_rc_desc, Prev: omp_get_interop_type_desc, Up: Interoperability Routines + +3.11.7 'omp_get_interop_rc_desc' - Obtain error string to an 'interop_rc' error code +------------------------------------------------------------------------------------ + +_Description_: + The 'omp_get_interop_rc_desc' function returns a string value + describing the RET_CODE in human-readable form. + + The behavior is unspecified if value of RET_CODE was not set by an + interoperability routine invoked for INTEROP. + +_C/C++_: + _Prototype_: 'const char *omp_get_interop_rc_desc(const omp_interop_t + interop, omp_interop_rc_t ret_code)' + +_Fortran_: + _Interface_: 'character(:) function omp_get_interop_rc_desc(interop, + property_id, ret_code)' + 'pointer :: omp_get_interop_rc_desc' + 'integer(omp_interop_kind), intent(in) :: interop' + 'integer (omp_interop_rc_kind) ret_code' + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.12.7, + OpenMP specification v6.0 (https://www.openmp.org), Section 26.7 + + +File: libgomp.info, Node: Memory Management Routines, Next: Environment Display Routine, Prev: Interoperability Routines, Up: Runtime Library Routines + +3.12 Memory Management Routines +=============================== + +Routines to manage and allocate memory on the current device. They have +C linkage and do not throw exceptions. + +* Menu: + +* omp_init_allocator:: Create an allocator +* omp_destroy_allocator:: Destroy an allocator +* omp_set_default_allocator:: Set the default allocator +* omp_get_default_allocator:: Get the default allocator +* omp_alloc:: Memory allocation with an allocator +* omp_aligned_alloc:: Memory allocation with an allocator and alignment +* omp_free:: Freeing memory allocated with OpenMP routines +* omp_calloc:: Allocate nullified memory with an allocator +* omp_aligned_calloc:: Allocate nullified aligned memory with an allocator +* omp_realloc:: Reallocate memory allocated with OpenMP routines + + +File: libgomp.info, Node: omp_init_allocator, Next: omp_destroy_allocator, Up: Memory Management Routines + +3.12.1 'omp_init_allocator' - Create an allocator +------------------------------------------------- + +_Description_: + Create an allocator that uses the specified memory space and has + the specified traits; if an allocator that fulfills the + requirements cannot be created, 'omp_null_allocator' is returned. + + The predefined memory spaces and available traits can be found at + *note Memory allocation::, where the trait names have to be + prefixed by 'omp_atk_' (e.g. 'omp_atk_pinned') and the named trait + values by 'omp_atv_' (e.g. 'omp_atv_true'); additionally, + 'omp_atv_default' may be used as trait value to specify that the + default value should be used. + +_C/C++_: + _Prototype_: 'omp_allocator_handle_t omp_init_allocator(' + ' omp_memspace_handle_t memspace,' + ' int ntraits,' + ' const omp_alloctrait_t traits[]);' + +_Fortran_: + _Interface_: 'function omp_init_allocator(memspace, ntraits, traits)' + 'integer (omp_allocator_handle_kind) :: + omp_init_allocator' + 'integer (omp_memspace_handle_kind), intent(in) :: + memspace' + 'integer, intent(in) :: ntraits' + 'type (omp_alloctrait), intent(in) :: traits(*)' + +_See also_: + *note Memory allocation::, *note OMP_ALLOCATOR::, *note + omp_destroy_allocator:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.7.2 + + +File: libgomp.info, Node: omp_destroy_allocator, Next: omp_set_default_allocator, Prev: omp_init_allocator, Up: Memory Management Routines + +3.12.2 'omp_destroy_allocator' - Destroy an allocator +----------------------------------------------------- + +_Description_: + Releases all resources used by a memory allocator, which must not + represent a predefined memory allocator. Accessing memory after + its allocator has been destroyed has unspecified behavior. Passing + 'omp_null_allocator' to the routine is permitted but has no effect. + +_C/C++_: + _Prototype_: 'void omp_destroy_allocator (omp_allocator_handle_t + allocator);' + +_Fortran_: + _Interface_: 'subroutine omp_destroy_allocator(allocator)' + 'integer (omp_allocator_handle_kind), intent(in) :: + allocator' + +_See also_: + *note omp_init_allocator:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.7.3 + + +File: libgomp.info, Node: omp_set_default_allocator, Next: omp_get_default_allocator, Prev: omp_destroy_allocator, Up: Memory Management Routines + +3.12.3 'omp_set_default_allocator' - Set the default allocator +-------------------------------------------------------------- + +_Description_: + Sets the default allocator that is used when no allocator has been + specified in the 'allocate' or 'allocator' clause or if an OpenMP + memory routine is invoked with the 'omp_null_allocator' allocator. + +_C/C++_: + _Prototype_: 'void omp_set_default_allocator(omp_allocator_handle_t + allocator);' + +_Fortran_: + _Interface_: 'subroutine omp_set_default_allocator(allocator)' + 'integer (omp_allocator_handle_kind), intent(in) :: + allocator' + +_See also_: + *note omp_get_default_allocator::, *note omp_init_allocator::, + *note OMP_ALLOCATOR::, *note Memory allocation:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.7.4 + + +File: libgomp.info, Node: omp_get_default_allocator, Next: omp_alloc, Prev: omp_set_default_allocator, Up: Memory Management Routines + +3.12.4 'omp_get_default_allocator' - Get the default allocator +-------------------------------------------------------------- + +_Description_: + The routine returns the default allocator that is used when no + allocator has been specified in the 'allocate' or 'allocator' + clause or if an OpenMP memory routine is invoked with the + 'omp_null_allocator' allocator. + +_C/C++_: + _Prototype_: 'omp_allocator_handle_t omp_get_default_allocator();' + +_Fortran_: + _Interface_: 'function omp_get_default_allocator()' + 'integer (omp_allocator_handle_kind) :: + omp_get_default_allocator' + +_See also_: + *note omp_set_default_allocator::, *note OMP_ALLOCATOR:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.7.5 + + +File: libgomp.info, Node: omp_alloc, Next: omp_aligned_alloc, Prev: omp_get_default_allocator, Up: Memory Management Routines + +3.12.5 'omp_alloc' - Memory allocation with an allocator +-------------------------------------------------------- + +_Description_: + Allocate memory with the specified allocator, which can either be a + predefined allocator, an allocator handle or 'omp_null_allocator'. + If the allocators is 'omp_null_allocator', the allocator specified + by the DEF-ALLOCATOR-VAR ICV is used. SIZE must be a nonnegative + number denoting the number of bytes to be allocated; if SIZE is + zero, 'omp_alloc' will return a null pointer. If successful, a + pointer to the allocated memory is returned, otherwise the + 'fallback' trait of the allocator determines the behavior. The + content of the allocated memory is unspecified. + + In 'target' regions, either the 'dynamic_allocators' clause must + appear on a 'requires' directive in the same compilation unit - or + the ALLOCATOR argument may only be a constant expression with the + value of one of the predefined allocators and may not be + 'omp_null_allocator'. + + Memory allocated by 'omp_alloc' must be freed using 'omp_free'. + +_C_: + _Prototype_: 'void* omp_alloc(size_t size,' + ' omp_allocator_handle_t allocator)' + +_C++_: + _Prototype_: 'void* omp_alloc(size_t size,' + ' omp_allocator_handle_t allocator=omp_null_allocator)' + +_Fortran_: + _Interface_: 'type(c_ptr) function omp_alloc(size, allocator) + bind(C)' + 'use, intrinsic :: iso_c_binding, only : c_ptr, + c_size_t' + 'integer (c_size_t), value :: size' + 'integer (omp_allocator_handle_kind), value :: + allocator' + +_See also_: + *note OMP_ALLOCATOR::, *note Memory allocation::, *note + omp_set_default_allocator::, *note omp_free::, *note + omp_init_allocator:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.7.6 + + +File: libgomp.info, Node: omp_aligned_alloc, Next: omp_free, Prev: omp_alloc, Up: Memory Management Routines + +3.12.6 'omp_aligned_alloc' - Memory allocation with an allocator and alignment +------------------------------------------------------------------------------ + +_Description_: + Allocate memory with the specified allocator, which can either be a + predefined allocator, an allocator handle or 'omp_null_allocator'. + If the allocators is 'omp_null_allocator', the allocator specified + by the DEF-ALLOCATOR-VAR ICV is used. ALIGNMENT must be a positive + power of two and SIZE must be a nonnegative number that is a + multiple of the alignment and denotes the number of bytes to be + allocated; if SIZE is zero, 'omp_aligned_alloc' will return a null + pointer. The alignment will be at least the maximal value required + by 'alignment' trait of the allocator and the value of the passed + ALIGNMENT argument. If successful, a pointer to the allocated + memory is returned, otherwise the 'fallback' trait of the allocator + determines the behavior. The content of the allocated memory is + unspecified. + + In 'target' regions, either the 'dynamic_allocators' clause must + appear on a 'requires' directive in the same compilation unit - or + the ALLOCATOR argument may only be a constant expression with the + value of one of the predefined allocators and may not be + 'omp_null_allocator'. + + Memory allocated by 'omp_aligned_alloc' must be freed using + 'omp_free'. + +_C_: + _Prototype_: 'void* omp_aligned_alloc(size_t alignment,' + ' size_t size,' + ' omp_allocator_handle_t allocator)' + +_C++_: + _Prototype_: 'void* omp_aligned_alloc(size_t alignment,' + ' size_t size,' + ' omp_allocator_handle_t allocator=omp_null_allocator)' + +_Fortran_: + _Interface_: 'type(c_ptr) function omp_aligned_alloc(alignment, size, + allocator) bind(C)' + 'use, intrinsic :: iso_c_binding, only : c_ptr, + c_size_t' + 'integer (c_size_t), value :: alignment, size' + 'integer (omp_allocator_handle_kind), value :: + allocator' + +_See also_: + *note OMP_ALLOCATOR::, *note Memory allocation::, *note + omp_set_default_allocator::, *note omp_free::, *note + omp_init_allocator:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.13.6 + + +File: libgomp.info, Node: omp_free, Next: omp_calloc, Prev: omp_aligned_alloc, Up: Memory Management Routines + +3.12.7 'omp_free' - Freeing memory allocated with OpenMP routines +----------------------------------------------------------------- + +_Description_: + The 'omp_free' routine deallocates memory previously allocated by + an OpenMP memory-management routine. The PTR argument must point + to such memory or be a null pointer; if it is a null pointer, no + operation is performed. If specified, the ALLOCATOR argument must + be either the memory allocator that was used for the allocation or + 'omp_null_allocator'; if it is 'omp_null_allocator', the + implementation will determine the value automatically. + + Calling 'omp_free' invokes undefined behavior if the memory was + already deallocated or when the used allocator has already been + destroyed. + +_C_: + _Prototype_: 'void omp_free(void *ptr,' + ' omp_allocator_handle_t allocator)' + +_C++_: + _Prototype_: 'void omp_free(void *ptr,' + ' omp_allocator_handle_t allocator=omp_null_allocator)' + +_Fortran_: + _Interface_: 'subroutine omp_free(ptr, allocator) bind(C)' + 'use, intrinsic :: iso_c_binding, only : c_ptr' + 'type (c_ptr), value :: ptr' + 'integer (omp_allocator_handle_kind), value :: + allocator' + +_See also_: + *note omp_alloc::, *note omp_aligned_alloc::, *note omp_calloc::, + *note omp_aligned_calloc::, *note omp_realloc:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.7.7 + + +File: libgomp.info, Node: omp_calloc, Next: omp_aligned_calloc, Prev: omp_free, Up: Memory Management Routines + +3.12.8 'omp_calloc' - Allocate nullified memory with an allocator +----------------------------------------------------------------- + +_Description_: + Allocate zero-initialized memory with the specified allocator, + which can either be a predefined allocator, an allocator handle or + 'omp_null_allocator'. If the allocators is 'omp_null_allocator', + the allocator specified by the DEF-ALLOCATOR-VAR ICV is used. The + to-be allocated memory is for an array with NMEMB elements, each + having a size of SIZE bytes. Both NMEMB and SIZE must be + nonnegative numbers; if either of them is zero, 'omp_calloc' will + return a null pointer. If successful, a pointer to the + zero-initialized allocated memory is returned, otherwise the + 'fallback' trait of the allocator determines the behavior. + + In 'target' regions, either the 'dynamic_allocators' clause must + appear on a 'requires' directive in the same compilation unit - or + the ALLOCATOR argument may only be a constant expression with the + value of one of the predefined allocators and may not be + 'omp_null_allocator'. + + Memory allocated by 'omp_calloc' must be freed using 'omp_free'. + +_C_: + _Prototype_: 'void* omp_calloc(size_t nmemb, size_t size,' + ' omp_allocator_handle_t allocator)' + +_C++_: + _Prototype_: 'void* omp_calloc(size_t nmemb, size_t size,' + ' omp_allocator_handle_t allocator=omp_null_allocator)' + +_Fortran_: + _Interface_: 'type(c_ptr) function omp_calloc(nmemb, size, allocator) + bind(C)' + 'use, intrinsic :: iso_c_binding, only : c_ptr, + c_size_t' + 'integer (c_size_t), value :: nmemb, size' + 'integer (omp_allocator_handle_kind), value :: + allocator' + +_See also_: + *note OMP_ALLOCATOR::, *note Memory allocation::, *note + omp_set_default_allocator::, *note omp_free::, *note + omp_init_allocator:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.13.8 + + +File: libgomp.info, Node: omp_aligned_calloc, Next: omp_realloc, Prev: omp_calloc, Up: Memory Management Routines + +3.12.9 'omp_aligned_calloc' - Allocate aligned nullified memory with an allocator +--------------------------------------------------------------------------------- + +_Description_: + Allocate zero-initialized memory with the specified allocator, + which can either be a predefined allocator, an allocator handle or + 'omp_null_allocator'. If the allocators is 'omp_null_allocator', + the allocator specified by the DEF-ALLOCATOR-VAR ICV is used. The + to-be allocated memory is for an array with NMEMB elements, each + having a size of SIZE bytes. Both NMEMB and SIZE must be + nonnegative numbers; if either of them is zero, + 'omp_aligned_calloc' will return a null pointer. ALIGNMENT must be + a positive power of two and SIZE must be a multiple of the + alignment; the alignment will be at least the maximal value + required by 'alignment' trait of the allocator and the value of the + passed ALIGNMENT argument. If successful, a pointer to the + zero-initialized allocated memory is returned, otherwise the + 'fallback' trait of the allocator determines the behavior. + + In 'target' regions, either the 'dynamic_allocators' clause must + appear on a 'requires' directive in the same compilation unit - or + the ALLOCATOR argument may only be a constant expression with the + value of one of the predefined allocators and may not be + 'omp_null_allocator'. + + Memory allocated by 'omp_aligned_calloc' must be freed using + 'omp_free'. + +_C_: + _Prototype_: 'void* omp_aligned_calloc(size_t nmemb, size_t size,' + ' omp_allocator_handle_t allocator)' + +_C++_: + _Prototype_: 'void* omp_aligned_calloc(size_t nmemb, size_t size,' + ' omp_allocator_handle_t allocator=omp_null_allocator)' + +_Fortran_: + _Interface_: 'type(c_ptr) function omp_aligned_calloc(nmemb, size, + allocator) bind(C)' + 'use, intrinsic :: iso_c_binding, only : c_ptr, + c_size_t' + 'integer (c_size_t), value :: nmemb, size' + 'integer (omp_allocator_handle_kind), value :: + allocator' + +_See also_: + *note OMP_ALLOCATOR::, *note Memory allocation::, *note + omp_set_default_allocator::, *note omp_free::, *note + omp_init_allocator:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.13.8 + + +File: libgomp.info, Node: omp_realloc, Prev: omp_aligned_calloc, Up: Memory Management Routines + +3.12.10 'omp_realloc' - Reallocate memory allocated with OpenMP routines +------------------------------------------------------------------------ + +_Description_: + The 'omp_realloc' routine deallocates memory to which PTR points to + and allocates new memory with the specified ALLOCATOR argument; the + new memory will have the content of the old memory up to the + minimum of the old size and the new SIZE, otherwise the content of + the returned memory is unspecified. If the new allocator is the + same as the old one, the routine tries to resize the existing + memory allocation, returning the same address as PTR if successful. + PTR must point to memory allocated by an OpenMP memory-management + routine. + + The ALLOCATOR and FREE_ALLOCATOR arguments must be a predefined + allocator, an allocator handle or 'omp_null_allocator'. If + FREE_ALLOCATOR is 'omp_null_allocator', the implementation + automatically determines the allocator used for the allocation of + PTR. If ALLOCATOR is 'omp_null_allocator' and PTR is not a null + pointer, the same allocator as 'free_allocator' is used and when + PTR is a null pointer the allocator specified by the + DEF-ALLOCATOR-VAR ICV is used. + + The SIZE must be a nonnegative number denoting the number of bytes + to be allocated; if SIZE is zero, 'omp_realloc' will return free + the memory and return a null pointer. When SIZE is nonzero: if + successful, a pointer to the allocated memory is returned, + otherwise the 'fallback' trait of the allocator determines the + behavior. + + In 'target' regions, either the 'dynamic_allocators' clause must + appear on a 'requires' directive in the same compilation unit - or + the FREE_ALLOCATOR and ALLOCATOR arguments may only be a constant + expression with the value of one of the predefined allocators and + may not be 'omp_null_allocator'. + + Memory allocated by 'omp_realloc' must be freed using 'omp_free'. + Calling 'omp_free' invokes undefined behavior if the memory was + already deallocated or when the used allocator has already been + destroyed. + +_C_: + _Prototype_: 'void* omp_realloc(void *ptr, size_t size,' + ' omp_allocator_handle_t allocator,' + ' omp_allocator_handle_t free_allocator)' + +_C++_: + _Prototype_: 'void* omp_realloc(void *ptr, size_t size,' + ' omp_allocator_handle_t allocator=omp_null_allocator,' + ' omp_allocator_handle_t + free_allocator=omp_null_allocator)' + +_Fortran_: + _Interface_: 'type(c_ptr) function omp_realloc(ptr, size, allocator, + free_allocator) bind(C)' + 'use, intrinsic :: iso_c_binding, only : c_ptr, + c_size_t' + 'type(C_ptr), value :: ptr' + 'integer (c_size_t), value :: size' + 'integer (omp_allocator_handle_kind), value :: + allocator, free_allocator' + +_See also_: + *note OMP_ALLOCATOR::, *note Memory allocation::, *note + omp_set_default_allocator::, *note omp_free::, *note + omp_init_allocator:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 3.7.9 + + +File: libgomp.info, Node: Environment Display Routine, Prev: Memory Management Routines, Up: Runtime Library Routines + +3.13 Environment Display Routine +================================ + +Routine to display the OpenMP version number and the initial value of +ICVs. It has C linkage and does not throw exceptions. + +* Menu: + +* omp_display_env:: print the initial ICV values + + +File: libgomp.info, Node: omp_display_env, Up: Environment Display Routine + +3.13.1 'omp_display_env' - print the initial ICV values +------------------------------------------------------- + +_Description_: + Each time this routine is invoked, the OpenMP version number and + initial value of internal control variables (ICVs) is printed on + 'stderr'. The displayed values are those at startup after + evaluating the environment variables; later calls to API routines + or clauses used in enclosing constructs do not affect the output. + + If the VERBOSE argument is 'false', only the OpenMP version and + standard OpenMP ICVs are shown; if it is 'true', additionally, the + GCC-specific ICVs are shown. + + The output consists of multiple lines and starts with 'OPENMP + DISPLAY ENVIRONMENT BEGIN' followed by the name-value lines and + ends with 'OPENMP DISPLAY ENVIRONMENT END'. The NAME is followed + by an equal sign and the VALUE is enclosed in single quotes. + + The first line has as NAME either '_OPENMP' or 'openmp_version' and + shows as value the supported OpenMP version number (4-digit year, + 2-digit month) of the implementation, matching the value of the + '_OPENMP' macro and, in Fortran, the named constant + 'openmp_version'. + + In each of the succeeding lines, the NAME matches the + environment-variable name of an ICV and shows its value. Those + line are might be prefixed by pair of brackets and a space, where + the brackets enclose a comma-separated list of devices to which the + ICV-value combination applies to; the value can either be a numeric + device number or an abstract name denoting all devices ('all'), the + initial host device ('host') or all devices but the host + ('device'). Note that the same ICV might be printed multiple times + for multiple devices, even if all have the same value. + + The effect when invoked from within a 'target' region is + unspecified. + +_C/C++_: + _Prototype_: 'void omp_display_env(int verbose)' + +_Fortran_: + _Interface_: 'subroutine omp_display_env(verbose)' + 'logical, intent(in) :: verbose' + +_Example_: + Note that the GCC-specific ICVs, such as the shown + 'GOMP_SPINCOUNT', are only printed when VERBOSE set to 'true'. + + OPENMP DISPLAY ENVIRONMENT BEGIN + _OPENMP = '201511' + [host] OMP_DYNAMIC = 'FALSE' + [host] OMP_NESTED = 'FALSE' + [all] OMP_CANCELLATION = 'FALSE' + ... + [host] GOMP_SPINCOUNT = '300000' + OPENMP DISPLAY ENVIRONMENT END + +_See also_: + *note OMP_DISPLAY_ENV::, *note Environment Variables::, *note + Implementation-defined ICV Initialization:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 3.15 + + +File: libgomp.info, Node: Environment Variables, Next: Enabling OpenACC, Prev: Runtime Library Routines, Up: Top + +4 OpenMP Environment Variables +****************************** + +The environment variables which beginning with 'OMP_' are defined by +section 4 of the OpenMP specification in version 4.5 or in a later +version of the specification, while those beginning with 'GOMP_' are GNU +extensions. Most 'OMP_' environment variables have an associated +internal control variable (ICV). + + For any OpenMP environment variable that sets an ICV and is neither +'OMP_DEFAULT_DEVICE' nor has global ICV scope, associated +device-specific environment variables exist. For them, the environment +variable without suffix affects the host. The suffix '_DEV_' followed +by a non-negative device number less that the number of available +devices sets the ICV for the corresponding device. The suffix '_DEV' +sets the ICV of all non-host devices for which a device-specific +corresponding environment variable has not been set while the '_ALL' +suffix sets the ICV of all host and non-host devices for which a more +specific corresponding environment variable is not set. + +* Menu: + +* OMP_ALLOCATOR:: Set the default allocator +* OMP_AFFINITY_FORMAT:: Set the format string used for affinity display +* OMP_CANCELLATION:: Set whether cancellation is activated +* OMP_DISPLAY_AFFINITY:: Display thread affinity information +* OMP_DISPLAY_ENV:: Show OpenMP version and environment variables +* OMP_DEFAULT_DEVICE:: Set the device used in target regions +* OMP_DYNAMIC:: Dynamic adjustment of threads +* OMP_MAX_ACTIVE_LEVELS:: Set the maximum number of nested parallel regions +* OMP_MAX_TASK_PRIORITY:: Set the maximum task priority value +* OMP_NESTED:: Nested parallel regions +* OMP_NUM_TEAMS:: Specifies the number of teams to use by teams region +* OMP_NUM_THREADS:: Specifies the number of threads to use +* OMP_PROC_BIND:: Whether threads may be moved between CPUs +* OMP_PLACES:: Specifies on which CPUs the threads should be placed +* OMP_STACKSIZE:: Set default thread stack size +* OMP_SCHEDULE:: How threads are scheduled +* OMP_TARGET_OFFLOAD:: Controls offloading behavior +* OMP_TEAMS_THREAD_LIMIT:: Set the maximum number of threads imposed by teams +* OMP_THREAD_LIMIT:: Set the maximum number of threads +* OMP_WAIT_POLICY:: How waiting threads are handled +* GOMP_CPU_AFFINITY:: Bind threads to specific CPUs +* GOMP_DEBUG:: Enable debugging output +* GOMP_STACKSIZE:: Set default thread stack size +* GOMP_SPINCOUNT:: Set the busy-wait spin count +* GOMP_RTEMS_THREAD_POOLS:: Set the RTEMS specific thread pools + + +File: libgomp.info, Node: OMP_ALLOCATOR, Next: OMP_AFFINITY_FORMAT, Up: Environment Variables + +4.1 'OMP_ALLOCATOR' - Set the default allocator +=============================================== + +_ICV:_ DEF-ALLOCATOR-VAR +_Scope:_ data environment +_Description_: + Sets the default allocator that is used when no allocator has been + specified in the 'allocate' or 'allocator' clause or if an OpenMP + memory routine is invoked with the 'omp_null_allocator' allocator. + If unset, 'omp_default_mem_alloc' is used. + + The value can either be a predefined allocator or a predefined + memory space or a predefined memory space followed by a colon and a + comma-separated list of memory trait and value pairs, separated by + '='. + + See *note Memory allocation:: for a list of supported prefedined + allocators, memory spaces, and traits. + + Note: The corresponding device environment variables are currently + not supported. Therefore, the non-host DEF-ALLOCATOR-VAR ICVs are + always initialized to 'omp_default_mem_alloc'. However, on all + devices, the 'omp_set_default_allocator' API routine can be used to + change value. + + Examples: + OMP_ALLOCATOR=omp_high_bw_mem_alloc + OMP_ALLOCATOR=omp_large_cap_mem_space + OMP_ALLOCATOR=omp_low_lat_mem_space:pinned=true,partition=nearest + +_See also_: + *note Memory allocation::, *note omp_get_default_allocator::, *note + omp_set_default_allocator::, *note Offload-Target Specifics:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 6.21 + + +File: libgomp.info, Node: OMP_AFFINITY_FORMAT, Next: OMP_CANCELLATION, Prev: OMP_ALLOCATOR, Up: Environment Variables + +4.2 'OMP_AFFINITY_FORMAT' - Set the format string used for affinity display +=========================================================================== + +_ICV:_ AFFINITY-FORMAT-VAR +_Scope:_ device +_Description_: + Sets the format string used when displaying OpenMP thread affinity + information. Special values are output using '%' followed by an + optional size specification and then either the single-character + field type or its long name enclosed in curly braces; using '%%' + displays a literal percent. The size specification consists of an + optional '0.' or '.' followed by a positive integer, specifying the + minimal width of the output. With '0.' and numerical values, the + output is padded with zeros on the left; with '.', the output is + padded by spaces on the left; otherwise, the output is padded by + spaces on the right. If unset, the value is "'level %L thread %i + affinity %A'". + + Supported field types are: + + t team_num value returned by 'omp_get_team_num' + T num_teams value returned by 'omp_get_num_teams' + L nesting_level value returned by 'omp_get_level' + n thread_num value returned by 'omp_get_thread_num' + N num_threads value returned by 'omp_get_num_threads' + a ancestor_tnum value returned by + 'omp_get_ancestor_thread_num(omp_get_level()-1)' + H host name of the host that executes the thread + P process_id process identifier + i native_thread_id native thread identifier + A thread_affinity comma separated list of integer values or + ranges, representing the processors on + which a process might execute, subject to + affinity mechanisms + + For instance, after setting + + OMP_AFFINITY_FORMAT="%0.2a!%n!%.4L!%N;%.2t;%0.2T;%{team_num};%{num_teams};%A" + + with either 'OMP_DISPLAY_AFFINITY' being set or when calling + 'omp_display_affinity' with 'NULL' or an empty string, the program + might display the following: + + 00!0! 1!4; 0;01;0;1;0-11 + 00!3! 1!4; 0;01;0;1;0-11 + 00!2! 1!4; 0;01;0;1;0-11 + 00!1! 1!4; 0;01;0;1;0-11 + +_See also_: + *note OMP_DISPLAY_AFFINITY:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 6.14 + + +File: libgomp.info, Node: OMP_CANCELLATION, Next: OMP_DISPLAY_AFFINITY, Prev: OMP_AFFINITY_FORMAT, Up: Environment Variables + +4.3 'OMP_CANCELLATION' - Set whether cancellation is activated +============================================================== + +_ICV:_ CANCEL-VAR +_Scope:_ global +_Description_: + If set to 'TRUE', the cancellation is activated. If set to 'FALSE' + or if unset, cancellation is disabled and the 'cancel' construct is + ignored. + +_See also_: + *note omp_get_cancellation:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.11 + + +File: libgomp.info, Node: OMP_DISPLAY_AFFINITY, Next: OMP_DISPLAY_ENV, Prev: OMP_CANCELLATION, Up: Environment Variables + +4.4 'OMP_DISPLAY_AFFINITY' - Display thread affinity information +================================================================ + +_ICV:_ DISPLAY-AFFINITY-VAR +_Scope:_ global +_Description_: + If set to 'FALSE' or if unset, affinity displaying is disabled. If + set to 'TRUE', the runtime displays affinity information about + OpenMP threads in a parallel region upon entering the region and + every time any change occurs. + +_See also_: + *note OMP_AFFINITY_FORMAT:: + +_Reference_: + OpenMP specification v5.0 (https://www.openmp.org), Section 6.13 + + +File: libgomp.info, Node: OMP_DISPLAY_ENV, Next: OMP_DEFAULT_DEVICE, Prev: OMP_DISPLAY_AFFINITY, Up: Environment Variables + +4.5 'OMP_DISPLAY_ENV' - Show OpenMP version and environment variables +===================================================================== + +_ICV:_ none +_Scope:_ not applicable +_Description_: + If set to 'TRUE', the runtime displays the same information to + 'stderr' as shown by the 'omp_display_env' routine invoked with + VERBOSE argument set to 'false'. If set to 'VERBOSE', the same + information is shown as invoking the routine with VERBOSE set to + 'true'. If unset or set to 'FALSE', this information is not shown. + The result for any other value is unspecified. + +_See also_: + *note omp_display_env:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.12 + + +File: libgomp.info, Node: OMP_DEFAULT_DEVICE, Next: OMP_DYNAMIC, Prev: OMP_DISPLAY_ENV, Up: Environment Variables + +4.6 'OMP_DEFAULT_DEVICE' - Set the device used in target regions +================================================================ + +_ICV:_ DEFAULT-DEVICE-VAR +_Scope:_ data environment +_Description_: + Set to choose the device which is used in a 'target' region, unless + the value is overridden by 'omp_set_default_device' or by a + 'device' clause. The value shall be the nonnegative device number. + If no device with the given device number exists, the code is + executed on the host. If unset, 'OMP_TARGET_OFFLOAD' is + 'mandatory' and no non-host devices are available, it is set to + 'omp_invalid_device'. Otherwise, if unset, device number 0 is + used. + +_See also_: + *note omp_get_default_device::, *note omp_set_default_device::, + *note OMP_TARGET_OFFLOAD:: + +_Reference_: + OpenMP specification v5.2 (https://www.openmp.org), Section 21.2.7 + + +File: libgomp.info, Node: OMP_DYNAMIC, Next: OMP_MAX_ACTIVE_LEVELS, Prev: OMP_DEFAULT_DEVICE, Up: Environment Variables + +4.7 'OMP_DYNAMIC' - Dynamic adjustment of threads +================================================= + +_ICV:_ DYN-VAR +_Scope:_ global +_Description_: + Enable or disable the dynamic adjustment of the number of threads + within a team. The value of this environment variable shall be + 'TRUE' or 'FALSE'. If undefined, dynamic adjustment is disabled by + default. + +_See also_: + *note omp_set_dynamic:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.3 + + +File: libgomp.info, Node: OMP_MAX_ACTIVE_LEVELS, Next: OMP_MAX_TASK_PRIORITY, Prev: OMP_DYNAMIC, Up: Environment Variables + +4.8 'OMP_MAX_ACTIVE_LEVELS' - Set the maximum number of nested parallel regions +=============================================================================== + +_ICV:_ MAX-ACTIVE-LEVELS-VAR +_Scope:_ data environment +_Description_: + Specifies the initial value for the maximum number of nested + parallel regions. The value of this variable shall be a positive + integer. If undefined, then if 'OMP_NESTED' is defined and set to + true, or if 'OMP_NUM_THREADS' or 'OMP_PROC_BIND' are defined and + set to a list with more than one item, the maximum number of nested + parallel regions is initialized to the largest number supported, + otherwise it is set to one. + +_See also_: + *note omp_set_max_active_levels::, *note OMP_NESTED::, *note + OMP_PROC_BIND::, *note OMP_NUM_THREADS:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.9 + + +File: libgomp.info, Node: OMP_MAX_TASK_PRIORITY, Next: OMP_NESTED, Prev: OMP_MAX_ACTIVE_LEVELS, Up: Environment Variables + +4.9 'OMP_MAX_TASK_PRIORITY' - Set the maximum priority +====================================================== + +number that can be set for a task. +_ICV:_ MAX-TASK-PRIORITY-VAR +_Scope:_ global +_Description_: + Specifies the initial value for the maximum priority value that can + be set for a task. The value of this variable shall be a + non-negative integer, and zero is allowed. If undefined, the + default priority is 0. + +_See also_: + *note omp_get_max_task_priority:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.14 + + +File: libgomp.info, Node: OMP_NESTED, Next: OMP_NUM_TEAMS, Prev: OMP_MAX_TASK_PRIORITY, Up: Environment Variables + +4.10 'OMP_NESTED' - Nested parallel regions +=========================================== + +_ICV:_ MAX-ACTIVE-LEVELS-VAR +_Scope:_ data environment +_Description_: + Enable or disable nested parallel regions, i.e., whether team + members are allowed to create new teams. The value of this + environment variable shall be 'TRUE' or 'FALSE'. If set to 'TRUE', + the number of maximum active nested regions supported is by default + set to the maximum supported, otherwise it is set to one. If + 'OMP_MAX_ACTIVE_LEVELS' is defined, its setting overrides this + setting. If both are undefined, nested parallel regions are + enabled if 'OMP_NUM_THREADS' or 'OMP_PROC_BINDS' are defined to a + list with more than one item, otherwise they are disabled by + default. + + Note that the 'OMP_NESTED' environment variable was deprecated in + the OpenMP specification 5.0 in favor of 'OMP_MAX_ACTIVE_LEVELS'. + +_See also_: + *note omp_set_max_active_levels::, *note omp_set_nested::, *note + OMP_MAX_ACTIVE_LEVELS:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.6 + + +File: libgomp.info, Node: OMP_NUM_TEAMS, Next: OMP_NUM_THREADS, Prev: OMP_NESTED, Up: Environment Variables + +4.11 'OMP_NUM_TEAMS' - Specifies the number of teams to use by teams region +=========================================================================== + +_ICV:_ NTEAMS-VAR +_Scope:_ device +_Description_: + Specifies the upper bound for number of teams to use in teams + regions without explicit 'num_teams' clause. The value of this + variable shall be a positive integer. If undefined it defaults to + 0 which means implementation defined upper bound. + +_See also_: + *note omp_set_num_teams:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 6.23 + + +File: libgomp.info, Node: OMP_NUM_THREADS, Next: OMP_PROC_BIND, Prev: OMP_NUM_TEAMS, Up: Environment Variables + +4.12 'OMP_NUM_THREADS' - Specifies the number of threads to use +=============================================================== + +_ICV:_ NTHREADS-VAR +_Scope:_ data environment +_Description_: + Specifies the default number of threads to use in parallel regions. + The value of this variable shall be a comma-separated list of + positive integers; the value specifies the number of threads to use + for the corresponding nested level. Specifying more than one item + in the list automatically enables nesting by default. If undefined + one thread per CPU is used. + + When a list with more than value is specified, it also affects the + MAX-ACTIVE-LEVELS-VAR ICV as described in *note + OMP_MAX_ACTIVE_LEVELS::. + +_See also_: + *note omp_set_num_threads::, *note OMP_MAX_ACTIVE_LEVELS:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.2 + + +File: libgomp.info, Node: OMP_PROC_BIND, Next: OMP_PLACES, Prev: OMP_NUM_THREADS, Up: Environment Variables + +4.13 'OMP_PROC_BIND' - Whether threads may be moved between CPUs +================================================================ + +_ICV:_ BIND-VAR +_Scope:_ data environment +_Description_: + Specifies whether threads may be moved between processors. If set + to 'TRUE', OpenMP threads should not be moved; if set to 'FALSE' + they may be moved. Alternatively, a comma separated list with the + values 'PRIMARY', 'MASTER', 'CLOSE' and 'SPREAD' can be used to + specify the thread affinity policy for the corresponding nesting + level. With 'PRIMARY' and 'MASTER' the worker threads are in the + same place partition as the primary thread. With 'CLOSE' those are + kept close to the primary thread in contiguous place partitions. + And with 'SPREAD' a sparse distribution across the place partitions + is used. Specifying more than one item in the list automatically + enables nesting by default. + + When a list is specified, it also affects the MAX-ACTIVE-LEVELS-VAR + ICV as described in *note OMP_MAX_ACTIVE_LEVELS::. + + When undefined, 'OMP_PROC_BIND' defaults to 'TRUE' when + 'OMP_PLACES' or 'GOMP_CPU_AFFINITY' is set and 'FALSE' otherwise. + +_See also_: + *note omp_get_proc_bind::, *note GOMP_CPU_AFFINITY::, *note + OMP_PLACES::, *note OMP_MAX_ACTIVE_LEVELS:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.4 + + +File: libgomp.info, Node: OMP_PLACES, Next: OMP_STACKSIZE, Prev: OMP_PROC_BIND, Up: Environment Variables + +4.14 'OMP_PLACES' - Specifies on which CPUs the threads should be placed +======================================================================== + +_ICV:_ PLACE-PARTITION-VAR +_Scope:_ implicit tasks +_Description_: + The thread placement can be either specified using an abstract name + or by an explicit list of the places. The abstract names + 'threads', 'cores', 'sockets', 'll_caches' and 'numa_domains' can + be optionally followed by a positive number in parentheses, which + denotes the how many places shall be created. With 'threads' each + place corresponds to a single hardware thread; 'cores' to a single + core with the corresponding number of hardware threads; with + 'sockets' the place corresponds to a single socket; with + 'll_caches' to a set of cores that shares the last level cache on + the device; and 'numa_domains' to a set of cores for which their + closest memory on the device is the same memory and at a similar + distance from the cores. The resulting placement can be shown by + setting the 'OMP_DISPLAY_ENV' environment variable. + + Alternatively, the placement can be specified explicitly as + comma-separated list of places. A place is specified by set of + nonnegative numbers in curly braces, denoting the hardware threads. + The curly braces can be omitted when only a single number has been + specified. The hardware threads belonging to a place can either be + specified as comma-separated list of nonnegative thread numbers or + using an interval. Multiple places can also be either specified by + a comma-separated list of places or by an interval. To specify an + interval, a colon followed by the count is placed after the + hardware thread number or the place. Optionally, the length can be + followed by a colon and the stride number - otherwise a unit stride + is assumed. Placing an exclamation mark ('!') directly before a + curly brace or numbers inside the curly braces (excluding + intervals) excludes those hardware threads. + + For instance, the following specifies the same places list: + '"{0,1,2}, {3,4,6}, {7,8,9}, {10,11,12}"'; '"{0:3}, {3:3}, {7:3}, + {10:3}"'; and '"{0:2}:4:3"'. + + If 'OMP_PLACES' and 'GOMP_CPU_AFFINITY' are unset and + 'OMP_PROC_BIND' is either unset or 'false', threads may be moved + between CPUs following no placement policy. + +_See also_: + *note OMP_PROC_BIND::, *note GOMP_CPU_AFFINITY::, *note + omp_get_proc_bind::, *note OMP_DISPLAY_ENV:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.5 + + +File: libgomp.info, Node: OMP_STACKSIZE, Next: OMP_SCHEDULE, Prev: OMP_PLACES, Up: Environment Variables + +4.15 'OMP_STACKSIZE' - Set default thread stack size +==================================================== + +_ICV:_ STACKSIZE-VAR +_Scope:_ device +_Description_: + Set the default thread stack size in kilobytes, unless the number + is suffixed by 'B', 'K', 'M' or 'G', in which case the size is, + respectively, in bytes, kilobytes, megabytes or gigabytes. This is + different from 'pthread_attr_setstacksize' which gets the number of + bytes as an argument. If the stack size cannot be set due to + system constraints, an error is reported and the initial stack size + is left unchanged. If undefined, the stack size is system + dependent. + +_See also_: + *note GOMP_STACKSIZE:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.7 + + +File: libgomp.info, Node: OMP_SCHEDULE, Next: OMP_TARGET_OFFLOAD, Prev: OMP_STACKSIZE, Up: Environment Variables + +4.16 'OMP_SCHEDULE' - How threads are scheduled +=============================================== + +_ICV:_ RUN-SCHED-VAR +_Scope:_ data environment +_Description_: + Allows to specify 'schedule type' and 'chunk size'. The value of + the variable shall have the form: 'type[,chunk]' where 'type' is + one of 'static', 'dynamic', 'guided' or 'auto' The optional 'chunk' + size shall be a positive integer. If undefined, dynamic scheduling + and a chunk size of 1 is used. + +_See also_: + *note omp_set_schedule:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Sections + 2.7.1.1 and 4.1 + + +File: libgomp.info, Node: OMP_TARGET_OFFLOAD, Next: OMP_TEAMS_THREAD_LIMIT, Prev: OMP_SCHEDULE, Up: Environment Variables + +4.17 'OMP_TARGET_OFFLOAD' - Controls offloading behavior +======================================================== + +_ICV:_ TARGET-OFFLOAD-VAR +_Scope:_ global +_Description_: + Specifies the behavior with regard to offloading code to a device. + This variable can be set to one of three values - 'MANDATORY', + 'DISABLED' or 'DEFAULT'. + + If set to 'MANDATORY', the program terminates with an error if any + device construct or device memory routine uses a device that is + unavailable or not supported by the implementation, or uses a + non-conforming device number. If set to 'DISABLED', then + offloading is disabled and all code runs on the host. If set to + 'DEFAULT', the program tries offloading to the device first, then + falls back to running code on the host if it cannot. + + If undefined, then the program behaves as if 'DEFAULT' was set. + + Note: Even with 'MANDATORY', no run-time termination is performed + when the device number in a 'device' clause or argument to a device + memory routine is for host, which includes using the device number + in the DEFAULT-DEVICE-VAR ICV. However, the initial value of the + DEFAULT-DEVICE-VAR ICV is affected by 'MANDATORY'. + +_See also_: + *note OMP_DEFAULT_DEVICE:: + +_Reference_: + OpenMP specification v5.2 (https://www.openmp.org), Section 21.2.8 + + +File: libgomp.info, Node: OMP_TEAMS_THREAD_LIMIT, Next: OMP_THREAD_LIMIT, Prev: OMP_TARGET_OFFLOAD, Up: Environment Variables + +4.18 'OMP_TEAMS_THREAD_LIMIT' - Set the maximum number of threads imposed by teams +================================================================================== + +_ICV:_ TEAMS-THREAD-LIMIT-VAR +_Scope:_ device +_Description_: + Specifies an upper bound for the number of threads to use by each + contention group created by a teams construct without explicit + 'thread_limit' clause. The value of this variable shall be a + positive integer. If undefined, the value of 0 is used which + stands for an implementation defined upper limit. + +_See also_: + *note OMP_THREAD_LIMIT::, *note omp_set_teams_thread_limit:: + +_Reference_: + OpenMP specification v5.1 (https://www.openmp.org), Section 6.24 + + +File: libgomp.info, Node: OMP_THREAD_LIMIT, Next: OMP_WAIT_POLICY, Prev: OMP_TEAMS_THREAD_LIMIT, Up: Environment Variables + +4.19 'OMP_THREAD_LIMIT' - Set the maximum number of threads +=========================================================== + +_ICV:_ THREAD-LIMIT-VAR +_Scope:_ data environment +_Description_: + Specifies the number of threads to use for the whole program. The + value of this variable shall be a positive integer. If undefined, + the number of threads is not limited. + +_See also_: + *note OMP_NUM_THREADS::, *note omp_get_thread_limit:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.10 + + +File: libgomp.info, Node: OMP_WAIT_POLICY, Next: GOMP_CPU_AFFINITY, Prev: OMP_THREAD_LIMIT, Up: Environment Variables + +4.20 'OMP_WAIT_POLICY' - How waiting threads are handled +======================================================== + +_Description_: + Specifies whether waiting threads should be active or passive. If + the value is 'PASSIVE', waiting threads should not consume CPU + power while waiting; while the value is 'ACTIVE' specifies that + they should. If undefined, threads wait actively for a short time + before waiting passively. + +_See also_: + *note GOMP_SPINCOUNT:: + +_Reference_: + OpenMP specification v4.5 (https://www.openmp.org), Section 4.8 + + +File: libgomp.info, Node: GOMP_CPU_AFFINITY, Next: GOMP_DEBUG, Prev: OMP_WAIT_POLICY, Up: Environment Variables + +4.21 'GOMP_CPU_AFFINITY' - Bind threads to specific CPUs +======================================================== + +_Description_: + Binds threads to specific CPUs. The variable should contain a + space-separated or comma-separated list of CPUs. This list may + contain different kinds of entries: either single CPU numbers in + any order, a range of CPUs (M-N) or a range with some stride + (M-N:S). CPU numbers are zero based. For example, + 'GOMP_CPU_AFFINITY="0 3 1-2 4-15:2"' binds the initial thread to + CPU 0, the second to CPU 3, the third to CPU 1, the fourth to CPU + 2, the fifth to CPU 4, the sixth through tenth to CPUs 6, 8, 10, + 12, and 14 respectively and then starts assigning back from the + beginning of the list. 'GOMP_CPU_AFFINITY=0' binds all threads to + CPU 0. + + There is no libgomp library routine to determine whether a CPU + affinity specification is in effect. As a workaround, + language-specific library functions, e.g., 'getenv' in C or + 'GET_ENVIRONMENT_VARIABLE' in Fortran, may be used to query the + setting of the 'GOMP_CPU_AFFINITY' environment variable. A defined + CPU affinity on startup cannot be changed or disabled during the + runtime of the application. + + If both 'GOMP_CPU_AFFINITY' and 'OMP_PROC_BIND' are set, + 'OMP_PROC_BIND' has a higher precedence. If neither has been set + and 'OMP_PROC_BIND' is unset, or when 'OMP_PROC_BIND' is set to + 'FALSE', the host system handles the assignment of threads to CPUs. + +_See also_: + *note OMP_PLACES::, *note OMP_PROC_BIND:: + + +File: libgomp.info, Node: GOMP_DEBUG, Next: GOMP_STACKSIZE, Prev: GOMP_CPU_AFFINITY, Up: Environment Variables + +4.22 'GOMP_DEBUG' - Enable debugging output +=========================================== + +_Description_: + Enable debugging output. The variable should be set to '0' + (disabled, also the default if not set), or '1' (enabled). + + If enabled, some debugging output is printed during execution. + This is currently not specified in more detail, and subject to + change. + + +File: libgomp.info, Node: GOMP_STACKSIZE, Next: GOMP_SPINCOUNT, Prev: GOMP_DEBUG, Up: Environment Variables + +4.23 'GOMP_STACKSIZE' - Set default thread stack size +===================================================== + +_Description_: + Set the default thread stack size in kilobytes. This is different + from 'pthread_attr_setstacksize' which gets the number of bytes as + an argument. If the stack size cannot be set due to system + constraints, an error is reported and the initial stack size is + left unchanged. If undefined, the stack size is system dependent. + +_See also_: + *note OMP_STACKSIZE:: + +_Reference_: + GCC Patches Mailinglist + (https://gcc.gnu.org/ml/gcc-patches/2006-06/msg00493.html), GCC + Patches Mailinglist + (https://gcc.gnu.org/ml/gcc-patches/2006-06/msg00496.html) + + +File: libgomp.info, Node: GOMP_SPINCOUNT, Next: GOMP_RTEMS_THREAD_POOLS, Prev: GOMP_STACKSIZE, Up: Environment Variables + +4.24 'GOMP_SPINCOUNT' - Set the busy-wait spin count +==================================================== + +_Description_: + Determines how long a threads waits actively with consuming CPU + power before waiting passively without consuming CPU power. The + value may be either 'INFINITE', 'INFINITY' to always wait actively + or an integer which gives the number of spins of the busy-wait + loop. The integer may optionally be followed by the following + suffixes acting as multiplication factors: 'k' (kilo, thousand), + 'M' (mega, million), 'G' (giga, billion), or 'T' (tera, trillion). + If undefined, 0 is used when 'OMP_WAIT_POLICY' is 'PASSIVE', + 300,000 is used when 'OMP_WAIT_POLICY' is undefined and 30 billion + is used when 'OMP_WAIT_POLICY' is 'ACTIVE'. If there are more + OpenMP threads than available CPUs, 1000 and 100 spins are used for + 'OMP_WAIT_POLICY' being 'ACTIVE' or undefined, respectively; unless + the 'GOMP_SPINCOUNT' is lower or 'OMP_WAIT_POLICY' is 'PASSIVE'. + +_See also_: + *note OMP_WAIT_POLICY:: + + +File: libgomp.info, Node: GOMP_RTEMS_THREAD_POOLS, Prev: GOMP_SPINCOUNT, Up: Environment Variables + +4.25 'GOMP_RTEMS_THREAD_POOLS' - Set the RTEMS specific thread pools +==================================================================== + +_Description_: + This environment variable is only used on the RTEMS real-time + operating system. It determines the scheduler instance specific + thread pools. The format for 'GOMP_RTEMS_THREAD_POOLS' is a list + of optional '[$]@' + configurations separated by ':' where: + * '' is the thread pool count for this + scheduler instance. + * '$' is an optional priority for the worker threads + of a thread pool according to 'pthread_setschedparam'. In + case a priority value is omitted, then a worker thread + inherits the priority of the OpenMP primary thread that + created it. The priority of the worker thread is not changed + after creation, even if a new OpenMP primary thread using the + worker has a different priority. + * '@' is the scheduler instance name according + to the RTEMS application configuration. + In case no thread pool configuration is specified for a scheduler + instance, then each OpenMP primary thread of this scheduler + instance uses its own dynamically allocated thread pool. To limit + the worker thread count of the thread pools, each OpenMP primary + thread must call 'omp_set_num_threads'. +_Example_: + Lets suppose we have three scheduler instances 'IO', 'WRK0', and + 'WRK1' with 'GOMP_RTEMS_THREAD_POOLS' set to '"1@WRK0:3$4@WRK1"'. + Then there are no thread pool restrictions for scheduler instance + 'IO'. In the scheduler instance 'WRK0' there is one thread pool + available. Since no priority is specified for this scheduler + instance, the worker thread inherits the priority of the OpenMP + primary thread that created it. In the scheduler instance 'WRK1' + there are three thread pools available and their worker threads run + at priority four. + + +File: libgomp.info, Node: Enabling OpenACC, Next: OpenACC Runtime Library Routines, Prev: Environment Variables, Up: Top + +5 Enabling OpenACC +****************** + +To activate the OpenACC extensions for C/C++ and Fortran, the +compile-time flag '-fopenacc' must be specified. This enables the +OpenACC directive '#pragma acc' in C/C++ and, in Fortran, the '!$acc' +sentinel in free source form and the 'c$acc', '*$acc' and '!$acc' +sentinels in fixed source form. The flag also arranges for automatic +linking of the OpenACC runtime library (*note OpenACC Runtime Library +Routines::). + + See for more information. + + A complete description of all OpenACC directives accepted may be +found in the OpenACC (https://www.openacc.org) Application Programming +Interface manual, version 2.6. + + +File: libgomp.info, Node: OpenACC Runtime Library Routines, Next: OpenACC Environment Variables, Prev: Enabling OpenACC, Up: Top + +6 OpenACC Runtime Library Routines +********************************** + +The runtime routines described here are defined by section 3 of the +OpenACC specifications in version 2.6. They have C linkage, and do not +throw exceptions. Generally, they are available only for the host, with +the exception of 'acc_on_device', which is available for both the host +and the acceleration device. + +* Menu: + +* acc_get_num_devices:: Get number of devices for the given device + type. +* acc_set_device_type:: Set type of device accelerator to use. +* acc_get_device_type:: Get type of device accelerator to be used. +* acc_set_device_num:: Set device number to use. +* acc_get_device_num:: Get device number to be used. +* acc_get_property:: Get device property. +* acc_async_test:: Tests for completion of a specific asynchronous + operation. +* acc_async_test_all:: Tests for completion of all asynchronous + operations. +* acc_wait:: Wait for completion of a specific asynchronous + operation. +* acc_wait_all:: Waits for completion of all asynchronous + operations. +* acc_wait_all_async:: Wait for completion of all asynchronous + operations. +* acc_wait_async:: Wait for completion of asynchronous operations. +* acc_init:: Initialize runtime for a specific device type. +* acc_shutdown:: Shuts down the runtime for a specific device + type. +* acc_on_device:: Whether executing on a particular device +* acc_malloc:: Allocate device memory. +* acc_free:: Free device memory. +* acc_copyin:: Allocate device memory and copy host memory to + it. +* acc_present_or_copyin:: If the data is not present on the device, + allocate device memory and copy from host + memory. +* acc_create:: Allocate device memory and map it to host + memory. +* acc_present_or_create:: If the data is not present on the device, + allocate device memory and map it to host + memory. +* acc_copyout:: Copy device memory to host memory. +* acc_delete:: Free device memory. +* acc_update_device:: Update device memory from mapped host memory. +* acc_update_self:: Update host memory from mapped device memory. +* acc_map_data:: Map previously allocated device memory to host + memory. +* acc_unmap_data:: Unmap device memory from host memory. +* acc_deviceptr:: Get device pointer associated with specific + host address. +* acc_hostptr:: Get host pointer associated with specific + device address. +* acc_is_present:: Indicate whether host variable / array is + present on device. +* acc_memcpy_to_device:: Copy host memory to device memory. +* acc_memcpy_from_device:: Copy device memory to host memory. +* acc_attach:: Let device pointer point to device-pointer target. +* acc_detach:: Let device pointer point to host-pointer target. + +API routines for target platforms. + +* acc_get_current_cuda_device:: Get CUDA device handle. +* acc_get_current_cuda_context::Get CUDA context handle. +* acc_get_cuda_stream:: Get CUDA stream handle. +* acc_set_cuda_stream:: Set CUDA stream handle. + +API routines for the OpenACC Profiling Interface. + +* acc_prof_register:: Register callbacks. +* acc_prof_unregister:: Unregister callbacks. +* acc_prof_lookup:: Obtain inquiry functions. +* acc_register_library:: Library registration. + + +File: libgomp.info, Node: acc_get_num_devices, Next: acc_set_device_type, Up: OpenACC Runtime Library Routines + +6.1 'acc_get_num_devices' - Get number of devices for given device type +======================================================================= + +_Description_ + This function returns a value indicating the number of devices + available for the device type specified in DEVICETYPE. + +_C/C++_: + _Prototype_: 'int acc_get_num_devices(acc_device_t devicetype);' + +_Fortran_: + _Interface_: 'integer function acc_get_num_devices(devicetype)' + 'integer(kind=acc_device_kind) devicetype' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.1. + + +File: libgomp.info, Node: acc_set_device_type, Next: acc_get_device_type, Prev: acc_get_num_devices, Up: OpenACC Runtime Library Routines + +6.2 'acc_set_device_type' - Set type of device accelerator to use. +================================================================== + +_Description_ + This function indicates to the runtime library which device type, + specified in DEVICETYPE, to use when executing a parallel or + kernels region. + +_C/C++_: + _Prototype_: 'acc_set_device_type(acc_device_t devicetype);' + +_Fortran_: + _Interface_: 'subroutine acc_set_device_type(devicetype)' + 'integer(kind=acc_device_kind) devicetype' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.2. + + +File: libgomp.info, Node: acc_get_device_type, Next: acc_set_device_num, Prev: acc_set_device_type, Up: OpenACC Runtime Library Routines + +6.3 'acc_get_device_type' - Get type of device accelerator to be used. +====================================================================== + +_Description_ + This function returns what device type will be used when executing + a parallel or kernels region. + + This function returns 'acc_device_none' if 'acc_get_device_type' is + called from 'acc_ev_device_init_start', 'acc_ev_device_init_end' + callbacks of the OpenACC Profiling Interface (*note OpenACC + Profiling Interface::), that is, if the device is currently being + initialized. + +_C/C++_: + _Prototype_: 'acc_device_t acc_get_device_type(void);' + +_Fortran_: + _Interface_: 'function acc_get_device_type(void)' + 'integer(kind=acc_device_kind) acc_get_device_type' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.3. + + +File: libgomp.info, Node: acc_set_device_num, Next: acc_get_device_num, Prev: acc_get_device_type, Up: OpenACC Runtime Library Routines + +6.4 'acc_set_device_num' - Set device number to use. +==================================================== + +_Description_ + This function will indicate to the runtime which device number, + specified by DEVICENUM, associated with the specified device type + DEVICETYPE. + +_C/C++_: + _Prototype_: 'acc_set_device_num(int devicenum, acc_device_t + devicetype);' + +_Fortran_: + _Interface_: 'subroutine acc_set_device_num(devicenum, devicetype)' + 'integer devicenum' + 'integer(kind=acc_device_kind) devicetype' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.4. + + +File: libgomp.info, Node: acc_get_device_num, Next: acc_get_property, Prev: acc_set_device_num, Up: OpenACC Runtime Library Routines + +6.5 'acc_get_device_num' - Get device number to be used. +======================================================== + +_Description_ + This function returns which device number associated with the + specified device type DEVICETYPE, will be used when executing a + parallel or kernels region. + +_C/C++_: + _Prototype_: 'int acc_get_device_num(acc_device_t devicetype);' + +_Fortran_: + _Interface_: 'function acc_get_device_num(devicetype)' + 'integer(kind=acc_device_kind) devicetype' + 'integer acc_get_device_num' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.5. + + +File: libgomp.info, Node: acc_get_property, Next: acc_async_test, Prev: acc_get_device_num, Up: OpenACC Runtime Library Routines + +6.6 'acc_get_property' - Get device property. +============================================= + +_Description_ + These routines return the value of the specified PROPERTY for the + device being queried according to DEVICENUM and DEVICETYPE. + Integer-valued and string-valued properties are returned by + 'acc_get_property' and 'acc_get_property_string' respectively. The + Fortran 'acc_get_property_string' subroutine returns the string + retrieved in its fourth argument while the remaining entry points + are functions, which pass the return value as their result. + + Note for Fortran, only: the OpenACC technical committee corrected + and, hence, modified the interface introduced in OpenACC 2.6. The + kind-value parameter 'acc_device_property' has been renamed to + 'acc_device_property_kind' for consistency and the return type of + the 'acc_get_property' function is now a 'c_size_t' integer instead + of a 'acc_device_property' integer. The parameter + 'acc_device_property' is still provided, but might be removed in a + future version of GCC. + +_C/C++_: + _Prototype_: 'size_t acc_get_property(int devicenum, acc_device_t + devicetype, acc_device_property_t property);' + _Prototype_: 'const char *acc_get_property_string(int devicenum, + acc_device_t devicetype, acc_device_property_t + property);' + +_Fortran_: + _Interface_: 'function acc_get_property(devicenum, devicetype, + property)' + _Interface_: 'subroutine acc_get_property_string(devicenum, + devicetype, property, string)' + 'use ISO_C_Binding, only: c_size_t' + 'integer devicenum' + 'integer(kind=acc_device_kind) devicetype' + 'integer(kind=acc_device_property_kind) property' + 'integer(kind=c_size_t) acc_get_property' + 'character(*) string' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.6. + + +File: libgomp.info, Node: acc_async_test, Next: acc_async_test_all, Prev: acc_get_property, Up: OpenACC Runtime Library Routines + +6.7 'acc_async_test' - Test for completion of a specific asynchronous operation. +================================================================================ + +_Description_ + This function tests for completion of the asynchronous operation + specified in ARG. In C/C++, a non-zero value is returned to + indicate the specified asynchronous operation has completed while + Fortran returns 'true'. If the asynchronous operation has not + completed, C/C++ returns zero and Fortran returns 'false'. + +_C/C++_: + _Prototype_: 'int acc_async_test(int arg);' + +_Fortran_: + _Interface_: 'function acc_async_test(arg)' + 'integer(kind=acc_handle_kind) arg' + 'logical acc_async_test' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.9. + + +File: libgomp.info, Node: acc_async_test_all, Next: acc_wait, Prev: acc_async_test, Up: OpenACC Runtime Library Routines + +6.8 'acc_async_test_all' - Tests for completion of all asynchronous operations. +=============================================================================== + +_Description_ + This function tests for completion of all asynchronous operations. + In C/C++, a non-zero value is returned to indicate all asynchronous + operations have completed while Fortran returns 'true'. If any + asynchronous operation has not completed, C/C++ returns zero and + Fortran returns 'false'. + +_C/C++_: + _Prototype_: 'int acc_async_test_all(void);' + +_Fortran_: + _Interface_: 'function acc_async_test()' + 'logical acc_get_device_num' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.10. + + +File: libgomp.info, Node: acc_wait, Next: acc_wait_all, Prev: acc_async_test_all, Up: OpenACC Runtime Library Routines + +6.9 'acc_wait' - Wait for completion of a specific asynchronous operation. +========================================================================== + +_Description_ + This function waits for completion of the asynchronous operation + specified in ARG. + +_C/C++_: + _Prototype_: 'acc_wait(arg);' + _Prototype 'acc_async_wait(arg);' + (OpenACC 1.0 + compatibility)_: + +_Fortran_: + _Interface_: 'subroutine acc_wait(arg)' + 'integer(acc_handle_kind) arg' + _Interface 'subroutine acc_async_wait(arg)' + (OpenACC 1.0 + compatibility)_: + 'integer(acc_handle_kind) arg' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.11. + + +File: libgomp.info, Node: acc_wait_all, Next: acc_wait_all_async, Prev: acc_wait, Up: OpenACC Runtime Library Routines + +6.10 'acc_wait_all' - Waits for completion of all asynchronous operations. +========================================================================== + +_Description_ + This function waits for the completion of all asynchronous + operations. + +_C/C++_: + _Prototype_: 'acc_wait_all(void);' + _Prototype 'acc_async_wait_all(void);' + (OpenACC 1.0 + compatibility)_: + +_Fortran_: + _Interface_: 'subroutine acc_wait_all()' + _Interface 'subroutine acc_async_wait_all()' + (OpenACC 1.0 + compatibility)_: + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.13. + + +File: libgomp.info, Node: acc_wait_all_async, Next: acc_wait_async, Prev: acc_wait_all, Up: OpenACC Runtime Library Routines + +6.11 'acc_wait_all_async' - Wait for completion of all asynchronous operations. +=============================================================================== + +_Description_ + This function enqueues a wait operation on the queue ASYNC for any + and all asynchronous operations that have been previously enqueued + on any queue. + +_C/C++_: + _Prototype_: 'acc_wait_all_async(int async);' + +_Fortran_: + _Interface_: 'subroutine acc_wait_all_async(async)' + 'integer(acc_handle_kind) async' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.14. + + +File: libgomp.info, Node: acc_wait_async, Next: acc_init, Prev: acc_wait_all_async, Up: OpenACC Runtime Library Routines + +6.12 'acc_wait_async' - Wait for completion of asynchronous operations. +======================================================================= + +_Description_ + This function enqueues a wait operation on queue ASYNC for any and + all asynchronous operations enqueued on queue ARG. + +_C/C++_: + _Prototype_: 'acc_wait_async(int arg, int async);' + +_Fortran_: + _Interface_: 'subroutine acc_wait_async(arg, async)' + 'integer(acc_handle_kind) arg, async' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.12. + + +File: libgomp.info, Node: acc_init, Next: acc_shutdown, Prev: acc_wait_async, Up: OpenACC Runtime Library Routines + +6.13 'acc_init' - Initialize runtime for a specific device type. +================================================================ + +_Description_ + This function initializes the runtime for the device type specified + in DEVICETYPE. + +_C/C++_: + _Prototype_: 'acc_init(acc_device_t devicetype);' + +_Fortran_: + _Interface_: 'subroutine acc_init(devicetype)' + 'integer(acc_device_kind) devicetype' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.7. + + +File: libgomp.info, Node: acc_shutdown, Next: acc_on_device, Prev: acc_init, Up: OpenACC Runtime Library Routines + +6.14 'acc_shutdown' - Shuts down the runtime for a specific device type. +======================================================================== + +_Description_ + This function shuts down the runtime for the device type specified + in DEVICETYPE. + +_C/C++_: + _Prototype_: 'acc_shutdown(acc_device_t devicetype);' + +_Fortran_: + _Interface_: 'subroutine acc_shutdown(devicetype)' + 'integer(acc_device_kind) devicetype' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.8. + + +File: libgomp.info, Node: acc_on_device, Next: acc_malloc, Prev: acc_shutdown, Up: OpenACC Runtime Library Routines + +6.15 'acc_on_device' - Whether executing on a particular device +=============================================================== + +_Description_: + This function returns whether the program is executing on a + particular device specified in DEVICETYPE. In C/C++ a non-zero + value is returned to indicate the device is executing on the + specified device type. In Fortran, 'true' is returned. If the + program is not executing on the specified device type C/C++ returns + zero, while Fortran returns 'false'. + + Note that in GCC, depending on DEVICETYPE, the function call might + be folded to a constant in the compiler; compile with + '-fno-builtin-acc_on_device' if a run-time function is desired. + +_C/C++_: + _Prototype_: 'acc_on_device(acc_device_t devicetype);' + +_Fortran_: + _Interface_: 'function acc_on_device(devicetype)' + 'integer(acc_device_kind) devicetype' + 'logical acc_on_device' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.17. + + +File: libgomp.info, Node: acc_malloc, Next: acc_free, Prev: acc_on_device, Up: OpenACC Runtime Library Routines + +6.16 'acc_malloc' - Allocate device memory. +=========================================== + +_Description_ + This function allocates BYTES bytes of device memory. It returns + the device address of the allocated memory. + +_C/C++_: + _Prototype_: 'd_void* acc_malloc(size_t bytes);' + +_Fortran_: + _Interface_: 'type(c_ptr) function acc_malloc(bytes)' + 'integer(c_size_t), value :: bytes' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.18. openacc specification v3.3 (https://www.openacc.org), + section 3.2.16. + + +File: libgomp.info, Node: acc_free, Next: acc_copyin, Prev: acc_malloc, Up: OpenACC Runtime Library Routines + +6.17 'acc_free' - Free device memory. +===================================== + +_Description_ + Free previously allocated device memory at the device address + 'data_dev'. + +_C/C++_: + _Prototype_: 'void acc_free(d_void *data_dev);' + +_Fortran_: + _Interface_: 'subroutine acc_free(data_dev)' + 'type(c_ptr), value :: data_dev' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.19. openacc specification v3.3 (https://www.openacc.org), + section 3.2.17. + + +File: libgomp.info, Node: acc_copyin, Next: acc_present_or_copyin, Prev: acc_free, Up: OpenACC Runtime Library Routines + +6.18 'acc_copyin' - Allocate device memory and copy host memory to it. +====================================================================== + +_Description_ + In C/C++, this function allocates LEN bytes of device memory and + maps it to the specified host address in A. The device address of + the newly allocated device memory is returned. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + +_C/C++_: + _Prototype_: 'void *acc_copyin(h_void *a, size_t len);' + _Prototype_: 'void *acc_copyin_async(h_void *a, size_t len, int + async);' + +_Fortran_: + _Interface_: 'subroutine acc_copyin(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_copyin(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_copyin_async(a, async)' + 'type, dimension(:[,:]...) :: a' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_copyin_async(a, len, async)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'integer(acc_handle_kind) :: async' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.20. + + +File: libgomp.info, Node: acc_present_or_copyin, Next: acc_create, Prev: acc_copyin, Up: OpenACC Runtime Library Routines + +6.19 'acc_present_or_copyin' - If the data is not present on the device, allocate device memory and copy from host memory. +========================================================================================================================== + +_Description_ + This function tests if the host data specified by A and of length + LEN is present or not. If it is not present, device memory is + allocated and the host memory copied. The device address of the + newly allocated device memory is returned. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + + Note that 'acc_present_or_copyin' and 'acc_pcopyin' exist for + backward compatibility with OpenACC 2.0; use *note acc_copyin:: + instead. + +_C/C++_: + _Prototype_: 'void *acc_present_or_copyin(h_void *a, size_t len);' + _Prototype_: 'void *acc_pcopyin(h_void *a, size_t len);' + +_Fortran_: + _Interface_: 'subroutine acc_present_or_copyin(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_present_or_copyin(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_pcopyin(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_pcopyin(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.20. + + +File: libgomp.info, Node: acc_create, Next: acc_present_or_create, Prev: acc_present_or_copyin, Up: OpenACC Runtime Library Routines + +6.20 'acc_create' - Allocate device memory and map it to host memory. +===================================================================== + +_Description_ + This function allocates device memory and maps it to host memory + specified by the host address A with a length of LEN bytes. In + C/C++, the function returns the device address of the allocated + device memory. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + +_C/C++_: + _Prototype_: 'void *acc_create(h_void *a, size_t len);' + _Prototype_: 'void *acc_create_async(h_void *a, size_t len, int + async);' + +_Fortran_: + _Interface_: 'subroutine acc_create(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_create(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_create_async(a, async)' + 'type, dimension(:[,:]...) :: a' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_create_async(a, len, async)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'integer(acc_handle_kind) :: async' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.21. + + +File: libgomp.info, Node: acc_present_or_create, Next: acc_copyout, Prev: acc_create, Up: OpenACC Runtime Library Routines + +6.21 'acc_present_or_create' - If the data is not present on the device, allocate device memory and map it to host memory. +========================================================================================================================== + +_Description_ + This function tests if the host data specified by A and of length + LEN is present or not. If it is not present, device memory is + allocated and mapped to host memory. In C/C++, the device address + of the newly allocated device memory is returned. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + + Note that 'acc_present_or_create' and 'acc_pcreate' exist for + backward compatibility with OpenACC 2.0; use *note acc_create:: + instead. + +_C/C++_: + _Prototype_: 'void *acc_present_or_create(h_void *a, size_t len)' + _Prototype_: 'void *acc_pcreate(h_void *a, size_t len)' + +_Fortran_: + _Interface_: 'subroutine acc_present_or_create(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_present_or_create(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_pcreate(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_pcreate(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.21. + + +File: libgomp.info, Node: acc_copyout, Next: acc_delete, Prev: acc_present_or_create, Up: OpenACC Runtime Library Routines + +6.22 'acc_copyout' - Copy device memory to host memory. +======================================================= + +_Description_ + This function copies mapped device memory to host memory which is + specified by host address A for a length LEN bytes in C/C++. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + +_C/C++_: + _Prototype_: 'acc_copyout(h_void *a, size_t len);' + _Prototype_: 'acc_copyout_async(h_void *a, size_t len, int async);' + _Prototype_: 'acc_copyout_finalize(h_void *a, size_t len);' + _Prototype_: 'acc_copyout_finalize_async(h_void *a, size_t len, int + async);' + +_Fortran_: + _Interface_: 'subroutine acc_copyout(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_copyout(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_copyout_async(a, async)' + 'type, dimension(:[,:]...) :: a' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_copyout_async(a, len, async)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_copyout_finalize(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_copyout_finalize(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_copyout_finalize_async(a, async)' + 'type, dimension(:[,:]...) :: a' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_copyout_finalize_async(a, len, async)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'integer(acc_handle_kind) :: async' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.22. + + +File: libgomp.info, Node: acc_delete, Next: acc_update_device, Prev: acc_copyout, Up: OpenACC Runtime Library Routines + +6.23 'acc_delete' - Free device memory. +======================================= + +_Description_ + This function frees previously allocated device memory specified by + the device address A and the length of LEN bytes. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + +_C/C++_: + _Prototype_: 'acc_delete(h_void *a, size_t len);' + _Prototype_: 'acc_delete_async(h_void *a, size_t len, int async);' + _Prototype_: 'acc_delete_finalize(h_void *a, size_t len);' + _Prototype_: 'acc_delete_finalize_async(h_void *a, size_t len, int + async);' + +_Fortran_: + _Interface_: 'subroutine acc_delete(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_delete(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_delete_async(a, async)' + 'type, dimension(:[,:]...) :: a' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_delete_async(a, len, async)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_delete_finalize(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_delete_finalize(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_delete_async_finalize(a, async)' + 'type, dimension(:[,:]...) :: a' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_delete_async_finalize(a, len, async)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'integer(acc_handle_kind) :: async' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.23. + + +File: libgomp.info, Node: acc_update_device, Next: acc_update_self, Prev: acc_delete, Up: OpenACC Runtime Library Routines + +6.24 'acc_update_device' - Update device memory from mapped host memory. +======================================================================== + +_Description_ + This function updates the device copy from the previously mapped + host memory. The host memory is specified with the host address A + and a length of LEN bytes. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + +_C/C++_: + _Prototype_: 'acc_update_device(h_void *a, size_t len);' + _Prototype_: 'acc_update_device(h_void *a, size_t len, async);' + +_Fortran_: + _Interface_: 'subroutine acc_update_device(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_update_device(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_update_device_async(a, async)' + 'type, dimension(:[,:]...) :: a' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_update_device_async(a, len, async)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'integer(acc_handle_kind) :: async' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.24. + + +File: libgomp.info, Node: acc_update_self, Next: acc_map_data, Prev: acc_update_device, Up: OpenACC Runtime Library Routines + +6.25 'acc_update_self' - Update host memory from mapped device memory. +====================================================================== + +_Description_ + This function updates the host copy from the previously mapped + device memory. The host memory is specified with the host address + A and a length of LEN bytes. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + +_C/C++_: + _Prototype_: 'acc_update_self(h_void *a, size_t len);' + _Prototype_: 'acc_update_self_async(h_void *a, size_t len, int + async);' + +_Fortran_: + _Interface_: 'subroutine acc_update_self(a)' + 'type, dimension(:[,:]...) :: a' + _Interface_: 'subroutine acc_update_self(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + _Interface_: 'subroutine acc_update_self_async(a, async)' + 'type, dimension(:[,:]...) :: a' + 'integer(acc_handle_kind) :: async' + _Interface_: 'subroutine acc_update_self_async(a, len, async)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'integer(acc_handle_kind) :: async' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.25. + + +File: libgomp.info, Node: acc_map_data, Next: acc_unmap_data, Prev: acc_update_self, Up: OpenACC Runtime Library Routines + +6.26 'acc_map_data' - Map previously allocated device memory to host memory. +============================================================================ + +_Description_ + This function maps previously allocated device and host memory. + The device memory is specified with the device address DATA_DEV. + The host memory is specified with the host address DATA_ARG and a + length of BYTES. + +_C/C++_: + _Prototype_: 'void acc_map_data(h_void *data_arg, d_void *data_dev, + size_t bytes);' + +_Fortran_: + _Interface_: 'subroutine acc_map_data(data_arg, data_dev, bytes)' + 'type(*), dimension(*) :: data_arg' + 'type(c_ptr), value :: data_dev' + 'integer(c_size_t), value :: bytes' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.26. OpenACC specification v3.3 (https://www.openacc.org), + section 3.2.21. + + +File: libgomp.info, Node: acc_unmap_data, Next: acc_deviceptr, Prev: acc_map_data, Up: OpenACC Runtime Library Routines + +6.27 'acc_unmap_data' - Unmap device memory from host memory. +============================================================= + +_Description_ + This function unmaps previously mapped device and host memory. The + latter specified by DATA_ARG. + +_C/C++_: + _Prototype_: 'void acc_unmap_data(h_void *data_arg);' + +_Fortran_: + _Interface_: 'subroutine acc_unmap_data(data_arg)' + 'type(*), dimension(*) :: data_arg' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.27. OpenACC specification v3.3 (https://www.openacc.org), + section 3.2.22. + + +File: libgomp.info, Node: acc_deviceptr, Next: acc_hostptr, Prev: acc_unmap_data, Up: OpenACC Runtime Library Routines + +6.28 'acc_deviceptr' - Get device pointer associated with specific host address. +================================================================================ + +_Description_ + This function returns the device address that has been mapped to + the host address specified by DATA_ARG. + +_C/C++_: + _Prototype_: 'void *acc_deviceptr(h_void *data_arg);' + +_Fortran_: + _Interface_: 'type(c_ptr) function acc_deviceptr(data_arg)' + 'type(*), dimension(*) :: data_arg' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.28. OpenACC specification v3.3 (https://www.openacc.org), + section 3.2.23. + + +File: libgomp.info, Node: acc_hostptr, Next: acc_is_present, Prev: acc_deviceptr, Up: OpenACC Runtime Library Routines + +6.29 'acc_hostptr' - Get host pointer associated with specific device address. +============================================================================== + +_Description_ + This function returns the host address that has been mapped to the + device address specified by DATA_DEV. + +_C/C++_: + _Prototype_: 'void *acc_hostptr(d_void *data_dev);' + +_Fortran_: + _Interface_: 'type(c_ptr) function acc_hostptr(data_dev)' + 'type(c_ptr), value :: data_dev' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.29. OpenACC specification v3.3 (https://www.openacc.org), + section 3.2.24. + + +File: libgomp.info, Node: acc_is_present, Next: acc_memcpy_to_device, Prev: acc_hostptr, Up: OpenACC Runtime Library Routines + +6.30 'acc_is_present' - Indicate whether host variable / array is present on device. +==================================================================================== + +_Description_ + This function indicates whether the specified host address in A and + a length of LEN bytes is present on the device. In C/C++, a + non-zero value is returned to indicate the presence of the mapped + memory on the device. A zero is returned to indicate the memory is + not mapped on the device. + + In Fortran, two (2) forms are supported. In the first form, A + specifies a contiguous array section. The second form A specifies + a variable or array element and LEN specifies the length in bytes. + If the host memory is mapped to device memory, then a 'true' is + returned. Otherwise, a 'false' is return to indicate the mapped + memory is not present. + +_C/C++_: + _Prototype_: 'int acc_is_present(h_void *a, size_t len);' + +_Fortran_: + _Interface_: 'function acc_is_present(a)' + 'type, dimension(:[,:]...) :: a' + 'logical acc_is_present' + _Interface_: 'function acc_is_present(a, len)' + 'type, dimension(:[,:]...) :: a' + 'integer len' + 'logical acc_is_present' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.30. + + +File: libgomp.info, Node: acc_memcpy_to_device, Next: acc_memcpy_from_device, Prev: acc_is_present, Up: OpenACC Runtime Library Routines + +6.31 'acc_memcpy_to_device' - Copy host memory to device memory. +================================================================ + +_Description_ + This function copies host memory specified by host address of + DATA_HOST_SRC to device memory specified by the device address + DATA_DEV_DEST for a length of BYTES bytes. + +_C/C++_: + _Prototype_: 'void acc_memcpy_to_device(d_void* data_dev_dest,' + 'h_void* data_host_src, size_t bytes);' + _Prototype_: 'void acc_memcpy_to_device_async(d_void* data_dev_dest,' + 'h_void* data_host_src, size_t bytes, int async_arg);' + +_Fortran_: + _Interface_: 'subroutine acc_memcpy_to_device(data_dev_dest, &' + 'data_host_src, bytes)' + _Interface_: 'subroutine acc_memcpy_to_device_async(data_dev_dest, &' + 'data_host_src, bytes, async_arg)' + 'type(c_ptr), value :: data_dev_dest' + 'type(*), dimension(*) :: data_host_src' + 'integer(c_size_t), value :: bytes' + 'integer(acc_handle_kind), value :: async_arg' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.31 OpenACC specification v3.3 (https://www.openacc.org), + section 3.2.26. + + +File: libgomp.info, Node: acc_memcpy_from_device, Next: acc_attach, Prev: acc_memcpy_to_device, Up: OpenACC Runtime Library Routines + +6.32 'acc_memcpy_from_device' - Copy device memory to host memory. +================================================================== + +_Description_ + This function copies device memory specified by device address of + DATA_DEV_SRC to host memory specified by the host address + DATA_HOST_DEST for a length of BYTES bytes. + +_C/C++_: + _Prototype_: 'void acc_memcpy_from_device(h_void* data_host_dest,' + 'd_void* data_dev_src, size_t bytes);' + _Prototype_: 'void acc_memcpy_from_device_async(h_void* + data_host_dest,' + 'd_void* data_dev_src, size_t bytes, int async_arg);' + +_Fortran_: + _Interface_: 'subroutine acc_memcpy_from_device(data_host_dest, &' + 'data_dev_src, bytes)' + _Interface_: 'subroutine acc_memcpy_from_device_async(data_host_dest, + &' + 'data_dev_src, bytes, async_arg)' + 'type(*), dimension(*) :: data_host_dest' + 'type(c_ptr), value :: data_dev_src' + 'integer(c_size_t), value :: bytes' + 'integer(acc_handle_kind), value :: async_arg' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.32. OpenACC specification v3.3 (https://www.openacc.org), + section 3.2.27. + + +File: libgomp.info, Node: acc_attach, Next: acc_detach, Prev: acc_memcpy_from_device, Up: OpenACC Runtime Library Routines + +6.33 'acc_attach' - Let device pointer point to device-pointer target. +====================================================================== + +_Description_ + This function updates a pointer on the device from pointing to a + host-pointer address to pointing to the corresponding device data. + +_C/C++_: + _Prototype_: 'void acc_attach(h_void **ptr_addr);' + _Prototype_: 'void acc_attach_async(h_void **ptr_addr, int async);' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.34. + + +File: libgomp.info, Node: acc_detach, Next: acc_get_current_cuda_device, Prev: acc_attach, Up: OpenACC Runtime Library Routines + +6.34 'acc_detach' - Let device pointer point to host-pointer target. +==================================================================== + +_Description_ + This function updates a pointer on the device from pointing to a + device-pointer address to pointing to the corresponding host data. + +_C/C++_: + _Prototype_: 'void acc_detach(h_void **ptr_addr);' + _Prototype_: 'void acc_detach_async(h_void **ptr_addr, int async);' + _Prototype_: 'void acc_detach_finalize(h_void **ptr_addr);' + _Prototype_: 'void acc_detach_finalize_async(h_void **ptr_addr, int + async);' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + 3.2.35. + + +File: libgomp.info, Node: acc_get_current_cuda_device, Next: acc_get_current_cuda_context, Prev: acc_detach, Up: OpenACC Runtime Library Routines + +6.35 'acc_get_current_cuda_device' - Get CUDA device handle. +============================================================ + +_Description_ + This function returns the CUDA device handle. This handle is the + same as used by the CUDA Runtime or Driver API's. + +_C/C++_: + _Prototype_: 'void *acc_get_current_cuda_device(void);' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + A.2.1.1. + + +File: libgomp.info, Node: acc_get_current_cuda_context, Next: acc_get_cuda_stream, Prev: acc_get_current_cuda_device, Up: OpenACC Runtime Library Routines + +6.36 'acc_get_current_cuda_context' - Get CUDA context handle. +============================================================== + +_Description_ + This function returns the CUDA context handle. This handle is the + same as used by the CUDA Runtime or Driver API's. + +_C/C++_: + _Prototype_: 'void *acc_get_current_cuda_context(void);' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + A.2.1.2. + + +File: libgomp.info, Node: acc_get_cuda_stream, Next: acc_set_cuda_stream, Prev: acc_get_current_cuda_context, Up: OpenACC Runtime Library Routines + +6.37 'acc_get_cuda_stream' - Get CUDA stream handle. +==================================================== + +_Description_ + This function returns the CUDA stream handle for the queue ASYNC. + This handle is the same as used by the CUDA Runtime or Driver + API's. + +_C/C++_: + _Prototype_: 'void *acc_get_cuda_stream(int async);' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + A.2.1.3. + + +File: libgomp.info, Node: acc_set_cuda_stream, Next: acc_prof_register, Prev: acc_get_cuda_stream, Up: OpenACC Runtime Library Routines + +6.38 'acc_set_cuda_stream' - Set CUDA stream handle. +==================================================== + +_Description_ + This function associates the stream handle specified by STREAM with + the queue ASYNC. + + This cannot be used to change the stream handle associated with + 'acc_async_sync'. + + The return value is not specified. + +_C/C++_: + _Prototype_: 'int acc_set_cuda_stream(int async, void *stream);' + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section + A.2.1.4. + + +File: libgomp.info, Node: acc_prof_register, Next: acc_prof_unregister, Prev: acc_set_cuda_stream, Up: OpenACC Runtime Library Routines + +6.39 'acc_prof_register' - Register callbacks. +============================================== + +_Description_: + This function registers callbacks. + +_C/C++_: + _Prototype_: 'void acc_prof_register (acc_event_t, acc_prof_callback, + acc_register_t);' + +_See also_: + *note OpenACC Profiling Interface:: + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section 5.3. + + +File: libgomp.info, Node: acc_prof_unregister, Next: acc_prof_lookup, Prev: acc_prof_register, Up: OpenACC Runtime Library Routines + +6.40 'acc_prof_unregister' - Unregister callbacks. +================================================== + +_Description_: + This function unregisters callbacks. + +_C/C++_: + _Prototype_: 'void acc_prof_unregister (acc_event_t, + acc_prof_callback, acc_register_t);' + +_See also_: + *note OpenACC Profiling Interface:: + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section 5.3. + + +File: libgomp.info, Node: acc_prof_lookup, Next: acc_register_library, Prev: acc_prof_unregister, Up: OpenACC Runtime Library Routines + +6.41 'acc_prof_lookup' - Obtain inquiry functions. +================================================== + +_Description_: + Function to obtain inquiry functions. + +_C/C++_: + _Prototype_: 'acc_query_fn acc_prof_lookup (const char *);' + +_See also_: + *note OpenACC Profiling Interface:: + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section 5.3. + + +File: libgomp.info, Node: acc_register_library, Prev: acc_prof_lookup, Up: OpenACC Runtime Library Routines + +6.42 'acc_register_library' - Library registration. +=================================================== + +_Description_: + Function for library registration. + +_C/C++_: + _Prototype_: 'void acc_register_library (acc_prof_reg, acc_prof_reg, + acc_prof_lookup_func);' + +_See also_: + *note OpenACC Profiling Interface::, *note ACC_PROFLIB:: + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section 5.3. + + +File: libgomp.info, Node: OpenACC Environment Variables, Next: CUDA Streams Usage, Prev: OpenACC Runtime Library Routines, Up: Top + +7 OpenACC Environment Variables +******************************* + +The variables 'ACC_DEVICE_TYPE' and 'ACC_DEVICE_NUM' are defined by +section 4 of the OpenACC specification in version 2.0. The variable +'ACC_PROFLIB' is defined by section 4 of the OpenACC specification in +version 2.6. + +* Menu: + +* ACC_DEVICE_TYPE:: +* ACC_DEVICE_NUM:: +* ACC_PROFLIB:: + + +File: libgomp.info, Node: ACC_DEVICE_TYPE, Next: ACC_DEVICE_NUM, Up: OpenACC Environment Variables + +7.1 'ACC_DEVICE_TYPE' +===================== + +_Description_: + Control the default device type to use when executing compute + regions. If unset, the code can be run on any device type, + favoring a non-host device type. + + Supported values in GCC (if compiled in) are + * 'host' + * 'nvidia' + * 'radeon' +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section 4.1. + + +File: libgomp.info, Node: ACC_DEVICE_NUM, Next: ACC_PROFLIB, Prev: ACC_DEVICE_TYPE, Up: OpenACC Environment Variables + +7.2 'ACC_DEVICE_NUM' +==================== + +_Description_: + Control which device, identified by device number, is the default + device. The value must be a nonnegative integer less than the + number of devices. If unset, device number zero is used. +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section 4.2. + + +File: libgomp.info, Node: ACC_PROFLIB, Prev: ACC_DEVICE_NUM, Up: OpenACC Environment Variables + +7.3 'ACC_PROFLIB' +================= + +_Description_: + Semicolon-separated list of dynamic libraries that are loaded as + profiling libraries. Each library must provide at least the + 'acc_register_library' routine. Each library file is found as + described by the documentation of 'dlopen' of your operating + system. +_See also_: + *note acc_register_library::, *note OpenACC Profiling Interface:: + +_Reference_: + OpenACC specification v2.6 (https://www.openacc.org), section 4.3. + + +File: libgomp.info, Node: CUDA Streams Usage, Next: OpenACC Library Interoperability, Prev: OpenACC Environment Variables, Up: Top + +8 CUDA Streams Usage +******************** + +This applies to the 'nvptx' plugin only. + + The library provides elements that perform asynchronous movement of +data and asynchronous operation of computing constructs. This +asynchronous functionality is implemented by making use of CUDA +streams(1). + + The primary means by that the asynchronous functionality is accessed +is through the use of those OpenACC directives which make use of the +'async' and 'wait' clauses. When the 'async' clause is first used with +a directive, it creates a CUDA stream. If an 'async-argument' is used +with the 'async' clause, then the stream is associated with the +specified 'async-argument'. + + Following the creation of an association between a CUDA stream and +the 'async-argument' of an 'async' clause, both the 'wait' clause and +the 'wait' directive can be used. When either the clause or directive +is used after stream creation, it creates a rendezvous point whereby +execution waits until all operations associated with the +'async-argument', that is, stream, have completed. + + Normally, the management of the streams that are created as a result +of using the 'async' clause, is done without any intervention by the +caller. This implies the association between the 'async-argument' and +the CUDA stream is maintained for the lifetime of the program. However, +this association can be changed through the use of the library function +'acc_set_cuda_stream'. When the function 'acc_set_cuda_stream' is +called, the CUDA stream that was originally associated with the 'async' +clause is destroyed. Caution should be taken when changing the +association as subsequent references to the 'async-argument' refer to a +different CUDA stream. + + ---------- Footnotes ---------- + + (1) See "Stream Management" in "CUDA Driver API", TRM-06703-001, +Version 5.5, for additional information + + +File: libgomp.info, Node: OpenACC Library Interoperability, Next: OpenACC Profiling Interface, Prev: CUDA Streams Usage, Up: Top + +9 OpenACC Library Interoperability +********************************** + +9.1 Introduction +================ + +The OpenACC library uses the CUDA Driver API, and may interact with +programs that use the Runtime library directly, or another library based +on the Runtime library, e.g., CUBLAS(1). This chapter describes the use +cases and what changes are required in order to use both the OpenACC +library and the CUBLAS and Runtime libraries within a program. + +9.2 First invocation: NVIDIA CUBLAS library API +=============================================== + +In this first use case (see below), a function in the CUBLAS library is +called prior to any of the functions in the OpenACC library. More +specifically, the function 'cublasCreate()'. + + When invoked, the function initializes the library and allocates the +hardware resources on the host and the device on behalf of the caller. +Once the initialization and allocation has completed, a handle is +returned to the caller. The OpenACC library also requires +initialization and allocation of hardware resources. Since the CUBLAS +library has already allocated the hardware resources for the device, all +that is left to do is to initialize the OpenACC library and acquire the +hardware resources on the host. + + Prior to calling the OpenACC function that initializes the library +and allocate the host hardware resources, you need to acquire the device +number that was allocated during the call to 'cublasCreate()'. The +invoking of the runtime library function 'cudaGetDevice()' accomplishes +this. Once acquired, the device number is passed along with the device +type as parameters to the OpenACC library function +'acc_set_device_num()'. + + Once the call to 'acc_set_device_num()' has completed, the OpenACC +library uses the context that was created during the call to +'cublasCreate()'. In other words, both libraries share the same +context. + + /* Create the handle */ + s = cublasCreate(&h); + if (s != CUBLAS_STATUS_SUCCESS) + { + fprintf(stderr, "cublasCreate failed %d\n", s); + exit(EXIT_FAILURE); + } + + /* Get the device number */ + e = cudaGetDevice(&dev); + if (e != cudaSuccess) + { + fprintf(stderr, "cudaGetDevice failed %d\n", e); + exit(EXIT_FAILURE); + } + + /* Initialize OpenACC library and use device 'dev' */ + acc_set_device_num(dev, acc_device_nvidia); + + Use Case 1 + +9.3 First invocation: OpenACC library API +========================================= + +In this second use case (see below), a function in the OpenACC library +is called prior to any of the functions in the CUBLAS library. More +specifically, the function 'acc_set_device_num()'. + + In the use case presented here, the function 'acc_set_device_num()' +is used to both initialize the OpenACC library and allocate the hardware +resources on the host and the device. In the call to the function, the +call parameters specify which device to use and what device type to use, +i.e., 'acc_device_nvidia'. It should be noted that this is but one +method to initialize the OpenACC library and allocate the appropriate +hardware resources. Other methods are available through the use of +environment variables and these is discussed in the next section. + + Once the call to 'acc_set_device_num()' has completed, other OpenACC +functions can be called as seen with multiple calls being made to +'acc_copyin()'. In addition, calls can be made to functions in the +CUBLAS library. In the use case a call to 'cublasCreate()' is made +subsequent to the calls to 'acc_copyin()'. As seen in the previous use +case, a call to 'cublasCreate()' initializes the CUBLAS library and +allocates the hardware resources on the host and the device. However, +since the device has already been allocated, 'cublasCreate()' only +initializes the CUBLAS library and allocates the appropriate hardware +resources on the host. The context that was created as part of the +OpenACC initialization is shared with the CUBLAS library, similarly to +the first use case. + + dev = 0; + + acc_set_device_num(dev, acc_device_nvidia); + + /* Copy the first set to the device */ + d_X = acc_copyin(&h_X[0], N * sizeof (float)); + if (d_X == NULL) + { + fprintf(stderr, "copyin error h_X\n"); + exit(EXIT_FAILURE); + } + + /* Copy the second set to the device */ + d_Y = acc_copyin(&h_Y1[0], N * sizeof (float)); + if (d_Y == NULL) + { + fprintf(stderr, "copyin error h_Y1\n"); + exit(EXIT_FAILURE); + } + + /* Create the handle */ + s = cublasCreate(&h); + if (s != CUBLAS_STATUS_SUCCESS) + { + fprintf(stderr, "cublasCreate failed %d\n", s); + exit(EXIT_FAILURE); + } + + /* Perform saxpy using CUBLAS library function */ + s = cublasSaxpy(h, N, &alpha, d_X, 1, d_Y, 1); + if (s != CUBLAS_STATUS_SUCCESS) + { + fprintf(stderr, "cublasSaxpy failed %d\n", s); + exit(EXIT_FAILURE); + } + + /* Copy the results from the device */ + acc_memcpy_from_device(&h_Y1[0], d_Y, N * sizeof (float)); + + Use Case 2 + +9.4 OpenACC library and environment variables +============================================= + +There are two environment variables associated with the OpenACC library +that may be used to control the device type and device number: +'ACC_DEVICE_TYPE' and 'ACC_DEVICE_NUM', respectively. These two +environment variables can be used as an alternative to calling +'acc_set_device_num()'. As seen in the second use case, the device type +and device number were specified using 'acc_set_device_num()'. If +however, the aforementioned environment variables were set, then the +call to 'acc_set_device_num()' would not be required. + + The use of the environment variables is only relevant when an OpenACC +function is called prior to a call to 'cudaCreate()'. If 'cudaCreate()' +is called prior to a call to an OpenACC function, then you must call +'acc_set_device_num()'(2) + + ---------- Footnotes ---------- + + (1) See section 2.26, "Interactions with the CUDA Driver API" in +"CUDA Runtime API", Version 5.5, and section 2.27, "VDPAU +Interoperability", in "CUDA Driver API", TRM-06703-001, Version 5.5, for +additional information on library interoperability. + + (2) More complete information about 'ACC_DEVICE_TYPE' and +'ACC_DEVICE_NUM' can be found in sections 4.1 and 4.2 of the OpenACC +(https://www.openacc.org) Application Programming Interface”, Version +2.6. + + +File: libgomp.info, Node: OpenACC Profiling Interface, Next: OpenMP-Implementation Specifics, Prev: OpenACC Library Interoperability, Up: Top + +10 OpenACC Profiling Interface +****************************** + +10.1 Implementation Status and Implementation-Defined Behavior +============================================================== + +We're implementing the OpenACC Profiling Interface as defined by the +OpenACC 2.6 specification. We're clarifying some aspects here as +_implementation-defined behavior_, while they're still under discussion +within the OpenACC Technical Committee. + + This implementation is tuned to keep the performance impact as low as +possible for the (very common) case that the Profiling Interface is not +enabled. This is relevant, as the Profiling Interface affects all the +_hot_ code paths (in the target code, not in the offloaded code). Users +of the OpenACC Profiling Interface can be expected to understand that +performance is impacted to some degree once the Profiling Interface is +enabled: for example, because of the _runtime_ (libgomp) calling into a +third-party _library_ for every event that has been registered. + + We're not yet accounting for the fact that 'OpenACC events may occur +during event processing'. We just handle one case specially, as +required by CUDA 9.0 'nvprof', that 'acc_get_device_type' (*note +acc_get_device_type::)) may be called from 'acc_ev_device_init_start', +'acc_ev_device_init_end' callbacks. + + We're not yet implementing initialization via a +'acc_register_library' function that is either statically linked in, or +dynamically via 'LD_PRELOAD'. Initialization via 'acc_register_library' +functions dynamically loaded via the 'ACC_PROFLIB' environment variable +does work, as does directly calling 'acc_prof_register', +'acc_prof_unregister', 'acc_prof_lookup'. + + As currently there are no inquiry functions defined, calls to +'acc_prof_lookup' always returns 'NULL'. + + There aren't separate _start_, _stop_ events defined for the event +types 'acc_ev_create', 'acc_ev_delete', 'acc_ev_alloc', 'acc_ev_free'. +It's not clear if these should be triggered before or after the actual +device-specific call is made. We trigger them after. + + Remarks about data provided to callbacks: + +'acc_prof_info.event_type' + It's not clear if for _nested_ event callbacks (for example, + 'acc_ev_enqueue_launch_start' as part of a parent compute + construct), this should be set for the nested event + ('acc_ev_enqueue_launch_start'), or if the value of the parent + construct should remain ('acc_ev_compute_construct_start'). In + this implementation, the value generally corresponds to the + innermost nested event type. + +'acc_prof_info.device_type' + + * For 'acc_ev_compute_construct_start', and in presence of an + 'if' clause with _false_ argument, this still refers to the + offloading device type. It's not clear if that's the expected + behavior. + + * Complementary to the item before, for + 'acc_ev_compute_construct_end', this is set to + 'acc_device_host' in presence of an 'if' clause with _false_ + argument. It's not clear if that's the expected behavior. + +'acc_prof_info.thread_id' + Always '-1'; not yet implemented. + +'acc_prof_info.async' + + * Not yet implemented correctly for + 'acc_ev_compute_construct_start'. + + * In a compute construct, for host-fallback + execution/'acc_device_host' it always is 'acc_async_sync'. It + is unclear if that is the expected behavior. + + * For 'acc_ev_device_init_start' and 'acc_ev_device_init_end', + it will always be 'acc_async_sync'. It is unclear if that is + the expected behavior. + +'acc_prof_info.async_queue' + There is no 'limited number of asynchronous queues' in libgomp. + This always has the same value as 'acc_prof_info.async'. + +'acc_prof_info.src_file' + Always 'NULL'; not yet implemented. + +'acc_prof_info.func_name' + Always 'NULL'; not yet implemented. + +'acc_prof_info.line_no' + Always '-1'; not yet implemented. + +'acc_prof_info.end_line_no' + Always '-1'; not yet implemented. + +'acc_prof_info.func_line_no' + Always '-1'; not yet implemented. + +'acc_prof_info.func_end_line_no' + Always '-1'; not yet implemented. + +'acc_event_info.event_type', 'acc_event_info.*.event_type' + Relating to 'acc_prof_info.event_type' discussed above, in this + implementation, this will always be the same value as + 'acc_prof_info.event_type'. + +'acc_event_info.*.parent_construct' + + * Will be 'acc_construct_parallel' for all OpenACC compute + constructs as well as many OpenACC Runtime API calls; should + be the one matching the actual construct, or + 'acc_construct_runtime_api', respectively. + + * Will be 'acc_construct_enter_data' or + 'acc_construct_exit_data' when processing variable mappings + specified in OpenACC _declare_ directives; should be + 'acc_construct_declare'. + + * For implicit 'acc_ev_device_init_start', + 'acc_ev_device_init_end', and explicit as well as implicit + 'acc_ev_alloc', 'acc_ev_free', 'acc_ev_enqueue_upload_start', + 'acc_ev_enqueue_upload_end', 'acc_ev_enqueue_download_start', + and 'acc_ev_enqueue_download_end', will be + 'acc_construct_parallel'; should reflect the real parent + construct. + +'acc_event_info.*.implicit' + For 'acc_ev_alloc', 'acc_ev_free', 'acc_ev_enqueue_upload_start', + 'acc_ev_enqueue_upload_end', 'acc_ev_enqueue_download_start', and + 'acc_ev_enqueue_download_end', this currently will be '1' also for + explicit usage. + +'acc_event_info.data_event.var_name' + Always 'NULL'; not yet implemented. + +'acc_event_info.data_event.host_ptr' + For 'acc_ev_alloc', and 'acc_ev_free', this is always 'NULL'. + +'typedef union acc_api_info' + ... as printed in '5.2.3. Third Argument: API-Specific + Information'. This should obviously be 'typedef _struct_ + acc_api_info'. + +'acc_api_info.device_api' + Possibly not yet implemented correctly for + 'acc_ev_compute_construct_start', 'acc_ev_device_init_start', + 'acc_ev_device_init_end': will always be 'acc_device_api_none' for + these event types. For 'acc_ev_enter_data_start', it will be + 'acc_device_api_none' in some cases. + +'acc_api_info.device_type' + Always the same as 'acc_prof_info.device_type'. + +'acc_api_info.vendor' + Always '-1'; not yet implemented. + +'acc_api_info.device_handle' + Always 'NULL'; not yet implemented. + +'acc_api_info.context_handle' + Always 'NULL'; not yet implemented. + +'acc_api_info.async_handle' + Always 'NULL'; not yet implemented. + + Remarks about certain event types: + +'acc_ev_device_init_start', 'acc_ev_device_init_end' + + * When a compute construct triggers implicit + 'acc_ev_device_init_start' and 'acc_ev_device_init_end' + events, they currently aren't _nested within_ the + corresponding 'acc_ev_compute_construct_start' and + 'acc_ev_compute_construct_end', but they're currently observed + _before_ 'acc_ev_compute_construct_start'. It's not clear + what to do: the standard asks us provide a lot of details to + the 'acc_ev_compute_construct_start' callback, without + (implicitly) initializing a device before? + + * Callbacks for these event types will not be invoked for calls + to the 'acc_set_device_type' and 'acc_set_device_num' + functions. It's not clear if they should be. + +'acc_ev_enter_data_start', 'acc_ev_enter_data_end', 'acc_ev_exit_data_start', 'acc_ev_exit_data_end' + + * Callbacks for these event types will also be invoked for + OpenACC _host_data_ constructs. It's not clear if they should + be. + + * Callbacks for these event types will also be invoked when + processing variable mappings specified in OpenACC _declare_ + directives. It's not clear if they should be. + + Callbacks for the following event types will be invoked, but dispatch +and information provided therein has not yet been thoroughly reviewed: + + * 'acc_ev_alloc' + * 'acc_ev_free' + * 'acc_ev_update_start', 'acc_ev_update_end' + * 'acc_ev_enqueue_upload_start', 'acc_ev_enqueue_upload_end' + * 'acc_ev_enqueue_download_start', 'acc_ev_enqueue_download_end' + + During device initialization, and finalization, respectively, +callbacks for the following event types will not yet be invoked: + + * 'acc_ev_alloc' + * 'acc_ev_free' + + Callbacks for the following event types have not yet been +implemented, so currently won't be invoked: + + * 'acc_ev_device_shutdown_start', 'acc_ev_device_shutdown_end' + * 'acc_ev_runtime_shutdown' + * 'acc_ev_create', 'acc_ev_delete' + * 'acc_ev_wait_start', 'acc_ev_wait_end' + + For the following runtime library functions, not all expected +callbacks will be invoked (mostly concerning implicit device +initialization): + + * 'acc_get_num_devices' + * 'acc_set_device_type' + * 'acc_get_device_type' + * 'acc_set_device_num' + * 'acc_get_device_num' + * 'acc_init' + * 'acc_shutdown' + + Aside from implicit device initialization, for the following runtime +library functions, no callbacks will be invoked for shared-memory +offloading devices (it's not clear if they should be): + + * 'acc_malloc' + * 'acc_free' + * 'acc_copyin', 'acc_present_or_copyin', 'acc_copyin_async' + * 'acc_create', 'acc_present_or_create', 'acc_create_async' + * 'acc_copyout', 'acc_copyout_async', 'acc_copyout_finalize', + 'acc_copyout_finalize_async' + * 'acc_delete', 'acc_delete_async', 'acc_delete_finalize', + 'acc_delete_finalize_async' + * 'acc_update_device', 'acc_update_device_async' + * 'acc_update_self', 'acc_update_self_async' + * 'acc_map_data', 'acc_unmap_data' + * 'acc_memcpy_to_device', 'acc_memcpy_to_device_async' + * 'acc_memcpy_from_device', 'acc_memcpy_from_device_async' + + +File: libgomp.info, Node: OpenMP-Implementation Specifics, Next: Offload-Target Specifics, Prev: OpenACC Profiling Interface, Up: Top + +11 OpenMP-Implementation Specifics +********************************** + +* Menu: + +* Implementation-defined ICV Initialization:: +* OpenMP Context Selectors:: +* Memory allocation:: + + +File: libgomp.info, Node: Implementation-defined ICV Initialization, Next: OpenMP Context Selectors, Up: OpenMP-Implementation Specifics + +11.1 Implementation-defined ICV Initialization +============================================== + +AFFINITY-FORMAT-VAR See *note OMP_AFFINITY_FORMAT::. +DEF-ALLOCATOR-VAR See *note OMP_ALLOCATOR::. +MAX-ACTIVE-LEVELS-VAR See *note OMP_MAX_ACTIVE_LEVELS::. +DYN-VAR See *note OMP_DYNAMIC::. +NTHREADS-VAR See *note OMP_NUM_THREADS::. +NUM-DEVICES-VAR Number of non-host devices found by GCC's + run-time library +NUM-PROCS-VAR The number of CPU cores on the initial device, + except that affinity settings might lead to a + smaller number. On non-host devices, the value + of the NTHREADS-VAR ICV. +PLACE-PARTITION-VAR See *note OMP_PLACES::. +RUN-SCHED-VAR See *note OMP_SCHEDULE::. +STACKSIZE-VAR See *note OMP_STACKSIZE::. +THREAD-LIMIT-VAR See *note OMP_TEAMS_THREAD_LIMIT:: +WAIT-POLICY-VAR See *note OMP_WAIT_POLICY:: and + *note GOMP_SPINCOUNT:: + + +File: libgomp.info, Node: OpenMP Context Selectors, Next: Memory allocation, Prev: Implementation-defined ICV Initialization, Up: OpenMP-Implementation Specifics + +11.2 OpenMP Context Selectors +============================= + +'vendor' is always 'gnu'. References are to the GCC manual. + + For the host compiler, 'kind' always matches 'host', 'cpu' and 'any'; +for the offloading architectures AMD GCN and Nvidia PTX, 'kind' always +matches 'nohost', 'gpu' and 'any'. For the x86 family of computers, AMD +GCN and Nvidia PTX the following traits are supported in addition; while +OpenMP is supported on more architectures, GCC currently does not match +any 'arch' or 'isa' traits for those. + +'arch' 'isa' +----------------------------------------------------------------------- +'x86', 'x86_64', 'i386', 'i486', 'i586', See '-m...' flags in +'i686', 'ia32' "x86 Options" + (without '-m') +'amdgcn', 'gcn' See '-march=' in + "AMD GCN Options" +'nvptx', 'nvptx64' See '-march=' in + "Nvidia PTX Options" + + +File: libgomp.info, Node: Memory allocation, Prev: OpenMP Context Selectors, Up: OpenMP-Implementation Specifics + +11.3 Memory allocation +====================== + +The description below applies to: + + * Explicit use of the OpenMP API routines, see *note Memory + Management Routines::. + * The 'allocate' clause, except when the 'allocator' modifier is a + constant expression with value 'omp_default_mem_alloc' and no + 'align' modifier has been specified. (In that case, the normal + 'malloc' allocation is used.) + * The 'allocate' directive for variables in static memory; while the + alignment is honored, the normal static memory is used. + * Using the 'allocate' directive for automatic/stack variables, + except when the 'allocator' clause is a constant expression with + value 'omp_default_mem_alloc' and no 'align' clause has been + specified. (In that case, the normal allocation is used: stack + allocation and, sometimes for Fortran, also 'malloc' [depending on + flags such as '-fstack-arrays'].) + * In Fortran, the 'allocators' directive and the executable + 'allocate' directive for Fortran pointers and allocatables is + supported, but requires that files containing those directives has + to be compiled with '-fopenmp-allocators'. Additionally, all files + that might explicitly or implicitly deallocate memory allocated + that way must also be compiled with that option. + * The used alignment is the maximum of the value the 'align' clause + and the alignment of the type after honoring, if present, the + 'aligned' ('GNU::aligned') attribute and C's '_Alignas' and C++'s + 'alignas'. However, the 'align' clause of the 'allocate' directive + has no effect on the value of C's '_Alignof' and C++'s 'alignof'. + + GCC supports the following predefined allocators and predefined +memory spaces: + +Predefined allocators Associated predefined memory + spaces +------------------------------------------------------------------ +omp_default_mem_alloc omp_default_mem_space +omp_large_cap_mem_alloc omp_large_cap_mem_space +omp_const_mem_alloc omp_const_mem_space +omp_high_bw_mem_alloc omp_high_bw_mem_space +omp_low_lat_mem_alloc omp_low_lat_mem_space +omp_cgroup_mem_alloc omp_low_lat_mem_space + (implementation defined) +omp_pteam_mem_alloc omp_low_lat_mem_space + (implementation defined) +omp_thread_mem_alloc omp_low_lat_mem_space + (implementation defined) +ompx_gnu_pinned_mem_alloc omp_default_mem_space (GNU + extension) + + Each predefined allocator, including 'omp_null_allocator', has a +corresponding allocator class template that meet the C++ allocator +completeness requirements. These are located in the 'omp::allocator' +namespace, and the 'ompx::allocator' namespace for gnu extensions. This +allows the allocator-aware C++ standard library containers to use OpenMP +allocation routines; for instance: + + std::vector> vec; + + The following allocator templates are supported: + +Predefined allocators Associated allocator template +------------------------------------------------------------------ +omp_null_allocator omp::allocator::null_allocator +omp_default_mem_alloc omp::allocator::default_mem +omp_large_cap_mem_alloc omp::allocator::large_cap_mem +omp_const_mem_alloc omp::allocator::const_mem +omp_high_bw_mem_alloc omp::allocator::high_bw_mem +omp_low_lat_mem_alloc omp::allocator::low_lat_mem +omp_cgroup_mem_alloc omp::allocator::cgroup_mem +omp_pteam_mem_alloc omp::allocator::pteam_mem +omp_thread_mem_alloc omp::allocator::thread_mem +ompx_gnu_pinned_mem_alloc ompx::allocator::gnu_pinned_mem + + The following traits are available when constructing a new allocator; +if a trait is not specified or with the value 'default', the specified +default value is used for that trait. The predefined allocators use the +default values of each trait, except that the 'omp_cgroup_mem_alloc', +'omp_pteam_mem_alloc', and 'omp_thread_mem_alloc' allocators have the +'access' trait set to 'cgroup', 'pteam', and 'thread', respectively. +For each trait, a named constant prefixed by 'omp_atk_' exists; for each +non-numeric value, a named constant prefixed by 'omp_atv_' exists. + +Trait Allowed values Default value +-------------------------------------------------------------------- +'sync_hint' 'contended', 'uncontended', 'contended' + 'serialized', 'private' +'alignment' Positive integer being a 1 byte + power of two +'access' 'all', 'cgroup', 'pteam', 'all' + 'thread' +'pool_size' Positive integer (bytes) See below. +'fallback' 'default_mem_fb', See below + 'null_fb', 'abort_fb', + 'allocator_fb' +'fb_data' _allocator handle_ (none) +'pinned' 'true', 'false' See below +'partition' 'environment', 'nearest', 'environment' + 'blocked', 'interleaved' + + For the 'fallback' trait, the default value is 'null_fb' for the +'omp_default_mem_alloc' allocator and any allocator that is associated +with device memory; for all other allocators, it is 'default_mem_fb' by +default. + + For the 'pinned' trait, the default value is 'true' for predefined +allocator 'ompx_gnu_pinned_mem_alloc' (a GNU extension), and 'false' for +all others. + + The following description applies to the initial device (the host) +and largely also to non-host devices; for the latter, also see *note +Offload-Target Specifics::. + + For the memory spaces, the following applies: + * 'omp_default_mem_space' is supported + * 'omp_const_mem_space' maps to 'omp_default_mem_space' + * 'omp_low_lat_mem_space' is only available on supported devices, and + maps to 'omp_default_mem_space' otherwise. + * 'omp_large_cap_mem_space' maps to 'omp_default_mem_space', unless + the memkind library is available + * 'omp_high_bw_mem_space' maps to 'omp_default_mem_space', unless the + memkind library is available + + On Linux systems, where the memkind library +(https://github.com/memkind/memkind) ('libmemkind.so.0') is available at +runtime and the respective memkind kind is supported, it is used when +creating memory allocators requesting + + * the 'partition' trait 'interleaved' except when the memory space is + 'omp_large_cap_mem_space' (uses 'MEMKIND_HBW_INTERLEAVE') + * the memory space is 'omp_high_bw_mem_space' (uses + 'MEMKIND_HBW_PREFERRED') + * the memory space is 'omp_large_cap_mem_space' (uses + 'MEMKIND_DAX_KMEM_ALL' or, if not available, 'MEMKIND_DAX_KMEM') + + On Linux systems, where the numa library +(https://github.com/numactl/numactl) ('libnuma.so.1') is available at +runtime, it used when creating memory allocators requesting + + * the 'partition' trait 'nearest', except when both the libmemkind + library is available and the memory space is either + 'omp_large_cap_mem_space' or 'omp_high_bw_mem_space' + + Note that the numa library will round up the allocation size to a +multiple of the system page size; therefore, consider using it only with +large data or by sharing allocations via the 'pool_size' trait. +Furthermore, the Linux kernel does not guarantee that an allocation will +always be on the nearest NUMA node nor that after reallocation the same +node will be used. Note additionally that, on Linux, the default +setting of the memory placement policy is to use the current node; +therefore, unless the memory placement policy has been overridden, the +'partition' trait 'environment' (the default) will be effectively a +'nearest' allocation. + + Additional notes regarding the traits: + * The 'pinned' trait is supported on Linux hosts, but is subject to + the OS 'ulimit'/'rlimit' locked memory settings. It currently uses + 'mmap' and is therefore optimized for few allocations, including + large data. If the conditions for numa or memkind allocations are + fulfilled, those allocators are used instead. + * The default for the 'pool_size' trait is no pool and for every + (re)allocation the associated library routine is called, which + might internally use a memory pool. Currently, the same applies + when a 'pool_size' has been specified, except that once allocations + exceed the the pool size, the action of the 'fallback' trait + applies. + * For the 'partition' trait, the partition part size will be the same + as the requested size (i.e. 'interleaved' or 'blocked' has no + effect), except for 'interleaved' when the memkind library is + available. Furthermore, for 'nearest' and unless the numa library + is available, the memory might not be on the same NUMA node as + thread that allocated the memory; on Linux, this is in particular + the case when the memory placement policy is set to preferred. + * The 'access' trait has no effect such that memory is always + accessible by all threads. (Except on supported no-host devices.) + * The 'sync_hint' trait has no effect. + + See also: *note Offload-Target Specifics:: + + +File: libgomp.info, Node: Offload-Target Specifics, Next: The libgomp ABI, Prev: OpenMP-Implementation Specifics, Up: Top + +12 Offload-Target Specifics +*************************** + +The following sections present notes on the offload-target specifics + +* Menu: + +* AMD Radeon:: +* nvptx:: + + +File: libgomp.info, Node: AMD Radeon, Next: nvptx, Up: Offload-Target Specifics + +12.1 AMD Radeon (GCN) +===================== + +* Menu: + +* Foreign-runtime support for AMD GPUs:: + +On the hardware side, there is the hierarchy (fine to coarse): + * work item (thread) + * wavefront + * work group + * compute unit (CU) + + All OpenMP and OpenACC levels are used, i.e. + * OpenMP's simd and OpenACC's vector map to work items (thread) + * OpenMP's threads ("parallel") and OpenACC's workers map to + wavefronts + * OpenMP's teams and OpenACC's gang use a threadpool with the size of + the number of teams or gangs, respectively. + + The used sizes are + * Number of teams is the specified 'num_teams' (OpenMP) or + 'num_gangs' (OpenACC) or otherwise the number of CU. It is limited + by two times the number of CU. + * Number of wavefronts is 4 for gfx900 and 16 otherwise; + 'num_threads' (OpenMP) and 'num_workers' (OpenACC) overrides this + if smaller. + * The wavefront has 102 scalars and 64 vectors + * Number of workitems is always 64 + * The hardware permits maximally 40 workgroups/CU and 16 + wavefronts/workgroup up to a limit of 40 wavefronts in total per + CU. + * 80 scalars registers and 24 vector registers in non-kernel + functions (the chosen procedure-calling API). + * For the kernel itself: as many as register pressure demands (number + of teams and number of threads, scaled down if registers are + exhausted) + + The implementation remark: + * I/O within OpenMP target regions and OpenACC compute regions is + supported using the C library 'printf' functions and the Fortran + 'print'/'write' statements. + * Reverse offload regions (i.e. 'target' regions with + 'device(ancestor:1)') are processed serially per 'target' region + such that the next reverse offload region is only executed after + the previous one returned. + * OpenMP code that has a 'requires' directive with 'self_maps' or + 'unified_shared_memory' is only supported if all AMD GPUs have the + 'HSA_AMD_SYSTEM_INFO_SVM_ACCESSIBLE_BY_DEFAULT' property; for + discrete GPUs, this may require setting the 'HSA_XNACK' environment + variable to '1'; for systems with both an APU and a discrete GPU + that does not support XNACK, consider using 'ROCR_VISIBLE_DEVICES' + to enable only the APU. If not supported, all AMD GPU devices are + removed from the list of available devices ("host fallback"). + * The available stack size can be changed using the 'GCN_STACK_SIZE' + environment variable; the default is 32 kiB per thread. + * Low-latency memory ('omp_low_lat_mem_space') is supported when the + the 'access' trait is set to 'cgroup'. The default pool size is + automatically scaled to share the 64 kiB LDS memory between the + number of teams configured to run on each compute-unit, but may be + adjusted at runtime by setting environment variable + 'GOMP_GCN_LOWLAT_POOL=BYTES'. + * 'omp_low_lat_mem_alloc' cannot be used with true low-latency memory + because the definition implies the 'omp_atv_all' trait; main + graphics memory is used instead. + * 'omp_cgroup_mem_alloc', 'omp_pteam_mem_alloc', and + 'omp_thread_mem_alloc', all use low-latency memory as first + preference, and fall back to main graphics memory when the + low-latency pool is exhausted. + * The OpenMP routines 'omp_target_memcpy_rect' and + 'omp_target_memcpy_rect_async' and the 'target update' directive + for non-contiguous list items use the 3D memory-copy function of + the HSA library. Higher dimensions call this functions in a loop + and are therefore supported. + * The unique identifier (UID), used with OpenMP's API UID routines, + is the value returned by the HSA runtime library for + 'HSA_AMD_AGENT_INFO_UUID'. For GPUs, it is currently 'GPU-' + followed by 16 lower-case hex digits, yielding a string like + 'GPU-f914a2142fc3413a'. The output matches the one used by + 'rocminfo'. + + +File: libgomp.info, Node: Foreign-runtime support for AMD GPUs, Up: AMD Radeon + +12.1.1 OpenMP 'interop' - Foreign-Runtime Support for AMD GPUs +-------------------------------------------------------------- + +On AMD GPUs, the foreign runtimes are HIP (C++ Heterogeneous-Compute +Interface for Portability) and HSA (Heterogeneous System Architecture), +where HIP is the default. The interop object is created using OpenMP's +'interop' directive or, implicitly, when invoking a 'declare variant' +procedure that has the 'append_args' clause. In either case, the +'prefer_type' modifier determines whether HIP or HSA is used. + + When specifying the 'targetsync' modifier: For HIP, a stream is +created using 'hipStreamCreate'. For HSA, a queue is created of type +'HSA_QUEUE_TYPE_MULTI' with a queue size of 64. + + Invoke the *note Interoperability Routines:: on an interop object to +obtain the following properties. For properties with integral (int), +pointer (ptr), or string (str) data type, call 'omp_get_interop_int', +'omp_get_interop_ptr', or 'omp_get_interop_str', respectively. Note +that 'device_num' is the OpenMP device number while 'device' is the HIP +device number or HSA device handle. + + When using HIP with C and C++, the '__HIP_PLATFORM_AMD__' +preprocessor macro must be defined before including the HIP header +files. + + For the API routine call, add the prefix 'omp_ipr_' to the property +name; for instance: + omp_interop_rc_t ret; + int device_num = omp_get_interop_int (my_interop_obj, omp_ipr_device_num, &ret); + +Available properties for an HIP interop object: + +Property C data type API routine value (if + constant) +----------------------------------------------------------------------- +'fr_id' 'omp_interop_fr_t' int 'omp_fr_hip' +'fr_name' 'const char *' str '"hip"' +'vendor' 'int' int '1' +'vendor_name' 'const char *' str '"amd"' +'device_num' 'int' int +'platform' N/A +'device' 'hipDevice_t' int +'device_context''hipCtx_t' ptr +'targetsync' 'hipStream_t' ptr + +Available properties for an HSA interop object: + +Property C data type API routine value (if + constant) +----------------------------------------------------------------------- +'fr_id' 'omp_interop_fr_t' int 'omp_fr_hsa' +'fr_name' 'const char *' str '"hsa"' +'vendor' 'int' int '1' +'vendor_name' 'const char *' str '"amd"' +'device_num' 'int' int +'platform' N/A +'device' 'hsa_agent *' ptr +'device_context'N/A +'targetsync' 'hsa_queue *' ptr + + +File: libgomp.info, Node: nvptx, Prev: AMD Radeon, Up: Offload-Target Specifics + +12.2 nvptx +========== + +* Menu: + +* Foreign-runtime support for Nvidia GPUs:: + +On the hardware side, there is the hierarchy (fine to coarse): + * thread + * warp + * thread block + * streaming multiprocessor + + All OpenMP and OpenACC levels are used, i.e. + * OpenMP's simd and OpenACC's vector map to threads + * OpenMP's threads ("parallel") and OpenACC's workers map to warps + * OpenMP's teams and OpenACC's gang use a threadpool with the size of + the number of teams or gangs, respectively. + + The used sizes are + * The 'warp_size' is always 32 + * CUDA kernel launched: 'dim={#teams,1,1}, + blocks={#threads,warp_size,1}'. + * The number of teams is limited by the number of blocks the device + can host simultaneously. + + Additional information can be obtained by setting the environment +variable to 'GOMP_DEBUG=1' (very verbose; grep for 'kernel.*launch' for +launch parameters). + + GCC generates generic PTX ISA code, which is just-in-time compiled by +CUDA, which caches the JIT in the user's directory (see CUDA +documentation; can be tuned by the environment variables +'CUDA_CACHE_{DISABLE,MAXSIZE,PATH}'. + + Note: While PTX ISA is generic, the '-mptx=' and '-march=' +commandline options still affect the used PTX ISA code and, thus, the +requirements on CUDA version and hardware. + + The implementation remark: + * I/O within OpenMP target regions and OpenACC compute regions is + supported using the C library 'printf' functions. Additionally, + the Fortran 'print'/'write' statements are supported within OpenMP + target regions, but not yet within OpenACC compute regions. + * Compilation OpenMP code that contains 'requires reverse_offload' + requires at least '-march=sm_35', compiling for '-march=sm_30' is + not supported. + * For code containing reverse offload (i.e. 'target' regions with + 'device(ancestor:1)'), there is a slight performance penalty for + _all_ target regions, consisting mostly of shutdown delay Per + device, reverse offload regions are processed serially such that + the next reverse offload region is only executed after the previous + one returned. + * OpenMP code that has a 'requires' directive with 'self_maps' or + 'unified_shared_memory' runs on nvptx devices if and only if all of + those support the 'pageableMemoryAccess' property;(1) otherwise, + all nvptx device are removed from the list of available devices + ("host fallback"). + * The default per-warp stack size is 128 kiB; see also '-msoft-stack' + in the GCC manual. + * Low-latency memory ('omp_low_lat_mem_space') is supported when the + the 'access' trait is set to 'cgroup', and libgomp has been built + for PTX ISA version 4.1 or higher (such as in GCC's default + configuration). The default pool size is 8 kiB per team, but may + be adjusted at runtime by setting environment variable + 'GOMP_NVPTX_LOWLAT_POOL=BYTES'. The maximum value is limited by + the available hardware, and care should be taken that the selected + pool size does not unduly limit the number of teams that can run + simultaneously. + * 'omp_low_lat_mem_alloc' cannot be used with true low-latency memory + because the definition implies the 'omp_atv_all' trait; main + graphics memory is used instead. + * 'omp_cgroup_mem_alloc', 'omp_pteam_mem_alloc', and + 'omp_thread_mem_alloc', all use low-latency memory as first + preference, and fall back to main graphics memory when the + low-latency pool is exhausted. + * The OpenMP routines 'omp_target_memcpy_rect' and + 'omp_target_memcpy_rect_async' and the 'target update' directive + for non-contiguous list items use the 2D and 3D memory-copy + functions of the CUDA library. Higher dimensions call those + functions in a loop and are therefore supported. + * The unique identifier (UID), used with OpenMP's API UID routines, + consists of the 'GPU-' prefix followed by the 16-bytes UUID as + returned by the CUDA runtime library. This UUID is output in + grouped lower-case hex digits; the grouping of those 32 digits is: + 8 digits, hyphen, 4 digits, hyphen, 4 digits, hyphen, 16 digits. + This leads to a string like + 'GPU-a8081c9e-f03e-18eb-1827-bf5ba95afa5d'. The output matches the + format used by 'nvidia-smi'. + + ---------- Footnotes ---------- + + (1) + + + +File: libgomp.info, Node: Foreign-runtime support for Nvidia GPUs, Up: nvptx + +12.2.1 OpenMP 'interop' - Foreign-Runtime Support for Nvidia GPUs +----------------------------------------------------------------- + +On Nvidia GPUs, the foreign runtimes APIs are the CUDA runtime API, the +CUDA driver API, and HIP, the C++ Heterogeneous-Compute Interface for +Portability that is--on CUDA-based systems--a very thin layer on top of +the CUDA API. By default, CUDA is used. The interop object is created +using OpenMP's 'interop' directive or, implicitly, when invoking a +'declare variant' procedure that has the 'append_args' clause. In +either case, the 'prefer_type' modifier determines whether CUDA, CUDA +driver, or HSA is used. + + When specifying the 'targetsync' modifier, a CUDA stream is created +using the 'CU_STREAM_DEFAULT' flag. + + Invoke the *note Interoperability Routines:: on an interop object to +obtain the following properties. For properties with integral (int), +pointer (ptr), or string (str) data type, call 'omp_get_interop_int', +'omp_get_interop_ptr', or 'omp_get_interop_str', respectively. Note +that 'device_num' is the OpenMP device number while 'device' is the +CUDA, CUDA Driver, or HIP device number. + + When using HIP with C and C++, the '__HIP_PLATFORM_NVIDIA__' +preprocessor macro must be defined before including the HIP header +files. + + For the API routine call, add the prefix 'omp_ipr_' to the property +name; for instance: + omp_interop_rc_t ret; + int device_num = omp_get_interop_int (my_interop_obj, omp_ipr_device_num, &ret); + +Available properties for a CUDA runtime API interop object: + +Property C data type API routine value (if + constant) +----------------------------------------------------------------------- +'fr_id' 'omp_interop_fr_t' int 'omp_fr_cuda' +'fr_name' 'const char *' str '"cuda"' +'vendor' 'int' int '11' +'vendor_name' 'const char *' str '"nvidia"' +'device_num' 'int' int +'platform' N/A +'device' 'int' int +'device_context'N/A +'targetsync' 'cudaStream_t' ptr + +Available properties for a CUDA driver API interop object: + +Property C data type API routine value (if + constant) +----------------------------------------------------------------------- +'fr_id' 'omp_interop_fr_t' int 'omp_fr_cuda_driver' +'fr_name' 'const char *' str '"cuda_driver"' +'vendor' 'int' int '11' +'vendor_name' 'const char *' str '"nvidia"' +'device_num' 'int' int +'platform' N/A +'device' 'CUdevice' int +'device_context''CUcontext' ptr +'targetsync' 'CUstream' ptr + +Available properties for an HIP interop object: + +Property C data type API routine value (if + constant) +----------------------------------------------------------------------- +'fr_id' 'omp_interop_fr_t' int 'omp_fr_hip' +'fr_name' 'const char *' str '"hip"' +'vendor' 'int' int '11' +'vendor_name' 'const char *' str '"nvidia"' +'device_num' 'int' int +'platform' N/A +'device' 'hipDevice_t' int +'device_context''hipCtx_t' ptr +'targetsync' 'hipStream_t' ptr + + +File: libgomp.info, Node: The libgomp ABI, Next: Reporting Bugs, Prev: Offload-Target Specifics, Up: Top + +13 The libgomp ABI +****************** + +The following sections present notes on the external ABI as presented by +libgomp. Only maintainers should need them. + +* Menu: + +* Implementing MASTER construct:: +* Implementing CRITICAL construct:: +* Implementing ATOMIC construct:: +* Implementing FLUSH construct:: +* Implementing BARRIER construct:: +* Implementing THREADPRIVATE construct:: +* Implementing PRIVATE clause:: +* Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses:: +* Implementing REDUCTION clause:: +* Implementing PARALLEL construct:: +* Implementing FOR construct:: +* Implementing ORDERED construct:: +* Implementing SECTIONS construct:: +* Implementing SINGLE construct:: +* Implementing OpenACC's PARALLEL construct:: + + +File: libgomp.info, Node: Implementing MASTER construct, Next: Implementing CRITICAL construct, Up: The libgomp ABI + +13.1 Implementing MASTER construct +================================== + + if (omp_get_thread_num () == 0) + block + + Alternately, we generate two copies of the parallel subfunction and +only include this in the version run by the primary thread. Surely this +is not worthwhile though... + + +File: libgomp.info, Node: Implementing CRITICAL construct, Next: Implementing ATOMIC construct, Prev: Implementing MASTER construct, Up: The libgomp ABI + +13.2 Implementing CRITICAL construct +==================================== + +Without a specified name, + + void GOMP_critical_start (void); + void GOMP_critical_end (void); + + so that we don't get COPY relocations from libgomp to the main +application. + + With a specified name, use omp_set_lock and omp_unset_lock with name +being transformed into a variable declared like + + omp_lock_t gomp_critical_user_ __attribute__((common)) + + Ideally the ABI would specify that all zero is a valid unlocked +state, and so we wouldn't need to initialize this at startup. + + +File: libgomp.info, Node: Implementing ATOMIC construct, Next: Implementing FLUSH construct, Prev: Implementing CRITICAL construct, Up: The libgomp ABI + +13.3 Implementing ATOMIC construct +================================== + +The target should implement the '__sync' builtins. + + Failing that we could add + + void GOMP_atomic_enter (void) + void GOMP_atomic_exit (void) + + which reuses the regular lock code, but with yet another lock object +private to the library. + + +File: libgomp.info, Node: Implementing FLUSH construct, Next: Implementing BARRIER construct, Prev: Implementing ATOMIC construct, Up: The libgomp ABI + +13.4 Implementing FLUSH construct +================================= + +Expands to the '__sync_synchronize' builtin. + + +File: libgomp.info, Node: Implementing BARRIER construct, Next: Implementing THREADPRIVATE construct, Prev: Implementing FLUSH construct, Up: The libgomp ABI + +13.5 Implementing BARRIER construct +=================================== + + void GOMP_barrier (void) + + +File: libgomp.info, Node: Implementing THREADPRIVATE construct, Next: Implementing PRIVATE clause, Prev: Implementing BARRIER construct, Up: The libgomp ABI + +13.6 Implementing THREADPRIVATE construct +========================================= + +In _most_ cases we can map this directly to '__thread'. Except that OMP +allows constructors for C++ objects. We can either refuse to support +this (how often is it used?) or we can implement something akin to +.ctors. + + Even more ideally, this ctor feature is handled by extensions to the +main pthreads library. Failing that, we can have a set of entry points +to register ctor functions to be called. + + +File: libgomp.info, Node: Implementing PRIVATE clause, Next: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Prev: Implementing THREADPRIVATE construct, Up: The libgomp ABI + +13.7 Implementing PRIVATE clause +================================ + +In association with a PARALLEL, or within the lexical extent of a +PARALLEL block, the variable becomes a local variable in the parallel +subfunction. + + In association with FOR or SECTIONS blocks, create a new automatic +variable within the current function. This preserves the semantic of +new variable creation. + + +File: libgomp.info, Node: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Next: Implementing REDUCTION clause, Prev: Implementing PRIVATE clause, Up: The libgomp ABI + +13.8 Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses +========================================================================= + +This seems simple enough for PARALLEL blocks. Create a private struct +for communicating between the parent and subfunction. In the parent, +copy in values for scalar and "small" structs; copy in addresses for +others TREE_ADDRESSABLE types. In the subfunction, copy the value into +the local variable. + + It is not clear what to do with bare FOR or SECTION blocks. The only +thing I can figure is that we do something like: + + #pragma omp for firstprivate(x) lastprivate(y) + for (int i = 0; i < n; ++i) + body; + + which becomes + + { + int x = x, y; + + // for stuff + + if (i == n) + y = y; + } + + where the "x=x" and "y=y" assignments actually have different uids +for the two variables, i.e. not something you could write directly in +C. Presumably this only makes sense if the "outer" x and y are global +variables. + + COPYPRIVATE would work the same way, except the structure broadcast +would have to happen via SINGLE machinery instead. + + +File: libgomp.info, Node: Implementing REDUCTION clause, Next: Implementing PARALLEL construct, Prev: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Up: The libgomp ABI + +13.9 Implementing REDUCTION clause +================================== + +The private struct mentioned in the previous section should have a +pointer to an array of the type of the variable, indexed by the thread's +TEAM_ID. The thread stores its final value into the array, and after +the barrier, the primary thread iterates over the array to collect the +values. + + +File: libgomp.info, Node: Implementing PARALLEL construct, Next: Implementing FOR construct, Prev: Implementing REDUCTION clause, Up: The libgomp ABI + +13.10 Implementing PARALLEL construct +===================================== + + #pragma omp parallel + { + body; + } + + becomes + + void subfunction (void *data) + { + use data; + body; + } + + setup data; + GOMP_parallel_start (subfunction, &data, num_threads); + subfunction (&data); + GOMP_parallel_end (); + + void GOMP_parallel_start (void (*fn)(void *), void *data, unsigned num_threads) + + The FN argument is the subfunction to be run in parallel. + + The DATA argument is a pointer to a structure used to communicate +data in and out of the subfunction, as discussed above with respect to +FIRSTPRIVATE et al. + + The NUM_THREADS argument is 1 if an IF clause is present and false, +or the value of the NUM_THREADS clause, if present, or 0. + + The function needs to create the appropriate number of threads and/or +launch them from the dock. It needs to create the team structure and +assign team ids. + + void GOMP_parallel_end (void) + + Tears down the team and returns us to the previous +'omp_in_parallel()' state. + + +File: libgomp.info, Node: Implementing FOR construct, Next: Implementing ORDERED construct, Prev: Implementing PARALLEL construct, Up: The libgomp ABI + +13.11 Implementing FOR construct +================================ + + #pragma omp parallel for + for (i = lb; i <= ub; i++) + body; + + becomes + + void subfunction (void *data) + { + long _s0, _e0; + while (GOMP_loop_static_next (&_s0, &_e0)) + { + long _e1 = _e0, i; + for (i = _s0; i < _e1; i++) + body; + } + GOMP_loop_end_nowait (); + } + + GOMP_parallel_loop_static (subfunction, NULL, 0, lb, ub+1, 1, 0); + subfunction (NULL); + GOMP_parallel_end (); + + #pragma omp for schedule(runtime) + for (i = 0; i < n; i++) + body; + + becomes + + { + long i, _s0, _e0; + if (GOMP_loop_runtime_start (0, n, 1, &_s0, &_e0)) + do { + long _e1 = _e0; + for (i = _s0, i < _e0; i++) + body; + } while (GOMP_loop_runtime_next (&_s0, _&e0)); + GOMP_loop_end (); + } + + Note that while it looks like there is trickiness to propagating a +non-constant STEP, there isn't really. We're explicitly allowed to +evaluate it as many times as we want, and any variables involved should +automatically be handled as PRIVATE or SHARED like any other variables. +So the expression should remain evaluable in the subfunction. We can +also pull it into a local variable if we like, but since its supposed to +remain unchanged, we can also not if we like. + + If we have SCHEDULE(STATIC), and no ORDERED, then we ought to be able +to get away with no work-sharing context at all, since we can simply +perform the arithmetic directly in each thread to divide up the +iterations. Which would mean that we wouldn't need to call any of these +routines. + + There are separate routines for handling loops with an ORDERED +clause. Bookkeeping for that is non-trivial... + + +File: libgomp.info, Node: Implementing ORDERED construct, Next: Implementing SECTIONS construct, Prev: Implementing FOR construct, Up: The libgomp ABI + +13.12 Implementing ORDERED construct +==================================== + + void GOMP_ordered_start (void) + void GOMP_ordered_end (void) + + +File: libgomp.info, Node: Implementing SECTIONS construct, Next: Implementing SINGLE construct, Prev: Implementing ORDERED construct, Up: The libgomp ABI + +13.13 Implementing SECTIONS construct +===================================== + +A block as + + #pragma omp sections + { + #pragma omp section + stmt1; + #pragma omp section + stmt2; + #pragma omp section + stmt3; + } + + becomes + + for (i = GOMP_sections_start (3); i != 0; i = GOMP_sections_next ()) + switch (i) + { + case 1: + stmt1; + break; + case 2: + stmt2; + break; + case 3: + stmt3; + break; + } + GOMP_barrier (); + + +File: libgomp.info, Node: Implementing SINGLE construct, Next: Implementing OpenACC's PARALLEL construct, Prev: Implementing SECTIONS construct, Up: The libgomp ABI + +13.14 Implementing SINGLE construct +=================================== + +A block like + + #pragma omp single + { + body; + } + + becomes + + if (GOMP_single_start ()) + body; + GOMP_barrier (); + + while + + #pragma omp single copyprivate(x) + body; + + becomes + + datap = GOMP_single_copy_start (); + if (datap == NULL) + { + body; + data.x = x; + GOMP_single_copy_end (&data); + } + else + x = datap->x; + GOMP_barrier (); + + +File: libgomp.info, Node: Implementing OpenACC's PARALLEL construct, Prev: Implementing SINGLE construct, Up: The libgomp ABI + +13.15 Implementing OpenACC's PARALLEL construct +=============================================== + + void GOACC_parallel () + + +File: libgomp.info, Node: Reporting Bugs, Next: Copying, Prev: The libgomp ABI, Up: Top + +14 Reporting Bugs +***************** + +Bugs in the GNU Offloading and Multi Processing Runtime Library should +be reported via Bugzilla (https://gcc.gnu.org/bugzilla/). Please add +"openacc", or "openmp", or both to the keywords field in the bug report, +as appropriate. + + +File: libgomp.info, Node: Copying, Next: GNU Free Documentation License, Prev: Reporting Bugs, Up: Top + +GNU General Public License +************************** + + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + + Everyone is permitted to copy and distribute verbatim copies of this + license document, but changing it is not allowed. + +Preamble +======== + +The GNU General Public License is a free, copyleft license for software +and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program-to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + +TERMS AND CONDITIONS +==================== + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public + License. + + "Copyright" also means copyright-like laws that apply to other + kinds of works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this + License. Each licensee is addressed as "you". "Licensees" and + "recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the + work in a fashion requiring copyright permission, other than the + making of an exact copy. The resulting work is called a "modified + version" of the earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work + based on the Program. + + To "propagate" a work means to do anything with it that, without + permission, would make you directly or secondarily liable for + infringement under applicable copyright law, except executing it on + a computer or modifying a private copy. Propagation includes + copying, distribution (with or without modification), making + available to the public, and in some countries other activities as + well. + + To "convey" a work means any kind of propagation that enables other + parties to make or receive copies. Mere interaction with a user + through a computer network, with no transfer of a copy, is not + conveying. + + An interactive user interface displays "Appropriate Legal Notices" + to the extent that it includes a convenient and prominently visible + feature that (1) displays an appropriate copyright notice, and (2) + tells the user that there is no warranty for the work (except to + the extent that warranties are provided), that licensees may convey + the work under this License, and how to view a copy of this + License. If the interface presents a list of user commands or + options, such as a menu, a prominent item in the list meets this + criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work + for making modifications to it. "Object code" means any non-source + form of a work. + + A "Standard Interface" means an interface that either is an + official standard defined by a recognized standards body, or, in + the case of interfaces specified for a particular programming + language, one that is widely used among developers working in that + language. + + The "System Libraries" of an executable work include anything, + other than the work as a whole, that (a) is included in the normal + form of packaging a Major Component, but which is not part of that + Major Component, and (b) serves only to enable use of the work with + that Major Component, or to implement a Standard Interface for + which an implementation is available to the public in source code + form. A "Major Component", in this context, means a major + essential component (kernel, window system, and so on) of the + specific operating system (if any) on which the executable work + runs, or a compiler used to produce the work, or an object code + interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all + the source code needed to generate, install, and (for an executable + work) run the object code and to modify the work, including scripts + to control those activities. However, it does not include the + work's System Libraries, or general-purpose tools or generally + available free programs which are used unmodified in performing + those activities but which are not part of the work. For example, + Corresponding Source includes interface definition files associated + with source files for the work, and the source code for shared + libraries and dynamically linked subprograms that the work is + specifically designed to require, such as by intimate data + communication or control flow between those subprograms and other + parts of the work. + + The Corresponding Source need not include anything that users can + regenerate automatically from other parts of the Corresponding + Source. + + The Corresponding Source for a work in source code form is that + same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of + copyright on the Program, and are irrevocable provided the stated + conditions are met. This License explicitly affirms your unlimited + permission to run the unmodified Program. The output from running + a covered work is covered by this License only if the output, given + its content, constitutes a covered work. This License acknowledges + your rights of fair use or other equivalent, as provided by + copyright law. + + You may make, run and propagate covered works that you do not + convey, without conditions so long as your license otherwise + remains in force. You may convey covered works to others for the + sole purpose of having them make modifications exclusively for you, + or provide you with facilities for running those works, provided + that you comply with the terms of this License in conveying all + material for which you do not control copyright. Those thus making + or running the covered works for you must do so exclusively on your + behalf, under your direction and control, on terms that prohibit + them from making any copies of your copyrighted material outside + their relationship with you. + + Conveying under any other circumstances is permitted solely under + the conditions stated below. Sublicensing is not allowed; section + 10 makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological + measure under any applicable law fulfilling obligations under + article 11 of the WIPO copyright treaty adopted on 20 December + 1996, or similar laws prohibiting or restricting circumvention of + such measures. + + When you convey a covered work, you waive any legal power to forbid + circumvention of technological measures to the extent such + circumvention is effected by exercising rights under this License + with respect to the covered work, and you disclaim any intention to + limit operation or modification of the work as a means of + enforcing, against the work's users, your or third parties' legal + rights to forbid circumvention of technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you + receive it, in any medium, provided that you conspicuously and + appropriately publish on each copy an appropriate copyright notice; + keep intact all notices stating that this License and any + non-permissive terms added in accord with section 7 apply to the + code; keep intact all notices of the absence of any warranty; and + give all recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, + and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to + produce it from the Program, in the form of source code under the + terms of section 4, provided that you also meet all of these + conditions: + + a. The work must carry prominent notices stating that you + modified it, and giving a relevant date. + + b. The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in + section 4 to "keep intact all notices". + + c. You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable + section 7 additional terms, to the whole of the work, and all + its parts, regardless of how they are packaged. This License + gives no permission to license the work in any other way, but + it does not invalidate such permission if you have separately + received it. + + d. If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has + interactive interfaces that do not display Appropriate Legal + Notices, your work need not make them do so. + + A compilation of a covered work with other separate and independent + works, which are not by their nature extensions of the covered + work, and which are not combined with it such as to form a larger + program, in or on a volume of a storage or distribution medium, is + called an "aggregate" if the compilation and its resulting + copyright are not used to limit the access or legal rights of the + compilation's users beyond what the individual works permit. + Inclusion of a covered work in an aggregate does not cause this + License to apply to the other parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms + of sections 4 and 5, provided that you also convey the + machine-readable Corresponding Source under the terms of this + License, in one of these ways: + + a. Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b. Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that + product model, to give anyone who possesses the object code + either (1) a copy of the Corresponding Source for all the + software in the product that is covered by this License, on a + durable physical medium customarily used for software + interchange, for a price no more than your reasonable cost of + physically performing this conveying of source, or (2) access + to copy the Corresponding Source from a network server at no + charge. + + c. Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, + and only if you received the object code with such an offer, + in accord with subsection 6b. + + d. Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to + the Corresponding Source in the same way through the same + place at no further charge. You need not require recipients + to copy the Corresponding Source along with the object code. + If the place to copy the object code is a network server, the + Corresponding Source may be on a different server (operated by + you or a third party) that supports equivalent copying + facilities, provided you maintain clear directions next to the + object code saying where to find the Corresponding Source. + Regardless of what server hosts the Corresponding Source, you + remain obligated to ensure that it is available for as long as + needed to satisfy these requirements. + + e. Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the + general public at no charge under subsection 6d. + + A separable portion of the object code, whose source code is + excluded from the Corresponding Source as a System Library, need + not be included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means + any tangible personal property which is normally used for personal, + family, or household purposes, or (2) anything designed or sold for + incorporation into a dwelling. In determining whether a product is + a consumer product, doubtful cases shall be resolved in favor of + coverage. For a particular product received by a particular user, + "normally used" refers to a typical or common use of that class of + product, regardless of the status of the particular user or of the + way in which the particular user actually uses, or expects or is + expected to use, the product. A product is a consumer product + regardless of whether the product has substantial commercial, + industrial or non-consumer uses, unless such uses represent the + only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, + procedures, authorization keys, or other information required to + install and execute modified versions of a covered work in that + User Product from a modified version of its Corresponding Source. + The information must suffice to ensure that the continued + functioning of the modified object code is in no case prevented or + interfered with solely because modification has been made. + + If you convey an object code work under this section in, or with, + or specifically for use in, a User Product, and the conveying + occurs as part of a transaction in which the right of possession + and use of the User Product is transferred to the recipient in + perpetuity or for a fixed term (regardless of how the transaction + is characterized), the Corresponding Source conveyed under this + section must be accompanied by the Installation Information. But + this requirement does not apply if neither you nor any third party + retains the ability to install modified object code on the User + Product (for example, the work has been installed in ROM). + + The requirement to provide Installation Information does not + include a requirement to continue to provide support service, + warranty, or updates for a work that has been modified or installed + by the recipient, or for the User Product in which it has been + modified or installed. Access to a network may be denied when the + modification itself materially and adversely affects the operation + of the network or violates the rules and protocols for + communication across the network. + + Corresponding Source conveyed, and Installation Information + provided, in accord with this section must be in a format that is + publicly documented (and with an implementation available to the + public in source code form), and must require no special password + or key for unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of + this License by making exceptions from one or more of its + conditions. Additional permissions that are applicable to the + entire Program shall be treated as though they were included in + this License, to the extent that they are valid under applicable + law. If additional permissions apply only to part of the Program, + that part may be used separately under those permissions, but the + entire Program remains governed by this License without regard to + the additional permissions. + + When you convey a copy of a covered work, you may at your option + remove any additional permissions from that copy, or from any part + of it. (Additional permissions may be written to require their own + removal in certain cases when you modify the work.) You may place + additional permissions on material, added by you to a covered work, + for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material + you add to a covered work, you may (if authorized by the copyright + holders of that material) supplement the terms of this License with + terms: + + a. Disclaiming warranty or limiting liability differently from + the terms of sections 15 and 16 of this License; or + + b. Requiring preservation of specified reasonable legal notices + or author attributions in that material or in the Appropriate + Legal Notices displayed by works containing it; or + + c. Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked + in reasonable ways as different from the original version; or + + d. Limiting the use for publicity purposes of names of licensors + or authors of the material; or + + e. Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f. Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified + versions of it) with contractual assumptions of liability to + the recipient, for any liability that these contractual + assumptions directly impose on those licensors and authors. + + All other non-permissive additional terms are considered "further + restrictions" within the meaning of section 10. If the Program as + you received it, or any part of it, contains a notice stating that + it is governed by this License along with a term that is a further + restriction, you may remove that term. If a license document + contains a further restriction but permits relicensing or conveying + under this License, you may add to a covered work material governed + by the terms of that license document, provided that the further + restriction does not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you + must place, in the relevant source files, a statement of the + additional terms that apply to those files, or a notice indicating + where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in + the form of a separately written license, or stated as exceptions; + the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly + provided under this License. Any attempt otherwise to propagate or + modify it is void, and will automatically terminate your rights + under this License (including any patent licenses granted under the + third paragraph of section 11). + + However, if you cease all violation of this License, then your + license from a particular copyright holder is reinstated (a) + provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and (b) permanently, if the + copyright holder fails to notify you of the violation by some + reasonable means prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is + reinstated permanently if the copyright holder notifies you of the + violation by some reasonable means, this is the first time you have + received notice of violation of this License (for any work) from + that copyright holder, and you cure the violation prior to 30 days + after your receipt of the notice. + + Termination of your rights under this section does not terminate + the licenses of parties who have received copies or rights from you + under this License. If your rights have been terminated and not + permanently reinstated, you do not qualify to receive new licenses + for the same material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or + run a copy of the Program. Ancillary propagation of a covered work + occurring solely as a consequence of using peer-to-peer + transmission to receive a copy likewise does not require + acceptance. However, nothing other than this License grants you + permission to propagate or modify any covered work. These actions + infringe copyright if you do not accept this License. Therefore, + by modifying or propagating a covered work, you indicate your + acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically + receives a license from the original licensors, to run, modify and + propagate that work, subject to this License. You are not + responsible for enforcing compliance by third parties with this + License. + + An "entity transaction" is a transaction transferring control of an + organization, or substantially all assets of one, or subdividing an + organization, or merging organizations. If propagation of a + covered work results from an entity transaction, each party to that + transaction who receives a copy of the work also receives whatever + licenses to the work the party's predecessor in interest had or + could give under the previous paragraph, plus a right to possession + of the Corresponding Source of the work from the predecessor in + interest, if the predecessor has it or can get it with reasonable + efforts. + + You may not impose any further restrictions on the exercise of the + rights granted or affirmed under this License. For example, you + may not impose a license fee, royalty, or other charge for exercise + of rights granted under this License, and you may not initiate + litigation (including a cross-claim or counterclaim in a lawsuit) + alleging that any patent claim is infringed by making, using, + selling, offering for sale, or importing the Program or any portion + of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this + License of the Program or a work on which the Program is based. + The work thus licensed is called the contributor's "contributor + version". + + A contributor's "essential patent claims" are all patent claims + owned or controlled by the contributor, whether already acquired or + hereafter acquired, that would be infringed by some manner, + permitted by this License, of making, using, or selling its + contributor version, but do not include claims that would be + infringed only as a consequence of further modification of the + contributor version. For purposes of this definition, "control" + includes the right to grant patent sublicenses in a manner + consistent with the requirements of this License. + + Each contributor grants you a non-exclusive, worldwide, + royalty-free patent license under the contributor's essential + patent claims, to make, use, sell, offer for sale, import and + otherwise run, modify and propagate the contents of its contributor + version. + + In the following three paragraphs, a "patent license" is any + express agreement or commitment, however denominated, not to + enforce a patent (such as an express permission to practice a + patent or covenant not to sue for patent infringement). To "grant" + such a patent license to a party means to make such an agreement or + commitment not to enforce a patent against the party. + + If you convey a covered work, knowingly relying on a patent + license, and the Corresponding Source of the work is not available + for anyone to copy, free of charge and under the terms of this + License, through a publicly available network server or other + readily accessible means, then you must either (1) cause the + Corresponding Source to be so available, or (2) arrange to deprive + yourself of the benefit of the patent license for this particular + work, or (3) arrange, in a manner consistent with the requirements + of this License, to extend the patent license to downstream + recipients. "Knowingly relying" means you have actual knowledge + that, but for the patent license, your conveying the covered work + in a country, or your recipient's use of the covered work in a + country, would infringe one or more identifiable patents in that + country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or + arrangement, you convey, or propagate by procuring conveyance of, a + covered work, and grant a patent license to some of the parties + receiving the covered work authorizing them to use, propagate, + modify or convey a specific copy of the covered work, then the + patent license you grant is automatically extended to all + recipients of the covered work and works based on it. + + A patent license is "discriminatory" if it does not include within + the scope of its coverage, prohibits the exercise of, or is + conditioned on the non-exercise of one or more of the rights that + are specifically granted under this License. You may not convey a + covered work if you are a party to an arrangement with a third + party that is in the business of distributing software, under which + you make payment to the third party based on the extent of your + activity of conveying the work, and under which the third party + grants, to any of the parties who would receive the covered work + from you, a discriminatory patent license (a) in connection with + copies of the covered work conveyed by you (or copies made from + those copies), or (b) primarily for and in connection with specific + products or compilations that contain the covered work, unless you + entered into that arrangement, or that patent license was granted, + prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting + any implied license or other defenses to infringement that may + otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement + or otherwise) that contradict the conditions of this License, they + do not excuse you from the conditions of this License. If you + cannot convey a covered work so as to satisfy simultaneously your + obligations under this License and any other pertinent obligations, + then as a consequence you may not convey it at all. For example, + if you agree to terms that obligate you to collect a royalty for + further conveying from those to whom you convey the Program, the + only way you could satisfy both those terms and this License would + be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have + permission to link or combine any covered work with a work licensed + under version 3 of the GNU Affero General Public License into a + single combined work, and to convey the resulting work. The terms + of this License will continue to apply to the part which is the + covered work, but the special requirements of the GNU Affero + General Public License, section 13, concerning interaction through + a network will apply to the combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new + versions of the GNU General Public License from time to time. Such + new versions will be similar in spirit to the present version, but + may differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the + Program specifies that a certain numbered version of the GNU + General Public License "or any later version" applies to it, you + have the option of following the terms and conditions either of + that numbered version or of any later version published by the Free + Software Foundation. If the Program does not specify a version + number of the GNU General Public License, you may choose any + version ever published by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future + versions of the GNU General Public License can be used, that + proxy's public statement of acceptance of a version permanently + authorizes you to choose that version for the Program. + + Later license versions may give you additional or different + permissions. However, no additional obligations are imposed on any + author or copyright holder as a result of your choosing to follow a + later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY + APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE + COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE + RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. + SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL + NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN + WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES + AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR + DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR + CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE + THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA + BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD + PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER + PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF + THE POSSIBILITY OF SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided + above cannot be given local legal effect according to their terms, + reviewing courts shall apply local law that most closely + approximates an absolute waiver of all civil liability in + connection with the Program, unless a warranty or assumption of + liability accompanies a copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS +=========================== + +How to Apply These Terms to Your New Programs +============================================= + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES. + Copyright (C) YEAR NAME OF AUTHOR + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or (at + your option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + Also add information on how to contact you by electronic and paper +mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + PROGRAM Copyright (C) YEAR NAME OF AUTHOR + This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type 'show c' for details. + + The hypothetical commands 'show w' and 'show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + + You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + + The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . + + +File: libgomp.info, Node: GNU Free Documentation License, Next: Funding, Prev: Copying, Up: Top + +GNU Free Documentation License +****************************** + + Version 1.3, 3 November 2008 + + Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + 0. PREAMBLE + + The purpose of this License is to make a manual, textbook, or other + functional and useful document "free" in the sense of freedom: to + assure everyone the effective freedom to copy and redistribute it, + with or without modifying it, either commercially or + noncommercially. Secondarily, this License preserves for the + author and publisher a way to get credit for their work, while not + being considered responsible for modifications made by others. + + This License is a kind of "copyleft", which means that derivative + works of the document must themselves be free in the same sense. + It complements the GNU General Public License, which is a copyleft + license designed for free software. + + We have designed this License in order to use it for manuals for + free software, because free software needs free documentation: a + free program should come with manuals providing the same freedoms + that the software does. But this License is not limited to + software manuals; it can be used for any textual work, regardless + of subject matter or whether it is published as a printed book. We + recommend this License principally for works whose purpose is + instruction or reference. + + 1. APPLICABILITY AND DEFINITIONS + + This License applies to any manual or other work, in any medium, + that contains a notice placed by the copyright holder saying it can + be distributed under the terms of this License. Such a notice + grants a world-wide, royalty-free license, unlimited in duration, + to use that work under the conditions stated herein. The + "Document", below, refers to any such manual or work. Any member + of the public is a licensee, and is addressed as "you". You accept + the license if you copy, modify or distribute the work in a way + requiring permission under copyright law. + + A "Modified Version" of the Document means any work containing the + Document or a portion of it, either copied verbatim, or with + modifications and/or translated into another language. + + A "Secondary Section" is a named appendix or a front-matter section + of the Document that deals exclusively with the relationship of the + publishers or authors of the Document to the Document's overall + subject (or to related matters) and contains nothing that could + fall directly within that overall subject. (Thus, if the Document + is in part a textbook of mathematics, a Secondary Section may not + explain any mathematics.) The relationship could be a matter of + historical connection with the subject or with related matters, or + of legal, commercial, philosophical, ethical or political position + regarding them. + + The "Invariant Sections" are certain Secondary Sections whose + titles are designated, as being those of Invariant Sections, in the + notice that says that the Document is released under this License. + If a section does not fit the above definition of Secondary then it + is not allowed to be designated as Invariant. The Document may + contain zero Invariant Sections. If the Document does not identify + any Invariant Sections then there are none. + + The "Cover Texts" are certain short passages of text that are + listed, as Front-Cover Texts or Back-Cover Texts, in the notice + that says that the Document is released under this License. A + Front-Cover Text may be at most 5 words, and a Back-Cover Text may + be at most 25 words. + + A "Transparent" copy of the Document means a machine-readable copy, + represented in a format whose specification is available to the + general public, that is suitable for revising the document + straightforwardly with generic text editors or (for images composed + of pixels) generic paint programs or (for drawings) some widely + available drawing editor, and that is suitable for input to text + formatters or for automatic translation to a variety of formats + suitable for input to text formatters. A copy made in an otherwise + Transparent file format whose markup, or absence of markup, has + been arranged to thwart or discourage subsequent modification by + readers is not Transparent. An image format is not Transparent if + used for any substantial amount of text. A copy that is not + "Transparent" is called "Opaque". + + Examples of suitable formats for Transparent copies include plain + ASCII without markup, Texinfo input format, LaTeX input format, + SGML or XML using a publicly available DTD, and standard-conforming + simple HTML, PostScript or PDF designed for human modification. + Examples of transparent image formats include PNG, XCF and JPG. + Opaque formats include proprietary formats that can be read and + edited only by proprietary word processors, SGML or XML for which + the DTD and/or processing tools are not generally available, and + the machine-generated HTML, PostScript or PDF produced by some word + processors for output purposes only. + + The "Title Page" means, for a printed book, the title page itself, + plus such following pages as are needed to hold, legibly, the + material this License requires to appear in the title page. For + works in formats which do not have any title page as such, "Title + Page" means the text near the most prominent appearance of the + work's title, preceding the beginning of the body of the text. + + The "publisher" means any person or entity that distributes copies + of the Document to the public. + + A section "Entitled XYZ" means a named subunit of the Document + whose title either is precisely XYZ or contains XYZ in parentheses + following text that translates XYZ in another language. (Here XYZ + stands for a specific section name mentioned below, such as + "Acknowledgements", "Dedications", "Endorsements", or "History".) + To "Preserve the Title" of such a section when you modify the + Document means that it remains a section "Entitled XYZ" according + to this definition. + + The Document may include Warranty Disclaimers next to the notice + which states that this License applies to the Document. These + Warranty Disclaimers are considered to be included by reference in + this License, but only as regards disclaiming warranties: any other + implication that these Warranty Disclaimers may have is void and + has no effect on the meaning of this License. + + 2. VERBATIM COPYING + + You may copy and distribute the Document in any medium, either + commercially or noncommercially, provided that this License, the + copyright notices, and the license notice saying this License + applies to the Document are reproduced in all copies, and that you + add no other conditions whatsoever to those of this License. You + may not use technical measures to obstruct or control the reading + or further copying of the copies you make or distribute. However, + you may accept compensation in exchange for copies. If you + distribute a large enough number of copies you must also follow the + conditions in section 3. + + You may also lend copies, under the same conditions stated above, + and you may publicly display copies. + + 3. COPYING IN QUANTITY + + If you publish printed copies (or copies in media that commonly + have printed covers) of the Document, numbering more than 100, and + the Document's license notice requires Cover Texts, you must + enclose the copies in covers that carry, clearly and legibly, all + these Cover Texts: Front-Cover Texts on the front cover, and + Back-Cover Texts on the back cover. Both covers must also clearly + and legibly identify you as the publisher of these copies. The + front cover must present the full title with all words of the title + equally prominent and visible. You may add other material on the + covers in addition. Copying with changes limited to the covers, as + long as they preserve the title of the Document and satisfy these + conditions, can be treated as verbatim copying in other respects. + + If the required texts for either cover are too voluminous to fit + legibly, you should put the first ones listed (as many as fit + reasonably) on the actual cover, and continue the rest onto + adjacent pages. + + If you publish or distribute Opaque copies of the Document + numbering more than 100, you must either include a machine-readable + Transparent copy along with each Opaque copy, or state in or with + each Opaque copy a computer-network location from which the general + network-using public has access to download using public-standard + network protocols a complete Transparent copy of the Document, free + of added material. If you use the latter option, you must take + reasonably prudent steps, when you begin distribution of Opaque + copies in quantity, to ensure that this Transparent copy will + remain thus accessible at the stated location until at least one + year after the last time you distribute an Opaque copy (directly or + through your agents or retailers) of that edition to the public. + + It is requested, but not required, that you contact the authors of + the Document well before redistributing any large number of copies, + to give them a chance to provide you with an updated version of the + Document. + + 4. MODIFICATIONS + + You may copy and distribute a Modified Version of the Document + under the conditions of sections 2 and 3 above, provided that you + release the Modified Version under precisely this License, with the + Modified Version filling the role of the Document, thus licensing + distribution and modification of the Modified Version to whoever + possesses a copy of it. In addition, you must do these things in + the Modified Version: + + A. Use in the Title Page (and on the covers, if any) a title + distinct from that of the Document, and from those of previous + versions (which should, if there were any, be listed in the + History section of the Document). You may use the same title + as a previous version if the original publisher of that + version gives permission. + + B. List on the Title Page, as authors, one or more persons or + entities responsible for authorship of the modifications in + the Modified Version, together with at least five of the + principal authors of the Document (all of its principal + authors, if it has fewer than five), unless they release you + from this requirement. + + C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. + + D. Preserve all the copyright notices of the Document. + + E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. + + F. Include, immediately after the copyright notices, a license + notice giving the public permission to use the Modified + Version under the terms of this License, in the form shown in + the Addendum below. + + G. Preserve in that license notice the full lists of Invariant + Sections and required Cover Texts given in the Document's + license notice. + + H. Include an unaltered copy of this License. + + I. Preserve the section Entitled "History", Preserve its Title, + and add to it an item stating at least the title, year, new + authors, and publisher of the Modified Version as given on the + Title Page. If there is no section Entitled "History" in the + Document, create one stating the title, year, authors, and + publisher of the Document as given on its Title Page, then add + an item describing the Modified Version as stated in the + previous sentence. + + J. Preserve the network location, if any, given in the Document + for public access to a Transparent copy of the Document, and + likewise the network locations given in the Document for + previous versions it was based on. These may be placed in the + "History" section. You may omit a network location for a work + that was published at least four years before the Document + itself, or if the original publisher of the version it refers + to gives permission. + + K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section + all the substance and tone of each of the contributor + acknowledgements and/or dedications given therein. + + L. Preserve all the Invariant Sections of the Document, unaltered + in their text and in their titles. Section numbers or the + equivalent are not considered part of the section titles. + + M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. + + N. Do not retitle any existing section to be Entitled + "Endorsements" or to conflict in title with any Invariant + Section. + + O. Preserve any Warranty Disclaimers. + + If the Modified Version includes new front-matter sections or + appendices that qualify as Secondary Sections and contain no + material copied from the Document, you may at your option designate + some or all of these sections as invariant. To do this, add their + titles to the list of Invariant Sections in the Modified Version's + license notice. These titles must be distinct from any other + section titles. + + You may add a section Entitled "Endorsements", provided it contains + nothing but endorsements of your Modified Version by various + parties--for example, statements of peer review or that the text + has been approved by an organization as the authoritative + definition of a standard. + + You may add a passage of up to five words as a Front-Cover Text, + and a passage of up to 25 words as a Back-Cover Text, to the end of + the list of Cover Texts in the Modified Version. Only one passage + of Front-Cover Text and one of Back-Cover Text may be added by (or + through arrangements made by) any one entity. If the Document + already includes a cover text for the same cover, previously added + by you or by arrangement made by the same entity you are acting on + behalf of, you may not add another; but you may replace the old + one, on explicit permission from the previous publisher that added + the old one. + + The author(s) and publisher(s) of the Document do not by this + License give permission to use their names for publicity for or to + assert or imply endorsement of any Modified Version. + + 5. COMBINING DOCUMENTS + + You may combine the Document with other documents released under + this License, under the terms defined in section 4 above for + modified versions, provided that you include in the combination all + of the Invariant Sections of all of the original documents, + unmodified, and list them all as Invariant Sections of your + combined work in its license notice, and that you preserve all + their Warranty Disclaimers. + + The combined work need only contain one copy of this License, and + multiple identical Invariant Sections may be replaced with a single + copy. If there are multiple Invariant Sections with the same name + but different contents, make the title of each such section unique + by adding at the end of it, in parentheses, the name of the + original author or publisher of that section if known, or else a + unique number. Make the same adjustment to the section titles in + the list of Invariant Sections in the license notice of the + combined work. + + In the combination, you must combine any sections Entitled + "History" in the various original documents, forming one section + Entitled "History"; likewise combine any sections Entitled + "Acknowledgements", and any sections Entitled "Dedications". You + must delete all sections Entitled "Endorsements." + + 6. COLLECTIONS OF DOCUMENTS + + You may make a collection consisting of the Document and other + documents released under this License, and replace the individual + copies of this License in the various documents with a single copy + that is included in the collection, provided that you follow the + rules of this License for verbatim copying of each of the documents + in all other respects. + + You may extract a single document from such a collection, and + distribute it individually under this License, provided you insert + a copy of this License into the extracted document, and follow this + License in all other respects regarding verbatim copying of that + document. + + 7. AGGREGATION WITH INDEPENDENT WORKS + + A compilation of the Document or its derivatives with other + separate and independent documents or works, in or on a volume of a + storage or distribution medium, is called an "aggregate" if the + copyright resulting from the compilation is not used to limit the + legal rights of the compilation's users beyond what the individual + works permit. When the Document is included in an aggregate, this + License does not apply to the other works in the aggregate which + are not themselves derivative works of the Document. + + If the Cover Text requirement of section 3 is applicable to these + copies of the Document, then if the Document is less than one half + of the entire aggregate, the Document's Cover Texts may be placed + on covers that bracket the Document within the aggregate, or the + electronic equivalent of covers if the Document is in electronic + form. Otherwise they must appear on printed covers that bracket + the whole aggregate. + + 8. TRANSLATION + + Translation is considered a kind of modification, so you may + distribute translations of the Document under the terms of section + 4. Replacing Invariant Sections with translations requires special + permission from their copyright holders, but you may include + translations of some or all Invariant Sections in addition to the + original versions of these Invariant Sections. You may include a + translation of this License, and all the license notices in the + Document, and any Warranty Disclaimers, provided that you also + include the original English version of this License and the + original versions of those notices and disclaimers. In case of a + disagreement between the translation and the original version of + this License or a notice or disclaimer, the original version will + prevail. + + If a section in the Document is Entitled "Acknowledgements", + "Dedications", or "History", the requirement (section 4) to + Preserve its Title (section 1) will typically require changing the + actual title. + + 9. TERMINATION + + You may not copy, modify, sublicense, or distribute the Document + except as expressly provided under this License. Any attempt + otherwise to copy, modify, sublicense, or distribute it is void, + and will automatically terminate your rights under this License. + + However, if you cease all violation of this License, then your + license from a particular copyright holder is reinstated (a) + provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and (b) permanently, if the + copyright holder fails to notify you of the violation by some + reasonable means prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is + reinstated permanently if the copyright holder notifies you of the + violation by some reasonable means, this is the first time you have + received notice of violation of this License (for any work) from + that copyright holder, and you cure the violation prior to 30 days + after your receipt of the notice. + + Termination of your rights under this section does not terminate + the licenses of parties who have received copies or rights from you + under this License. If your rights have been terminated and not + permanently reinstated, receipt of a copy of some or all of the + same material does not give you any rights to use it. + + 10. FUTURE REVISIONS OF THIS LICENSE + + The Free Software Foundation may publish new, revised versions of + the GNU Free Documentation License from time to time. Such new + versions will be similar in spirit to the present version, but may + differ in detail to address new problems or concerns. See + . + + Each version of the License is given a distinguishing version + number. If the Document specifies that a particular numbered + version of this License "or any later version" applies to it, you + have the option of following the terms and conditions either of + that specified version or of any later version that has been + published (not as a draft) by the Free Software Foundation. If the + Document does not specify a version number of this License, you may + choose any version ever published (not as a draft) by the Free + Software Foundation. If the Document specifies that a proxy can + decide which future versions of this License can be used, that + proxy's public statement of acceptance of a version permanently + authorizes you to choose that version for the Document. + + 11. RELICENSING + + "Massive Multiauthor Collaboration Site" (or "MMC Site") means any + World Wide Web server that publishes copyrightable works and also + provides prominent facilities for anybody to edit those works. A + public wiki that anybody can edit is an example of such a server. + A "Massive Multiauthor Collaboration" (or "MMC") contained in the + site means any set of copyrightable works thus published on the MMC + site. + + "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 + license published by Creative Commons Corporation, a not-for-profit + corporation with a principal place of business in San Francisco, + California, as well as future copyleft versions of that license + published by that same organization. + + "Incorporate" means to publish or republish a Document, in whole or + in part, as part of another Document. + + An MMC is "eligible for relicensing" if it is licensed under this + License, and if all works that were first published under this + License somewhere other than this MMC, and subsequently + incorporated in whole or in part into the MMC, (1) had no cover + texts or invariant sections, and (2) were thus incorporated prior + to November 1, 2008. + + The operator of an MMC Site may republish an MMC contained in the + site under CC-BY-SA on the same site at any time before August 1, + 2009, provided the MMC is eligible for relicensing. + +ADDENDUM: How to use this License for your documents +==================================================== + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and license +notices just after the title page: + + Copyright (C) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. + + If you have Invariant Sections, Front-Cover Texts and Back-Cover +Texts, replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with + the Front-Cover Texts being LIST, and with the Back-Cover Texts + being LIST. + + If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + + If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of free +software license, such as the GNU General Public License, to permit +their use in free software. + + +File: libgomp.info, Node: Funding, Next: Library Index, Prev: GNU Free Documentation License, Up: Top + +Funding Free Software +********************* + +If you want to have more free software a few years from now, it makes +sense for you to help encourage people to contribute funds for its +development. The most effective approach known is to encourage +commercial redistributors to donate. + + Users of free software systems can boost the pace of development by +encouraging for-a-fee distributors to donate part of their selling price +to free software developers--the Free Software Foundation, and others. + + The way to convince distributors to do this is to demand it and +expect it from them. So when you compare distributors, judge them +partly by how much they give to free software development. Show +distributors they must compete to be the one who gives the most. + + To make this approach work, you must insist on numbers that you can +compare, such as, "We will donate ten dollars to the Frobnitz project +for each disk sold." Don't be satisfied with a vague promise, such as +"A portion of the profits are donated," since it doesn't give a basis +for comparison. + + Even a precise fraction "of the profits from this disk" is not very +meaningful, since creative accounting and unrelated business decisions +can greatly alter what fraction of the sales price counts as profit. If +the price you pay is $50, ten percent of the profit is probably less +than a dollar; it might be a few cents, or nothing at all. + + Some redistributors do development work themselves. This is useful +too; but to keep everyone honest, you need to inquire how much they do, +and what kind. Some kinds of development make much more long-term +difference than others. For example, maintaining a separate version of +a program contributes very little; maintaining the standard version of a +program for the whole community contributes much. Easy new ports +contribute little, since someone else would surely do them; difficult +ports such as adding a new CPU to the GNU Compiler Collection contribute +more; major new features or packages contribute the most. + + By establishing the idea that supporting further development is "the +proper thing to do" when distributing free software for a fee, we can +assure a steady flow of resources into making more free software. + + Copyright (C) 1994 Free Software Foundation, Inc. + Verbatim copying and redistribution of this section is permitted + without royalty; alteration is not permitted. + + +File: libgomp.info, Node: Library Index, Prev: Funding, Up: Top + +Library Index +************* + +[index] +* Menu: + +* acc_get_property: acc_get_property. (line 6) +* acc_get_property_string: acc_get_property. (line 6) +* Environment Variable: OMP_ALLOCATOR. (line 6) +* Environment Variable <1>: OMP_AFFINITY_FORMAT. (line 6) +* Environment Variable <2>: OMP_CANCELLATION. (line 6) +* Environment Variable <3>: OMP_DISPLAY_AFFINITY. (line 6) +* Environment Variable <4>: OMP_DISPLAY_ENV. (line 6) +* Environment Variable <5>: OMP_DEFAULT_DEVICE. (line 6) +* Environment Variable <6>: OMP_DYNAMIC. (line 6) +* Environment Variable <7>: OMP_MAX_ACTIVE_LEVELS. (line 6) +* Environment Variable <8>: OMP_MAX_TASK_PRIORITY. (line 6) +* Environment Variable <9>: OMP_NESTED. (line 6) +* Environment Variable <10>: OMP_NUM_TEAMS. (line 6) +* Environment Variable <11>: OMP_NUM_THREADS. (line 6) +* Environment Variable <12>: OMP_PROC_BIND. (line 6) +* Environment Variable <13>: OMP_PLACES. (line 6) +* Environment Variable <14>: OMP_STACKSIZE. (line 6) +* Environment Variable <15>: OMP_SCHEDULE. (line 6) +* Environment Variable <16>: OMP_TARGET_OFFLOAD. (line 6) +* Environment Variable <17>: OMP_TEAMS_THREAD_LIMIT. + (line 6) +* Environment Variable <18>: OMP_THREAD_LIMIT. (line 6) +* Environment Variable <19>: OMP_WAIT_POLICY. (line 6) +* Environment Variable <20>: GOMP_CPU_AFFINITY. (line 6) +* Environment Variable <21>: GOMP_DEBUG. (line 6) +* Environment Variable <22>: GOMP_STACKSIZE. (line 6) +* Environment Variable <23>: GOMP_SPINCOUNT. (line 6) +* Environment Variable <24>: GOMP_RTEMS_THREAD_POOLS. + (line 6) +* FDL, GNU Free Documentation License: GNU Free Documentation License. + (line 6) +* Implementation specific setting: OMP_NESTED. (line 6) +* Implementation specific setting <1>: OMP_NUM_THREADS. (line 6) +* Implementation specific setting <2>: OMP_SCHEDULE. (line 6) +* Implementation specific setting <3>: OMP_TARGET_OFFLOAD. (line 6) +* Implementation specific setting <4>: GOMP_STACKSIZE. (line 6) +* Implementation specific setting <5>: GOMP_SPINCOUNT. (line 6) +* Implementation specific setting <6>: GOMP_RTEMS_THREAD_POOLS. + (line 6) +* Implementation specific setting <7>: Implementation-defined ICV Initialization. + (line 6) +* Introduction: Top. (line 6) + + + +Tag Table: +Node: Top2083 +Node: Enabling OpenMP4900 +Node: OpenMP Implementation Status6081 +Node: OpenMP 4.56760 +Node: OpenMP 5.06936 +Node: OpenMP 5.111965 +Node: OpenMP 5.217100 +Ref: OpenMP 5.2-Footnote-120611 +Node: OpenMP 6.021012 +Node: Runtime Library Routines29803 +Node: Thread Team Routines30466 +Node: omp_set_num_threads32053 +Node: omp_get_num_threads32899 +Node: omp_get_max_threads33990 +Node: omp_get_thread_num34745 +Node: omp_in_parallel35614 +Node: omp_set_dynamic36264 +Node: omp_get_dynamic37131 +Node: omp_get_cancellation38006 +Node: omp_set_nested38800 +Node: omp_get_nested40119 +Node: omp_set_schedule41861 +Node: omp_get_schedule42940 +Node: omp_get_teams_thread_limit43888 +Node: omp_get_supported_active_levels44656 +Node: omp_set_max_active_levels45461 +Node: omp_get_max_active_levels46410 +Node: omp_get_level47133 +Node: omp_get_ancestor_thread_num47767 +Node: omp_get_team_size48689 +Node: omp_get_active_level49660 +Node: Thread Affinity Routines50352 +Node: omp_get_proc_bind50752 +Node: Teams Region Routines51724 +Node: omp_get_num_teams52432 +Node: omp_get_team_num52918 +Node: omp_set_num_teams53417 +Node: omp_get_max_teams54289 +Node: omp_set_teams_thread_limit54981 +Node: omp_get_thread_limit55986 +Node: Tasking Routines56586 +Node: omp_get_max_task_priority57097 +Node: omp_in_explicit_task57680 +Node: omp_in_final58570 +Node: Resource Relinquishing Routines59213 +Node: omp_pause_resource59685 +Node: omp_pause_resource_all60778 +Node: Device Information Routines61765 +Node: omp_get_num_procs62720 +Node: omp_set_default_device63241 +Node: omp_get_default_device64221 +Node: omp_get_num_devices65365 +Node: omp_get_device_num65995 +Node: omp_get_device_from_uid66821 +Node: omp_get_uid_from_device67989 +Node: omp_is_initial_device69168 +Node: omp_get_initial_device70063 +Node: Device Memory Routines70954 +Node: omp_target_alloc71994 +Node: omp_target_free73569 +Node: omp_target_is_present74757 +Node: omp_target_is_accessible76429 +Node: omp_target_memcpy78243 +Node: omp_target_memcpy_async80057 +Node: omp_target_memcpy_rect82521 +Node: omp_target_memcpy_rect_async85764 +Node: omp_target_associate_ptr89659 +Node: omp_target_disassociate_ptr92624 +Node: omp_get_mapped_ptr94377 +Node: Lock Routines95920 +Node: omp_init_lock96768 +Node: omp_init_nest_lock97393 +Node: omp_destroy_lock98115 +Node: omp_destroy_nest_lock98790 +Node: omp_set_lock99528 +Node: omp_set_nest_lock100386 +Node: omp_unset_lock101282 +Node: omp_unset_nest_lock102211 +Node: omp_test_lock103205 +Node: omp_test_nest_lock104183 +Node: Timing Routines105171 +Node: omp_get_wtick105548 +Node: omp_get_wtime106103 +Node: Event Routine106872 +Node: omp_fulfill_event107204 +Node: Interoperability Routines108196 +Node: omp_get_num_interop_properties109072 +Node: omp_get_interop_int110381 +Node: omp_get_interop_ptr112154 +Node: omp_get_interop_str113896 +Node: omp_get_interop_name115628 +Node: omp_get_interop_type_desc116934 +Node: omp_get_interop_rc_desc118657 +Node: Memory Management Routines119830 +Node: omp_init_allocator120758 +Node: omp_destroy_allocator122391 +Node: omp_set_default_allocator123375 +Node: omp_get_default_allocator124409 +Node: omp_alloc125350 +Node: omp_aligned_alloc127453 +Node: omp_free129983 +Node: omp_calloc131638 +Node: omp_aligned_calloc133857 +Node: omp_realloc136409 +Node: Environment Display Routine139795 +Node: omp_display_env140171 +Node: Environment Variables143006 +Node: OMP_ALLOCATOR145787 +Node: OMP_AFFINITY_FORMAT147382 +Node: OMP_CANCELLATION149990 +Node: OMP_DISPLAY_AFFINITY150590 +Node: OMP_DISPLAY_ENV151285 +Node: OMP_DEFAULT_DEVICE152135 +Node: OMP_DYNAMIC153143 +Node: OMP_MAX_ACTIVE_LEVELS153770 +Node: OMP_MAX_TASK_PRIORITY154795 +Node: OMP_NESTED155498 +Node: OMP_NUM_TEAMS156747 +Node: OMP_NUM_THREADS157456 +Node: OMP_PROC_BIND158472 +Node: OMP_PLACES159993 +Node: OMP_STACKSIZE162729 +Node: OMP_SCHEDULE163631 +Node: OMP_TARGET_OFFLOAD164378 +Node: OMP_TEAMS_THREAD_LIMIT165865 +Node: OMP_THREAD_LIMIT166718 +Node: OMP_WAIT_POLICY167378 +Node: GOMP_CPU_AFFINITY168070 +Node: GOMP_DEBUG169788 +Node: GOMP_STACKSIZE170290 +Node: GOMP_SPINCOUNT171121 +Node: GOMP_RTEMS_THREAD_POOLS172325 +Node: Enabling OpenACC174500 +Node: OpenACC Runtime Library Routines175322 +Node: acc_get_num_devices179603 +Node: acc_set_device_type180329 +Node: acc_get_device_type181093 +Node: acc_set_device_num182106 +Node: acc_get_device_num182923 +Node: acc_get_property183722 +Node: acc_async_test185934 +Node: acc_async_test_all186905 +Node: acc_wait187788 +Node: acc_wait_all188651 +Node: acc_wait_all_async189412 +Node: acc_wait_async190164 +Node: acc_init190872 +Node: acc_shutdown191517 +Node: acc_on_device192184 +Node: acc_malloc193374 +Node: acc_free194082 +Node: acc_copyin194726 +Node: acc_present_or_copyin196313 +Node: acc_create198081 +Node: acc_present_or_create199713 +Node: acc_copyout201489 +Node: acc_delete203793 +Node: acc_update_device206040 +Node: acc_update_self207614 +Node: acc_map_data209204 +Node: acc_unmap_data210276 +Node: acc_deviceptr211018 +Node: acc_hostptr211813 +Node: acc_is_present212597 +Node: acc_memcpy_to_device214124 +Node: acc_memcpy_from_device215559 +Node: acc_attach217044 +Node: acc_detach217711 +Node: acc_get_current_cuda_device218550 +Node: acc_get_current_cuda_context219135 +Node: acc_get_cuda_stream219735 +Node: acc_set_cuda_stream220326 +Node: acc_prof_register220997 +Node: acc_prof_unregister221556 +Node: acc_prof_lookup222123 +Node: acc_register_library222644 +Node: OpenACC Environment Variables223210 +Node: ACC_DEVICE_TYPE223699 +Node: ACC_DEVICE_NUM224226 +Node: ACC_PROFLIB224697 +Node: CUDA Streams Usage225303 +Ref: CUDA Streams Usage-Footnote-1227195 +Node: OpenACC Library Interoperability227304 +Ref: OpenACC Library Interoperability-Footnote-1233653 +Ref: OpenACC Library Interoperability-Footnote-2233905 +Node: OpenACC Profiling Interface234113 +Node: OpenMP-Implementation Specifics244111 +Node: Implementation-defined ICV Initialization244430 +Node: OpenMP Context Selectors245601 +Node: Memory allocation246880 +Node: Offload-Target Specifics256359 +Node: AMD Radeon256650 +Node: Foreign-runtime support for AMD GPUs260672 +Node: nvptx263607 +Ref: nvptx-Footnote-1268050 +Node: Foreign-runtime support for Nvidia GPUs268142 +Node: The libgomp ABI271872 +Node: Implementing MASTER construct272722 +Node: Implementing CRITICAL construct273139 +Node: Implementing ATOMIC construct273880 +Node: Implementing FLUSH construct274363 +Node: Implementing BARRIER construct274636 +Node: Implementing THREADPRIVATE construct274907 +Node: Implementing PRIVATE clause275562 +Node: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses276145 +Node: Implementing REDUCTION clause277471 +Node: Implementing PARALLEL construct278031 +Node: Implementing FOR construct279290 +Node: Implementing ORDERED construct281290 +Node: Implementing SECTIONS construct281598 +Node: Implementing SINGLE construct282366 +Node: Implementing OpenACC's PARALLEL construct283080 +Node: Reporting Bugs283340 +Node: Copying283703 +Node: GNU Free Documentation License321255 +Node: Funding346383 +Node: Library Index348909 + +End Tag Table diff --git a/miniconda3/envs/ladir/share/info/libquadmath.info b/miniconda3/envs/ladir/share/info/libquadmath.info new file mode 100644 index 0000000000000000000000000000000000000000..f2ca06db6d3d776de9ad0c968f896ec77ff87cc8 --- /dev/null +++ b/miniconda3/envs/ladir/share/info/libquadmath.info @@ -0,0 +1,811 @@ +This is libquadmath.info, produced by makeinfo version 6.5 from +libquadmath.texi. + +Copyright (C) 2010-2025 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.2 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover Texts + being "A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + "GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: "You have the freedom to copy and + modify this GNU manual. +INFO-DIR-SECTION GNU Libraries +START-INFO-DIR-ENTRY +* libquadmath: (libquadmath). GCC Quad-Precision Math Library +END-INFO-DIR-ENTRY + + This manual documents the GCC Quad-Precision Math Library API. + + Published by the Free Software Foundation 51 Franklin Street, Fifth +Floor Boston, MA 02110-1301 USA + + Copyright (C) 2010-2025 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.2 or any later version published by the Free Software + Foundation; with no Invariant Sections, with the Front-Cover Texts + being "A GNU Manual," and with the Back-Cover Texts as in (a) + below. A copy of the license is included in the section entitled + "GNU Free Documentation License." + + (a) The FSF's Back-Cover Text is: "You have the freedom to copy and + modify this GNU manual. + + +File: libquadmath.info, Node: Top, Next: Typedef and constants, Up: (dir) + +Introduction +************ + +This manual documents the usage of libquadmath, the GCC Quad-Precision +Math Library Application Programming Interface (API). + +* Menu: + +* Typedef and constants:: Defined data types and constants +* Math Library Routines:: The Libquadmath math runtime application + programming interface. +* I/O Library Routines:: The Libquadmath I/O runtime application + programming interface. +* GNU Free Documentation License:: + How you can copy and share this manual. +* Reporting Bugs:: How to report bugs in GCC Libquadmath. + + +File: libquadmath.info, Node: Typedef and constants, Next: Math Library Routines, Prev: Top, Up: Top + +1 Typedef and constants +*********************** + +The following data type has been defined via 'typedef'. + +'__complex128': '__float128'-based complex number + + The following macros are defined, which give the numeric limits of +the '__float128' data type. + +'FLT128_MAX': largest finite number +'FLT128_MIN': smallest positive number with full precision +'FLT128_EPSILON': difference between 1 and the next larger + representable number +'FLT128_DENORM_MIN': smallest positive denormalized number +'FLT128_MANT_DIG': number of digits in the mantissa (bit precision) +'FLT128_MIN_EXP': maximal negative exponent +'FLT128_MAX_EXP': maximal positive exponent +'FLT128_DIG': number of decimal digits in the mantissa +'FLT128_MIN_10_EXP': maximal negative decimal exponent +'FLT128_MAX_10_EXP': maximal positive decimal exponent + + The following mathematical constants of type '__float128' are +defined. + +'M_Eq': the constant e (Euler's number) +'M_LOG2Eq': base 2 logarithm of e +'M_LOG10Eq': decimal (base 10) logarithm of e +'M_LN2q': natural logarithm of 2 +'M_LN10q': natural logarithm of 10 +'M_PIq': pi +'M_PI_2q': pi divided by two +'M_PI_4q': pi divided by four +'M_1_PIq': one divided by pi +'M_2_PIq': two divided by pi +'M_2_SQRTPIq': two divided by square root of pi +'M_SQRT2q': square root of 2 +'M_SQRT1_2q': one divided by square root of 2 + + +File: libquadmath.info, Node: Math Library Routines, Next: I/O Library Routines, Prev: Typedef and constants, Up: Top + +2 Math Library Routines +*********************** + +The following mathematical functions are available: + +'acosq': arc cosine function +'acoshq': inverse hyperbolic cosine function +'asinq': arc sine function +'asinhq': inverse hyperbolic sine function +'atanq': arc tangent function +'atanhq': inverse hyperbolic tangent function +'atan2q': arc tangent function +'cbrtq': cube root function +'ceilq': ceiling value function +'copysignq': copy sign of a number +'coshq': hyperbolic cosine function +'cosq': cosine function +'erfq': error function +'erfcq': complementary error function +'exp2q': base 2 exponential function +'expq': exponential function +'expm1q': exponential minus 1 function +'fabsq': absolute value function +'fdimq': positive difference function +'finiteq': check finiteness of value +'floorq': floor value function +'fmaq': fused multiply and add +'fmaxq': determine maximum of two values +'fminq': determine minimum of two values +'fmodq': remainder value function +'frexpq': extract mantissa and exponent +'hypotq': Eucledian distance function +'ilogbq': get exponent of the value +'isinfq': check for infinity +'isnanq': check for not a number +'issignalingq': check for signaling not a number +'j0q': Bessel function of the first kind, first order +'j1q': Bessel function of the first kind, second order +'jnq': Bessel function of the first kind, N-th order +'ldexpq': load exponent of the value +'lgammaq': logarithmic gamma function +'llrintq': round to nearest integer value +'llroundq': round to nearest integer value away from zero +'logbq': get exponent of the value +'logq': natural logarithm function +'log10q': base 10 logarithm function +'log1pq': compute natural logarithm of the value plus one +'log2q': base 2 logarithm function +'lrintq': round to nearest integer value +'lroundq': round to nearest integer value away from zero +'modfq': decompose the floating-point number +'nanq': return quiet NaN +'nearbyintq': round to nearest integer +'nextafterq': next representable floating-point number +'powq': power function +'remainderq': remainder function +'remquoq': remainder and part of quotient +'rintq': round-to-nearest integral value +'roundq': round-to-nearest integral value, return '__float128' +'scalblnq': compute exponent using 'FLT_RADIX' +'scalbnq': compute exponent using 'FLT_RADIX' +'signbitq': return sign bit +'sincosq': calculate sine and cosine simultaneously +'sinhq': hyperbolic sine function +'sinq': sine function +'sqrtq': square root function +'tanq': tangent function +'tanhq': hyperbolic tangent function +'tgammaq': true gamma function +'truncq': round to integer, towards zero +'y0q': Bessel function of the second kind, first order +'y1q': Bessel function of the second kind, second order +'ynq': Bessel function of the second kind, N-th order +'cabsq' complex absolute value function +'cargq': calculate the argument +'cimagq' imaginary part of complex number +'crealq': real part of complex number +'cacoshq': complex arc hyperbolic cosine function +'cacosq': complex arc cosine function +'casinhq': complex arc hyperbolic sine function +'casinq': complex arc sine function +'catanhq': complex arc hyperbolic tangent function +'catanq': complex arc tangent function +'ccosq' complex cosine function: +'ccoshq': complex hyperbolic cosine function +'cexpq': complex exponential function +'cexpiq': computes the exponential function of "i" times a + real value +'clogq': complex natural logarithm +'clog10q': complex base 10 logarithm +'conjq': complex conjugate function +'cpowq': complex power function +'cprojq': project into Riemann Sphere +'csinq': complex sine function +'csinhq': complex hyperbolic sine function +'csqrtq': complex square root +'ctanq': complex tangent function +'ctanhq': complex hyperbolic tangent function + + +File: libquadmath.info, Node: I/O Library Routines, Next: GNU Free Documentation License, Prev: Math Library Routines, Up: Top + +3 I/O Library Routines +********************** + +* Menu: + +* 'strtoflt128': strtoflt128, Convert from string +* 'quadmath_snprintf': quadmath_snprintf, Convert to string + + +File: libquadmath.info, Node: strtoflt128, Next: quadmath_snprintf, Up: I/O Library Routines + +3.1 'strtoflt128' -- Convert from string +======================================== + +The function 'strtoflt128' converts a string into a '__float128' number. + +Syntax + '__float128 strtoflt128 (const char *s, char **sp)' + +_Arguments_: + S input string + SP the address of the next character in the string + + The argument SP contains, if not 'NULL', the address of the next + character following the parts of the string, which have been read. + +Example + #include + + int main () + { + __float128 r; + + r = strtoflt128 ("1.2345678", NULL); + + return 0; + } + + +File: libquadmath.info, Node: quadmath_snprintf, Prev: strtoflt128, Up: I/O Library Routines + +3.2 'quadmath_snprintf' -- Convert to string +============================================ + +The function 'quadmath_snprintf' converts a '__float128' floating-point +number into a string. It is a specialized alternative to 'snprintf', +where the format string is restricted to a single conversion specifier +with 'Q' modifier and conversion specifier 'e', 'E', 'f', 'F', 'g', 'G', +'a' or 'A', with no extra characters before or after the conversion +specifier. The '%m$' or '*m$' style must not be used in the format. + +Syntax + 'int quadmath_snprintf (char *s, size_t size, const char *format, + ...)' + +_Arguments_: + S output string + SIZE byte size of the string, including trailing NUL + FORMAT conversion specifier string + +Note + On some targets when supported by the C library hooks are installed + for 'printf' family of functions, so that 'printf ("%Qe", 1.2Q);' + etc. works too. + +Example + #include + #include + #include + + int main () + { + __float128 r; + int prec = 20; + int width = 46; + char buf[128]; + + r = 2.0q; + r = sqrtq (r); + int n = quadmath_snprintf (buf, sizeof buf, "%+-#*.20Qe", width, r); + if ((size_t) n < sizeof buf) + printf ("%s\n", buf); + /* Prints: +1.41421356237309504880e+00 */ + quadmath_snprintf (buf, sizeof buf, "%Qa", r); + if ((size_t) n < sizeof buf) + printf ("%s\n", buf); + /* Prints: 0x1.6a09e667f3bcc908b2fb1366ea96p+0 */ + n = quadmath_snprintf (NULL, 0, "%+-#46.*Qe", prec, r); + if (n > -1) + { + char *str = malloc (n + 1); + if (str) + { + quadmath_snprintf (str, n + 1, "%+-#46.*Qe", prec, r); + printf ("%s\n", str); + /* Prints: +1.41421356237309504880e+00 */ + } + free (str); + } + return 0; + } + + +File: libquadmath.info, Node: GNU Free Documentation License, Next: Reporting Bugs, Prev: I/O Library Routines, Up: Top + +GNU Free Documentation License +****************************** + + Version 1.3, 3 November 2008 + + Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + 0. PREAMBLE + + The purpose of this License is to make a manual, textbook, or other + functional and useful document "free" in the sense of freedom: to + assure everyone the effective freedom to copy and redistribute it, + with or without modifying it, either commercially or + noncommercially. Secondarily, this License preserves for the + author and publisher a way to get credit for their work, while not + being considered responsible for modifications made by others. + + This License is a kind of "copyleft", which means that derivative + works of the document must themselves be free in the same sense. + It complements the GNU General Public License, which is a copyleft + license designed for free software. + + We have designed this License in order to use it for manuals for + free software, because free software needs free documentation: a + free program should come with manuals providing the same freedoms + that the software does. But this License is not limited to + software manuals; it can be used for any textual work, regardless + of subject matter or whether it is published as a printed book. We + recommend this License principally for works whose purpose is + instruction or reference. + + 1. APPLICABILITY AND DEFINITIONS + + This License applies to any manual or other work, in any medium, + that contains a notice placed by the copyright holder saying it can + be distributed under the terms of this License. Such a notice + grants a world-wide, royalty-free license, unlimited in duration, + to use that work under the conditions stated herein. The + "Document", below, refers to any such manual or work. Any member + of the public is a licensee, and is addressed as "you". You accept + the license if you copy, modify or distribute the work in a way + requiring permission under copyright law. + + A "Modified Version" of the Document means any work containing the + Document or a portion of it, either copied verbatim, or with + modifications and/or translated into another language. + + A "Secondary Section" is a named appendix or a front-matter section + of the Document that deals exclusively with the relationship of the + publishers or authors of the Document to the Document's overall + subject (or to related matters) and contains nothing that could + fall directly within that overall subject. (Thus, if the Document + is in part a textbook of mathematics, a Secondary Section may not + explain any mathematics.) The relationship could be a matter of + historical connection with the subject or with related matters, or + of legal, commercial, philosophical, ethical or political position + regarding them. + + The "Invariant Sections" are certain Secondary Sections whose + titles are designated, as being those of Invariant Sections, in the + notice that says that the Document is released under this License. + If a section does not fit the above definition of Secondary then it + is not allowed to be designated as Invariant. The Document may + contain zero Invariant Sections. If the Document does not identify + any Invariant Sections then there are none. + + The "Cover Texts" are certain short passages of text that are + listed, as Front-Cover Texts or Back-Cover Texts, in the notice + that says that the Document is released under this License. A + Front-Cover Text may be at most 5 words, and a Back-Cover Text may + be at most 25 words. + + A "Transparent" copy of the Document means a machine-readable copy, + represented in a format whose specification is available to the + general public, that is suitable for revising the document + straightforwardly with generic text editors or (for images composed + of pixels) generic paint programs or (for drawings) some widely + available drawing editor, and that is suitable for input to text + formatters or for automatic translation to a variety of formats + suitable for input to text formatters. A copy made in an otherwise + Transparent file format whose markup, or absence of markup, has + been arranged to thwart or discourage subsequent modification by + readers is not Transparent. An image format is not Transparent if + used for any substantial amount of text. A copy that is not + "Transparent" is called "Opaque". + + Examples of suitable formats for Transparent copies include plain + ASCII without markup, Texinfo input format, LaTeX input format, + SGML or XML using a publicly available DTD, and standard-conforming + simple HTML, PostScript or PDF designed for human modification. + Examples of transparent image formats include PNG, XCF and JPG. + Opaque formats include proprietary formats that can be read and + edited only by proprietary word processors, SGML or XML for which + the DTD and/or processing tools are not generally available, and + the machine-generated HTML, PostScript or PDF produced by some word + processors for output purposes only. + + The "Title Page" means, for a printed book, the title page itself, + plus such following pages as are needed to hold, legibly, the + material this License requires to appear in the title page. For + works in formats which do not have any title page as such, "Title + Page" means the text near the most prominent appearance of the + work's title, preceding the beginning of the body of the text. + + The "publisher" means any person or entity that distributes copies + of the Document to the public. + + A section "Entitled XYZ" means a named subunit of the Document + whose title either is precisely XYZ or contains XYZ in parentheses + following text that translates XYZ in another language. (Here XYZ + stands for a specific section name mentioned below, such as + "Acknowledgements", "Dedications", "Endorsements", or "History".) + To "Preserve the Title" of such a section when you modify the + Document means that it remains a section "Entitled XYZ" according + to this definition. + + The Document may include Warranty Disclaimers next to the notice + which states that this License applies to the Document. These + Warranty Disclaimers are considered to be included by reference in + this License, but only as regards disclaiming warranties: any other + implication that these Warranty Disclaimers may have is void and + has no effect on the meaning of this License. + + 2. VERBATIM COPYING + + You may copy and distribute the Document in any medium, either + commercially or noncommercially, provided that this License, the + copyright notices, and the license notice saying this License + applies to the Document are reproduced in all copies, and that you + add no other conditions whatsoever to those of this License. You + may not use technical measures to obstruct or control the reading + or further copying of the copies you make or distribute. However, + you may accept compensation in exchange for copies. If you + distribute a large enough number of copies you must also follow the + conditions in section 3. + + You may also lend copies, under the same conditions stated above, + and you may publicly display copies. + + 3. COPYING IN QUANTITY + + If you publish printed copies (or copies in media that commonly + have printed covers) of the Document, numbering more than 100, and + the Document's license notice requires Cover Texts, you must + enclose the copies in covers that carry, clearly and legibly, all + these Cover Texts: Front-Cover Texts on the front cover, and + Back-Cover Texts on the back cover. Both covers must also clearly + and legibly identify you as the publisher of these copies. The + front cover must present the full title with all words of the title + equally prominent and visible. You may add other material on the + covers in addition. Copying with changes limited to the covers, as + long as they preserve the title of the Document and satisfy these + conditions, can be treated as verbatim copying in other respects. + + If the required texts for either cover are too voluminous to fit + legibly, you should put the first ones listed (as many as fit + reasonably) on the actual cover, and continue the rest onto + adjacent pages. + + If you publish or distribute Opaque copies of the Document + numbering more than 100, you must either include a machine-readable + Transparent copy along with each Opaque copy, or state in or with + each Opaque copy a computer-network location from which the general + network-using public has access to download using public-standard + network protocols a complete Transparent copy of the Document, free + of added material. If you use the latter option, you must take + reasonably prudent steps, when you begin distribution of Opaque + copies in quantity, to ensure that this Transparent copy will + remain thus accessible at the stated location until at least one + year after the last time you distribute an Opaque copy (directly or + through your agents or retailers) of that edition to the public. + + It is requested, but not required, that you contact the authors of + the Document well before redistributing any large number of copies, + to give them a chance to provide you with an updated version of the + Document. + + 4. MODIFICATIONS + + You may copy and distribute a Modified Version of the Document + under the conditions of sections 2 and 3 above, provided that you + release the Modified Version under precisely this License, with the + Modified Version filling the role of the Document, thus licensing + distribution and modification of the Modified Version to whoever + possesses a copy of it. In addition, you must do these things in + the Modified Version: + + A. Use in the Title Page (and on the covers, if any) a title + distinct from that of the Document, and from those of previous + versions (which should, if there were any, be listed in the + History section of the Document). You may use the same title + as a previous version if the original publisher of that + version gives permission. + + B. List on the Title Page, as authors, one or more persons or + entities responsible for authorship of the modifications in + the Modified Version, together with at least five of the + principal authors of the Document (all of its principal + authors, if it has fewer than five), unless they release you + from this requirement. + + C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. + + D. Preserve all the copyright notices of the Document. + + E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. + + F. Include, immediately after the copyright notices, a license + notice giving the public permission to use the Modified + Version under the terms of this License, in the form shown in + the Addendum below. + + G. Preserve in that license notice the full lists of Invariant + Sections and required Cover Texts given in the Document's + license notice. + + H. Include an unaltered copy of this License. + + I. Preserve the section Entitled "History", Preserve its Title, + and add to it an item stating at least the title, year, new + authors, and publisher of the Modified Version as given on the + Title Page. If there is no section Entitled "History" in the + Document, create one stating the title, year, authors, and + publisher of the Document as given on its Title Page, then add + an item describing the Modified Version as stated in the + previous sentence. + + J. Preserve the network location, if any, given in the Document + for public access to a Transparent copy of the Document, and + likewise the network locations given in the Document for + previous versions it was based on. These may be placed in the + "History" section. You may omit a network location for a work + that was published at least four years before the Document + itself, or if the original publisher of the version it refers + to gives permission. + + K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section + all the substance and tone of each of the contributor + acknowledgements and/or dedications given therein. + + L. Preserve all the Invariant Sections of the Document, unaltered + in their text and in their titles. Section numbers or the + equivalent are not considered part of the section titles. + + M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. + + N. Do not retitle any existing section to be Entitled + "Endorsements" or to conflict in title with any Invariant + Section. + + O. Preserve any Warranty Disclaimers. + + If the Modified Version includes new front-matter sections or + appendices that qualify as Secondary Sections and contain no + material copied from the Document, you may at your option designate + some or all of these sections as invariant. To do this, add their + titles to the list of Invariant Sections in the Modified Version's + license notice. These titles must be distinct from any other + section titles. + + You may add a section Entitled "Endorsements", provided it contains + nothing but endorsements of your Modified Version by various + parties--for example, statements of peer review or that the text + has been approved by an organization as the authoritative + definition of a standard. + + You may add a passage of up to five words as a Front-Cover Text, + and a passage of up to 25 words as a Back-Cover Text, to the end of + the list of Cover Texts in the Modified Version. Only one passage + of Front-Cover Text and one of Back-Cover Text may be added by (or + through arrangements made by) any one entity. If the Document + already includes a cover text for the same cover, previously added + by you or by arrangement made by the same entity you are acting on + behalf of, you may not add another; but you may replace the old + one, on explicit permission from the previous publisher that added + the old one. + + The author(s) and publisher(s) of the Document do not by this + License give permission to use their names for publicity for or to + assert or imply endorsement of any Modified Version. + + 5. COMBINING DOCUMENTS + + You may combine the Document with other documents released under + this License, under the terms defined in section 4 above for + modified versions, provided that you include in the combination all + of the Invariant Sections of all of the original documents, + unmodified, and list them all as Invariant Sections of your + combined work in its license notice, and that you preserve all + their Warranty Disclaimers. + + The combined work need only contain one copy of this License, and + multiple identical Invariant Sections may be replaced with a single + copy. If there are multiple Invariant Sections with the same name + but different contents, make the title of each such section unique + by adding at the end of it, in parentheses, the name of the + original author or publisher of that section if known, or else a + unique number. Make the same adjustment to the section titles in + the list of Invariant Sections in the license notice of the + combined work. + + In the combination, you must combine any sections Entitled + "History" in the various original documents, forming one section + Entitled "History"; likewise combine any sections Entitled + "Acknowledgements", and any sections Entitled "Dedications". You + must delete all sections Entitled "Endorsements." + + 6. COLLECTIONS OF DOCUMENTS + + You may make a collection consisting of the Document and other + documents released under this License, and replace the individual + copies of this License in the various documents with a single copy + that is included in the collection, provided that you follow the + rules of this License for verbatim copying of each of the documents + in all other respects. + + You may extract a single document from such a collection, and + distribute it individually under this License, provided you insert + a copy of this License into the extracted document, and follow this + License in all other respects regarding verbatim copying of that + document. + + 7. AGGREGATION WITH INDEPENDENT WORKS + + A compilation of the Document or its derivatives with other + separate and independent documents or works, in or on a volume of a + storage or distribution medium, is called an "aggregate" if the + copyright resulting from the compilation is not used to limit the + legal rights of the compilation's users beyond what the individual + works permit. When the Document is included in an aggregate, this + License does not apply to the other works in the aggregate which + are not themselves derivative works of the Document. + + If the Cover Text requirement of section 3 is applicable to these + copies of the Document, then if the Document is less than one half + of the entire aggregate, the Document's Cover Texts may be placed + on covers that bracket the Document within the aggregate, or the + electronic equivalent of covers if the Document is in electronic + form. Otherwise they must appear on printed covers that bracket + the whole aggregate. + + 8. TRANSLATION + + Translation is considered a kind of modification, so you may + distribute translations of the Document under the terms of section + 4. Replacing Invariant Sections with translations requires special + permission from their copyright holders, but you may include + translations of some or all Invariant Sections in addition to the + original versions of these Invariant Sections. You may include a + translation of this License, and all the license notices in the + Document, and any Warranty Disclaimers, provided that you also + include the original English version of this License and the + original versions of those notices and disclaimers. In case of a + disagreement between the translation and the original version of + this License or a notice or disclaimer, the original version will + prevail. + + If a section in the Document is Entitled "Acknowledgements", + "Dedications", or "History", the requirement (section 4) to + Preserve its Title (section 1) will typically require changing the + actual title. + + 9. TERMINATION + + You may not copy, modify, sublicense, or distribute the Document + except as expressly provided under this License. Any attempt + otherwise to copy, modify, sublicense, or distribute it is void, + and will automatically terminate your rights under this License. + + However, if you cease all violation of this License, then your + license from a particular copyright holder is reinstated (a) + provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and (b) permanently, if the + copyright holder fails to notify you of the violation by some + reasonable means prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is + reinstated permanently if the copyright holder notifies you of the + violation by some reasonable means, this is the first time you have + received notice of violation of this License (for any work) from + that copyright holder, and you cure the violation prior to 30 days + after your receipt of the notice. + + Termination of your rights under this section does not terminate + the licenses of parties who have received copies or rights from you + under this License. If your rights have been terminated and not + permanently reinstated, receipt of a copy of some or all of the + same material does not give you any rights to use it. + + 10. FUTURE REVISIONS OF THIS LICENSE + + The Free Software Foundation may publish new, revised versions of + the GNU Free Documentation License from time to time. Such new + versions will be similar in spirit to the present version, but may + differ in detail to address new problems or concerns. See + . + + Each version of the License is given a distinguishing version + number. If the Document specifies that a particular numbered + version of this License "or any later version" applies to it, you + have the option of following the terms and conditions either of + that specified version or of any later version that has been + published (not as a draft) by the Free Software Foundation. If the + Document does not specify a version number of this License, you may + choose any version ever published (not as a draft) by the Free + Software Foundation. If the Document specifies that a proxy can + decide which future versions of this License can be used, that + proxy's public statement of acceptance of a version permanently + authorizes you to choose that version for the Document. + + 11. RELICENSING + + "Massive Multiauthor Collaboration Site" (or "MMC Site") means any + World Wide Web server that publishes copyrightable works and also + provides prominent facilities for anybody to edit those works. A + public wiki that anybody can edit is an example of such a server. + A "Massive Multiauthor Collaboration" (or "MMC") contained in the + site means any set of copyrightable works thus published on the MMC + site. + + "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 + license published by Creative Commons Corporation, a not-for-profit + corporation with a principal place of business in San Francisco, + California, as well as future copyleft versions of that license + published by that same organization. + + "Incorporate" means to publish or republish a Document, in whole or + in part, as part of another Document. + + An MMC is "eligible for relicensing" if it is licensed under this + License, and if all works that were first published under this + License somewhere other than this MMC, and subsequently + incorporated in whole or in part into the MMC, (1) had no cover + texts or invariant sections, and (2) were thus incorporated prior + to November 1, 2008. + + The operator of an MMC Site may republish an MMC contained in the + site under CC-BY-SA on the same site at any time before August 1, + 2009, provided the MMC is eligible for relicensing. + +ADDENDUM: How to use this License for your documents +==================================================== + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and license +notices just after the title page: + + Copyright (C) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. + + If you have Invariant Sections, Front-Cover Texts and Back-Cover +Texts, replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with + the Front-Cover Texts being LIST, and with the Back-Cover Texts + being LIST. + + If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + + If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of free +software license, such as the GNU General Public License, to permit +their use in free software. + + +File: libquadmath.info, Node: Reporting Bugs, Prev: GNU Free Documentation License, Up: Top + +4 Reporting Bugs +**************** + +Bugs in the GCC Quad-Precision Math Library implementation should be +reported via . + + + +Tag Table: +Node: Top1633 +Node: Typedef and constants2367 +Node: Math Library Routines3808 +Node: I/O Library Routines7645 +Node: strtoflt1287970 +Node: quadmath_snprintf8730 +Node: GNU Free Documentation License10941 +Node: Reporting Bugs36093 + +End Tag Table diff --git a/miniconda3/envs/ladir/share/info/readline.info b/miniconda3/envs/ladir/share/info/readline.info new file mode 100644 index 0000000000000000000000000000000000000000..33b4b45ea6ee6bb08b0b90e0e640aed166150c06 --- /dev/null +++ b/miniconda3/envs/ladir/share/info/readline.info @@ -0,0 +1,5506 @@ +This is readline.info, produced by makeinfo version 7.1 from rlman.texi. + +This manual describes the GNU Readline Library (version 8.3, 30 December +2024), a library which aids in the consistency of user interface across +discrete programs which provide a command line interface. + + Copyright © 1988-2025 Free Software Foundation, Inc. + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.3 or any later version published by the Free Software + Foundation; with no Invariant Sections, no Front-Cover Texts, and + no Back-Cover Texts. A copy of the license is included in the + section entitled "GNU Free Documentation License". + +INFO-DIR-SECTION Libraries +START-INFO-DIR-ENTRY +* Readline: (readline). The GNU readline library API. +END-INFO-DIR-ENTRY + + +File: readline.info, Node: Top, Next: Command Line Editing, Up: (dir) + +GNU Readline Library +******************** + +This document describes the GNU Readline Library, a utility which aids +in the consistency of user interface across discrete programs which +provide a command line interface. The Readline home page is +. + +* Menu: + +* Command Line Editing:: GNU Readline User's Manual. +* Programming with GNU Readline:: GNU Readline Programmer's Manual. +* GNU Free Documentation License:: License for copying this manual. +* Concept Index:: Index of concepts described in this manual. +* Function and Variable Index:: Index of externally visible functions + and variables. + + +File: readline.info, Node: Command Line Editing, Next: Programming with GNU Readline, Prev: Top, Up: Top + +1 Command Line Editing +********************** + +This chapter describes the basic features of the GNU command line +editing interface. + +* Menu: + +* Introduction and Notation:: Notation used in this text. +* Readline Interaction:: The minimum set of commands for editing a line. +* Readline Init File:: Customizing Readline from a user's view. +* Bindable Readline Commands:: A description of most of the Readline commands + available for binding +* Readline vi Mode:: A short description of how to make Readline + behave like the vi editor. + + +File: readline.info, Node: Introduction and Notation, Next: Readline Interaction, Up: Command Line Editing + +1.1 Introduction to Line Editing +================================ + +The following paragraphs use Emacs style to describe the notation used +to represent keystrokes. + + The text ‘C-k’ is read as 'Control-K' and describes the character +produced when the key is pressed while the Control key is depressed. + + The text ‘M-k’ is read as 'Meta-K' and describes the character +produced when the Meta key (if you have one) is depressed, and the +key is pressed (a “meta character”), then both are released. The Meta +key is labeled or
+
+

+Next:   [Contents][Index]

+
+

GNU History Library

+ +

This document describes the GNU History library, a programming tool that +provides a consistent user interface for recalling lines of previously +typed input. +

+ + + + +
+
+
+

+Next: , Previous: , Up: GNU History Library   [Contents][Index]

+
+

1 Using History Interactively

+ + +

This chapter describes how to use the GNU History Library +interactively, from a user’s standpoint. +It should be considered a user’s guide. +For information on using the GNU History Library in your own programs, +see Programming with GNU History. +

+ + + +
+
+
+

+Up: Using History Interactively   [Contents][Index]

+
+

1.1 History Expansion

+ + +

The History library +provides a history expansion feature that is similar +to the history expansion provided by csh +(also referred to as history substitution where appropriate). +This section describes the syntax used to manipulate the +history information. +

+ +

History expansions introduce words from the history list into +the input stream, making it easy to repeat commands, insert the +arguments to a previous command into the current input line, or +fix errors in previous commands quickly. +

+ +

History expansion takes place in two parts. +The first is to determine +which entry from the history list should be used during substitution. +The second is to select portions of that entry to include into the +current one. +

+

The entry selected from the history is called the event, +and the portions of that entry that are acted upon are words. +Various modifiers are available to manipulate the selected words. +The entry is split into words in the same fashion that Bash +does when reading input, +so that several words surrounded by quotes are considered one word. +The event designator selects the event, the optional +word designator selects words from the event, and +various optional modifiers are available to manipulate the +selected words. +

+

History expansions are introduced by the appearance of the +history expansion character, which is ‘!’ by default. +History expansions may appear anywhere in the input, but do not nest. +

+

History expansion implements shell-like quoting conventions: +a backslash can be used to remove the special handling for the next character; +single quotes enclose verbatim sequences of characters, and can be used to +inhibit history expansion; +and characters enclosed within double quotes may be subject to history +expansion, since backslash can escape the history expansion character, +but single quotes may not, since they are not treated specially within +double quotes. +

+ +

There is a special abbreviation for substitution, active when the +quick substitution character +(default ‘^’) +is the first character on the line. +It selects the previous history list entry, using an event designator +equivalent to !!, +and substitutes one string for another in that entry. +It is described below (see Event Designators). +This is the only history expansion that does not begin with the history +expansion character. +

+ + + +
+
+
+

+Next: , Up: History Expansion   [Contents][Index]

+
+

1.1.1 Event Designators

+ + +

An event designator is a reference to an entry in the history list. +The event designator consists of the portion of the word beginning +with the history expansion character, and ending with the word designator +if one is present, or the end of the word. +Unless the reference is absolute, events are relative to the current +position in the history list. + +

+
+
!
+

Start a history substitution, except when followed by a space, tab, +the end of the line, or ‘=’. +

+
+
!n
+

Refer to history list entry n. +

+
+
!-n
+

Refer to the history entry minus n. +

+
+
!!
+

Refer to the previous entry. +This is a synonym for ‘!-1’. +

+
+
!string
+

Refer to the most recent command +preceding the current position in the history list +starting with string. +

+
+
!?string[?]
+

Refer to the most recent command +preceding the current position in the history list +containing string. +The trailing +‘?’ may be omitted if the string is followed immediately by +a newline. +If string is missing, this uses +the string from the most recent search; +it is an error if there is no previous search string. +

+
+
^string1^string2^
+

Quick Substitution. +Repeat the last command, replacing string1 with string2. +Equivalent to !!:s^string1^string2^. +

+
+
!#
+

The entire command line typed so far. +

+
+
+ +
+
+
+
+

+Next: , Previous: , Up: History Expansion   [Contents][Index]

+
+

1.1.2 Word Designators

+ +

Word designators are used to select desired words from the event. +They are optional; if the word designator isn’t supplied, the history +expansion uses the entire event. +A ‘:’ separates the event specification from the word designator. +It may be omitted if the word designator begins with a ‘^’, ‘$’, +‘*’, ‘-’, or ‘%’. +Words are numbered from the beginning of the line, +with the first word being denoted by 0 (zero). +That first word is usually the command word, and the arguments begin +with the second word. +Words are inserted into the current line separated by single spaces. +

+

For example, +

+
+
!!
+

designates the preceding command. +When you type this, the preceding command is repeated in toto. +

+
+
!!:$
+

designates the last word of the preceding command. +This may be shortened to !$. +

+
+
!fi:2
+

designates the second argument of the most recent command starting with +the letters fi. +

+
+ +

Here are the word designators: +

+
+
0 (zero)
+

The 0th word. +For the shell, and many other, applications, this is the command word. +

+
+
n
+

The nth word. +

+
+
^
+

The first argument: word 1. +

+
+
$
+

The last word. +This is usually the last argument, but expands to the +zeroth word if there is only one word in the line. +

+
+
%
+

The first word matched by the most recent ‘?string?’ search, +if the search string begins with a character that is part of a word. +By default, searches begin at the end of each line and proceed to the +beginning, so the first word matched is the one closest to the end of +the line. +

+
+
x-y
+

A range of words; ‘-y’ abbreviates ‘0-y’. +

+
+
*
+

All of the words, except the 0th. +This is a synonym for ‘1-$’. +It is not an error to use ‘*’ if there is just one word in the event; +it expands to the empty string in that case. +

+
+
x*
+

Abbreviates ‘x-$’. +

+
+
x-
+

Abbreviates ‘x-$’ like ‘x*’, but omits the last word. +If ‘x’ is missing, it defaults to 0. +

+
+
+ +

If a word designator is supplied without an event specification, the +previous command is used as the event, equivalent to !!. +

+
+
+
+
+

+Previous: , Up: History Expansion   [Contents][Index]

+
+

1.1.3 Modifiers

+ +

After the optional word designator, you can add a sequence of one or more +of the following modifiers, each preceded by a ‘:’. +These modify, or edit, the word or words selected from the history event. +

+
+
h
+

Remove a trailing filename component, leaving only the head. +

+
+
t
+

Remove all leading filename components, leaving the tail. +

+
+
r
+

Remove a trailing suffix of the form ‘.suffix’, leaving +the basename. +

+
+
e
+

Remove all but the trailing suffix. +

+
+
p
+

Print the new command but do not execute it. +

+ +
+
s/old/new/
+

Substitute new for the first occurrence of old in the +event line. +Any character may be used as the delimiter in place of ‘/’. +The delimiter may be quoted in old and new +with a single backslash. +If ‘&’ appears in new, it is replaced with old. +A single backslash quotes the ‘&’ in old and new. +If old is null, it is set to the last old +substituted, or, if no previous history substitutions took place, +the last string +in a !?string[?] +search. +If new is null, each matching old is deleted. +The final delimiter is optional if it is the last +character on the input line. +

+
+
&
+

Repeat the previous substitution. +

+
+
g
+
a
+

Cause changes to be applied over the entire event line. +This is used in conjunction with +‘s’, as in gs/old/new/, +or with ‘&’. +

+
+
G
+

Apply the following ‘s’ or ‘&’ modifier once to each word +in the event. +

+
+
+ +
+
+
+
+
+
+

+Next: , Previous: , Up: GNU History Library   [Contents][Index]

+
+

2 Programming with GNU History

+ +

This chapter describes how to interface programs that you write +with the GNU History Library. +It should be considered a technical guide. +For information on the interactive use of GNU History, +see Using History Interactively. +

+ + +
+
+
+

+Next: , Up: Programming with GNU History   [Contents][Index]

+
+

2.1 Introduction to History

+ +

Many programs read input from the user a line at a time. +The GNU History library is able to keep track of those lines, +associate arbitrary data with each line, and utilize information from +previous lines when composing new ones. +

+

A programmer using the History library can use functions +to save commands on a history list, +associate arbitrary data with history list entries, +remove entries from the list, +search through the list for a line containing an arbitrary text string, +reference any entry in the list directly, +and read and write the history list from and to a file. +In addition, a history expansion function +is available which provides for a consistent user interface across +different programs. +

+

Someone using programs written with the History library has the +benefit of a consistent user interface with a set of well-known +commands for manipulating the text of previous lines and using that text +in new commands. +The basic history manipulation commands are similar to +the history substitution provided by csh. +

+

The programmer can also use the Readline library, which +includes some history manipulation by default, and has the added +advantage of command line editing. +

+

Before declaring any functions using any functionality the History +library provides in other code, an application writer should include +the file <readline/history.h> in any file that uses the +History library’s features. +It supplies declarations for all of the library’s +public functions and variables, +and declares all of the public data structures. +

+
+
+
+
+

+Next: , Previous: , Up: Programming with GNU History   [Contents][Index]

+
+

2.2 History Storage

+ +

The history list is an array of history entries. +A history entry is declared as follows: +

+
+
typedef void *histdata_t;
+
+typedef struct _hist_entry {
+  char *line;
+  char *timestamp;
+  histdata_t data;
+} HIST_ENTRY;
+
+ +

The history list itself might therefore be declared as +

+
+
HIST_ENTRY **the_history_list;
+
+ +

The state of the History library is encapsulated into a single structure: +

+
+
/*
+ * A structure used to pass around the current state of the history.
+ */
+typedef struct _hist_state {
+  HIST_ENTRY **entries; /* Pointer to the entries themselves. */
+  int offset;           /* The location pointer within this array. */
+  int length;           /* Number of elements within this array. */
+  int size;             /* Number of slots allocated to this array. */
+  int flags;
+} HISTORY_STATE;
+
+ +

If the flags member includes HS_STIFLED, the history has been +stifled (limited to a maximum number of entries). +

+
+
+
+
+

+Next: , Previous: , Up: Programming with GNU History   [Contents][Index]

+
+

2.3 History Functions

+ +

This section describes the calling sequence for the various functions +exported by the GNU History library. +

+ + +
+
+
+

+Next: , Up: History Functions   [Contents][Index]

+
+

2.3.1 Initializing History and State Management

+ +

This section describes functions used to initialize and manage +the state of the History library when you want to use the history +functions in your program. +

+
+
Function: void using_history (void)
+

Begin a session that will use the history functions. +This initializes the interactive variables. +

+ +
+
Function: HISTORY_STATE * history_get_history_state (void)
+

Return a structure describing the current state of the input history. +

+ +
+
Function: void history_set_history_state (HISTORY_STATE *state)
+

Set the state of the history list according to state. +

+ +
+
+
+
+

+Next: , Previous: , Up: History Functions   [Contents][Index]

+
+

2.3.2 History List Management

+ +

These functions manage individual entries on the history list, or set +parameters managing the list itself. +

+
+
Function: void add_history (const char *string)
+

Add string to the end of the history list, and +set the associated data field (if any) to NULL. +If the maximum number of history entries has been set using +stifle_history(), and the new number of history entries +would exceed that maximum, this removes the oldest history entry. +

+ +
+
Function: void add_history_time (const char *string)
+

Change the time stamp associated with the most recent history entry to +string. +

+ +
+
Function: HIST_ENTRY * remove_history (int which)
+

Remove the history entry at offset which from the history list. +This returns the removed element so you can free the line, data, +and containing structure. +Since the data is private to your application, the History library +doesn’t know how to free it, if necessary. +

+ +
+
Function: histdata_t free_history_entry (HIST_ENTRY *histent)
+

Free the history entry histent and any history library private +data associated with it. +Returns the application-specific data +so the caller can dispose of it. +

+ +
+
Function: HIST_ENTRY * replace_history_entry (int which, const char *line, histdata_t data)
+

Make the history entry at offset which have line and data. +This returns the old entry so the caller can dispose of any +application-specific data. +In the case of an invalid which, this returns NULL. +

+ +
+
Function: void clear_history (void)
+

Clear the history list by deleting all the entries. +

+ +
+
Function: void stifle_history (int max)
+

Stifle the history list, remembering only the last max entries. +The history list will contain only max entries at a time. +

+ +
+
Function: int unstifle_history (void)
+

Stop stifling the history. +This returns the previously-set maximum number of history +entries (as set by stifle_history()). +The value is positive if the history was stifled, negative if it wasn’t. +

+ +
+
Function: int history_is_stifled (void)
+

Returns non-zero if the history is stifled, zero if it is not. +

+ +
+
+
+
+

+Next: , Previous: , Up: History Functions   [Contents][Index]

+
+

2.3.3 Information About the History List

+ +

These functions return information about the entire history list or +individual list entries. +

+
+
Function: HIST_ENTRY ** history_list (void)
+

Return a NULL terminated array of HIST_ENTRY * which is the +current input history. +Element 0 of this list is the beginning of time. +Return NULL if there is no history. +

+ +
+
Function: int where_history (void)
+

Return the offset of the current history entry. +

+ +
+
Function: HIST_ENTRY * current_history (void)
+

Return the history entry at the current position, as determined by +where_history(). +If there is no entry there, return NULL. +

+ +
+
Function: HIST_ENTRY * history_get (int offset)
+

Return the history entry at position offset. +The range of valid +values of offset starts at history_base and ends at +history_length - 1 (see History Variables). +If there is no entry there, or if offset is outside the valid +range, return NULL. +

+ +
+
Function: time_t history_get_time (HIST_ENTRY *entry)
+

Return the time stamp associated with the history entry entry. +If the timestamp is missing or invalid, return 0. +

+ +
+
Function: int history_total_bytes (void)
+

Return the number of bytes that the primary history entries are using. +This function returns the sum of the lengths of all the lines in the +history. +

+ +
+
+
+
+

+Next: , Previous: , Up: History Functions   [Contents][Index]

+
+

2.3.4 Moving Around the History List

+ +

These functions allow the current index into the history list to be +set or changed. +

+
+
Function: int history_set_pos (int pos)
+

Set the current history offset to pos, an absolute index +into the list. +Returns 1 on success, 0 if pos is less than zero or greater +than the number of history entries. +

+ +
+
Function: HIST_ENTRY * previous_history (void)
+

Back up the current history offset to the previous history entry, and +return a pointer to that entry. +If there is no previous entry, return NULL. +

+ +
+
Function: HIST_ENTRY * next_history (void)
+

If the current history offset refers to a valid history entry, +increment the current history offset. +If the possibly-incremented history offset refers to a valid history +entry, return a pointer to that entry; +otherwise, return NULL. +

+ +
+
+
+
+

+Next: , Previous: , Up: History Functions   [Contents][Index]

+
+

2.3.5 Searching the History List

+ + +

These functions search the history list for entries containing +a specific string. +Searching may be performed both forward and backward +from the current history position. +The search may be anchored, +meaning that the string must match at the beginning of a history entry. + +

+
+
Function: int history_search (const char *string, int direction)
+

Search the history for string, starting at the current history offset. +If direction is less than 0, then the search is through +previous entries, otherwise through subsequent entries. +If string is found, then the current history index is set to +that history entry, and history_search +returns the offset in the line of the entry where +string was found. +Otherwise, nothing is changed, and this returns -1. +

+ +
+
Function: int history_search_prefix (const char *string, int direction)
+

Search the history for string, starting at the current history +offset. +The search is anchored: matching history entries must begin with string. +If direction is less than 0, then the search is +through previous entries, otherwise through subsequent entries. +If string is found, then the current history index is set to +that entry, and the return value is 0. +Otherwise, nothing is changed, and this returns -1. +

+ +
+
Function: int history_search_pos (const char *string, int direction, int pos)
+

Search for string in the history list, starting at pos, an +absolute index into the list. +If direction is negative, the search +proceeds backward from pos, otherwise forward. +Returns the index in the history list +of the history element where string was +found, or -1 otherwise. +

+ +
+
+
+
+

+Next: , Previous: , Up: History Functions   [Contents][Index]

+
+

2.3.6 Managing the History File

+ +

The History library can read the history from and write it to a file. +This section documents the functions for managing a history file. +

+
+
Function: int read_history (const char *filename)
+

Add the contents of filename to the history list, one entry +at a time. +If filename is NULL, this reads from ~/.history, +if it exists. +This attempts to determine whether the history file includes timestamp +information, and assigns timestamps to the history entries it reads +if so. +Returns 0 if successful, or errno if not. +

+ +
+
Function: int read_history_range (const char *filename, int from, int to)
+

Read a range of lines from filename, adding them to the history list. +Start reading at line from and end at to. +If from is zero, start at the beginning. +If to is less than from, this reads until the end of the file. +This attempts to determine whether the history file includes timestamp +information, and assigns timestamps to the history entries it reads +if so. +If filename is NULL, this reads from ~/.history, +if it exists. +Returns 0 if successful, or errno if not. +

+ +
+
Function: int write_history (const char *filename)
+

Write the current history to filename, overwriting filename +if necessary. +This writes timestamp information if the +history_write_timestamps variable is set to a non-zero value. +If filename is NULL, then write the history list to +~/.history. +Returns 0 on success, or errno on a read or write error. +

+ +
+
Function: int append_history (int nelements, const char *filename)
+

Append the last nelements of the history list to filename. +This writes timestamp information if the +history_write_timestamps variable is set to a non-zero value. +If filename is NULL, then append to ~/.history. +Returns 0 on success, or errno on a read or write error. +

+ +
+
Function: int history_truncate_file (const char *filename, int nlines)
+

Truncate the history file filename, leaving only the last +nlines lines. +If filename is NULL, this truncates ~/.history. +Returns 0 on success, or errno on failure. +

+ +
+
+
+
+

+Previous: , Up: History Functions   [Contents][Index]

+
+

2.3.7 History Expansion

+ +

These functions implement history expansion. +

+
+
Function: int history_expand (const char *string, char **output)
+

Expand string, placing the result into output, a pointer +to a string (see History Expansion). +Returns: +

+
0
+

If no expansions took place (or, if the only change in +the text was the removal of escape characters preceding the history expansion +character); +

+
1
+

if expansions did take place; +

+
-1
+

if there was an error in expansion; +

+
2
+

if the returned line should be displayed, but not executed, +as with the :p modifier (see Modifiers). +

+
+ +

If an error occurred during expansion, +then output contains a descriptive error message. +

+ +
+
Function: char * get_history_event (const char *string, int *cindex, int qchar)
+

Returns the text of the history event beginning at string + +*cindex. +Modifies *cindex to point to after the event specifier. +At function entry, cindex points to the index into string +where the history event specification begins. +qchar +is a character that is allowed to end the event specification in addition +to the “normal” terminating characters. +

+ +
+
Function: char ** history_tokenize (const char *string)
+

Return an array of tokens parsed out of string, much as the +shell might. +The tokens are split on the characters in the +history_word_delimiters variable, +and shell quoting conventions are obeyed as described below. +

+ +
+
Function: char * history_arg_extract (int first, int last, const char *string)
+

Extract a string segment consisting of the first through last +arguments present in string. +This splits string into arguments using history_tokenize. +

+ +
+
+
+
+
+

+Next: , Previous: , Up: Programming with GNU History   [Contents][Index]

+
+

2.4 History Variables

+ +

This section describes the externally-visible variables exported by +the GNU History Library. +

+
+
Variable: int history_base
+

The logical offset of the first entry in the history list. +

+ +
+
Variable: int history_length
+

The number of entries currently stored in the history list. +

+ +
+
Variable: int history_max_entries
+

The maximum number of history entries. +This must be changed using stifle_history(). +

+ +
+
Variable: int history_write_timestamps
+

If non-zero, timestamps are written to the history file, so they can be +preserved between sessions. +The default value is 0, meaning that timestamps are not saved. +

+

The current timestamp format uses the value of history_comment_char +to delimit timestamp entries in the history file. +If that variable does not have a value (the default), +the history library will not write timestamps. +

+ +
+
Variable: char history_expansion_char
+

The character that introduces a history event. +The default is ‘!’. +Setting this to 0 inhibits history expansion. +

+ +
+
Variable: char history_subst_char
+

The character that invokes word substitution if found at the start of +a line. +The default is ‘^’. +

+ +
+
Variable: char history_comment_char
+

During tokenization, if this character appears as the first character +of a word, then it and all subsequent characters up to a newline are +ignored, suppressing history expansion for the remainder of the line. +This is disabled by default. +

+ +
+
Variable: char * history_word_delimiters
+

The characters that separate tokens for history_tokenize(). +The default value is " \t\n()<>;&|". +

+ +
+
Variable: char * history_search_delimiter_chars
+

The list of additional characters which can delimit a history search +string, in addition to space, TAB, ‘:’ and ‘?’ in the case of +a substring search. +The default is empty. +

+ +
+
Variable: char * history_no_expand_chars
+

The list of characters which inhibit history expansion if found immediately +following history_expansion_char. +The default is space, tab, newline, carriage return, and ‘=’. +

+ +
+
Variable: int history_quotes_inhibit_expansion
+

If non-zero, the history expansion code implements shell-like quoting: +single-quoted words are not scanned for the history expansion +character or the history comment character, and double-quoted words may +have history expansion performed, since single quotes are not special +within double quotes. +The default value is 0. +

+ +
+
Variable: int history_quoting_state
+

An application may set this variable to indicate that the current line +being expanded is subject to existing quoting. +If set to ‘'’, +history expansion assumes that the line is single-quoted and +inhibit expansion until it reads an unquoted closing single quote; +if set to ‘"’, +history expansion assumes the line is double quoted +until it reads an unquoted closing double quote. +If set to 0, the default, +history expansion assumes the line is not quoted and +treats quote characters within the line as described above. +This is only effective if history_quotes_inhibit_expansion is set. +This is intended for use by applications like Bash which allow +quoted strings to span multiple lines. +

+ +
+
Variable: rl_linebuf_func_t * history_inhibit_expansion_function
+

This should be set to the address of a function that takes two arguments: +a char * (string) +and an int index into that string (i). +It should return a non-zero value if the history expansion starting at +string[i] should not be performed; zero if the expansion should +be done. +It is intended for use by applications like Bash that use the history +expansion character for additional purposes. +By default, this variable is set to NULL. +

+ +
+
+
+
+

+Previous: , Up: Programming with GNU History   [Contents][Index]

+
+

2.5 History Programming Example

+ +

The following program demonstrates simple use of the GNU History Library. +

+
+
#include <stdio.h>
+#include <readline/history.h>
+
+int
+main (int argc, char **argv)
+{
+  char line[1024], *t;
+  int len, done = 0;
+
+  line[0] = 0;
+
+  using_history ();
+  while (!done)
+    {
+      printf ("history$ ");
+      fflush (stdout);
+      t = fgets (line, sizeof (line) - 1, stdin);
+      if (t && *t)
+        {
+          len = strlen (t);
+          if (t[len - 1] == '\n')
+            t[len - 1] = '\0';
+        }
+
+      if (!t)
+        strcpy (line, "quit");
+
+      if (line[0])
+        {
+          char *expansion;
+          int result;
+
+          result = history_expand (line, &expansion);
+          if (result)
+            fprintf (stderr, "%s\n", expansion);
+
+          if (result < 0 || result == 2)
+            {
+              free (expansion);
+              continue;
+            }
+
+          add_history (expansion);
+          strncpy (line, expansion, sizeof (line) - 1);
+          free (expansion);
+        }
+
+      if (strcmp (line, "quit") == 0)
+        done = 1;
+      else if (strcmp (line, "save") == 0)
+        write_history ("history_file");
+      else if (strcmp (line, "read") == 0)
+        read_history ("history_file");
+      else if (strcmp (line, "list") == 0)
+        {
+          register HIST_ENTRY **the_list;
+          register int i;
+
+          the_list = history_list ();
+          if (the_list)
+            for (i = 0; the_list[i]; i++)
+              printf ("%d: %s\n", i + history_base, the_list[i]->line);
+        }
+      else if (strncmp (line, "delete", 6) == 0)
+        {
+          int which;
+          if ((sscanf (line + 6, "%d", &which)) == 1)
+            {
+              HIST_ENTRY *entry = remove_history (which);
+              if (!entry)
+                fprintf (stderr, "No such entry %d\n", which);
+              else
+                {
+                  free (entry->line);
+                  free (entry);
+                }
+            }
+          else
+            {
+              fprintf (stderr, "non-numeric arg given to `delete'\n");
+            }
+        }
+    }
+}
+
+ +
+
+
+
+
+

+Next: , Previous: , Up: GNU History Library   [Contents][Index]

+
+

Appendix A GNU Free Documentation License

+ +
Version 1.3, 3 November 2008 +
+ +
+
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+http://fsf.org/
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+ +
    +
  1. PREAMBLE + +

    The purpose of this License is to make a manual, textbook, or other +functional and useful document free in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. +

    +

    This License is a kind of “copyleft”, which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. +

    +

    We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. +

    +
  2. APPLICABILITY AND DEFINITIONS + +

    This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The “Document”, below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as “you”. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. +

    +

    A “Modified Version” of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. +

    +

    A “Secondary Section” is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document’s overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. +

    +

    The “Invariant Sections” are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. +

    +

    The “Cover Texts” are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. +

    +

    A “Transparent” copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not “Transparent” is called “Opaque”. +

    +

    Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. +

    +

    The “Title Page” means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, “Title Page” means +the text near the most prominent appearance of the work’s title, +preceding the beginning of the body of the text. +

    +

    The “publisher” means any person or entity that distributes copies +of the Document to the public. +

    +

    A section “Entitled XYZ” means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as “Acknowledgements”, +“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” +of such a section when you modify the Document means that it remains a +section “Entitled XYZ” according to this definition. +

    +

    The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. +

    +
  3. VERBATIM COPYING + +

    You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. +

    +

    You may also lend copies, under the same conditions stated above, and +you may publicly display copies. +

    +
  4. COPYING IN QUANTITY + +

    If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document’s license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. +

    +

    If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. +

    +

    If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. +

    +

    It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. +

    +
  5. MODIFICATIONS + +

    You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: +

    +
      +
    1. Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +
    2. List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +
    3. State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +
    4. Preserve all the copyright notices of the Document. + +
    5. Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +
    6. Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +
    7. Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document’s license notice. + +
    8. Include an unaltered copy of this License. + +
    9. Preserve the section Entitled “History”, Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled “History” in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +
    10. Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the “History” section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +
    11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +
    12. Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +
    13. Delete any section Entitled “Endorsements”. Such a section +may not be included in the Modified Version. + +
    14. Do not retitle any existing section to be Entitled “Endorsements” or +to conflict in title with any Invariant Section. + +
    15. Preserve any Warranty Disclaimers. +
    + +

    If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version’s license notice. +These titles must be distinct from any other section titles. +

    +

    You may add a section Entitled “Endorsements”, provided it contains +nothing but endorsements of your Modified Version by various +parties—for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. +

    +

    You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. +

    +

    The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. +

    +
  6. COMBINING DOCUMENTS + +

    You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. +

    +

    The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. +

    +

    In the combination, you must combine any sections Entitled “History” +in the various original documents, forming one section Entitled +“History”; likewise combine any sections Entitled “Acknowledgements”, +and any sections Entitled “Dedications”. You must delete all +sections Entitled “Endorsements.” +

    +
  7. COLLECTIONS OF DOCUMENTS + +

    You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. +

    +

    You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. +

    +
  8. AGGREGATION WITH INDEPENDENT WORKS + +

    A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an “aggregate” if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation’s users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. +

    +

    If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document’s Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. +

    +
  9. TRANSLATION + +

    Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. +

    +

    If a section in the Document is Entitled “Acknowledgements”, +“Dedications”, or “History”, the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. +

    +
  10. TERMINATION + +

    You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. +

    +

    However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. +

    +

    Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. +

    +

    Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. +

    +
  11. FUTURE REVISIONS OF THIS LICENSE + +

    The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +http://www.gnu.org/copyleft/. +

    +

    Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License “or any later version” applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy’s public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. +

    +
  12. RELICENSING + +

    “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +“Massive Multiauthor Collaboration” (or “MMC”) contained in the +site means any set of copyrightable works thus published on the MMC +site. +

    +

    “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. +

    +

    “Incorporate” means to publish or republish a Document, in whole or +in part, as part of another Document. +

    +

    An MMC is “eligible for relicensing” if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. +

    +

    The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. +

    +
+ +

ADDENDUM: How to use this License for your documents

+ +

To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: +

+
+
  Copyright (C)  year  your name.
+  Permission is granted to copy, distribute and/or modify this document
+  under the terms of the GNU Free Documentation License, Version 1.3
+  or any later version published by the Free Software Foundation;
+  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+  Texts.  A copy of the license is included in the section entitled ``GNU
+  Free Documentation License''.
+
+ +

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the “with…Texts.” line with this: +

+
+
    with the Invariant Sections being list their titles, with
+    the Front-Cover Texts being list, and with the Back-Cover Texts
+    being list.
+
+ +

If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. +

+

If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. +

+ + +
+
+
+
+

+Next: , Previous: , Up: GNU History Library   [Contents][Index]

+
+

Appendix B Concept Index

+
+
Jump to:   A +   +E +   +H +   +
+ + + + + + + + + + + + + + +
Index EntrySection
A
anchored searchSearching the History List
E
event designatorsEvent Designators
H
history eventsEvent Designators
history expansionHistory Interaction
History SearchingSearching the History List
+
Jump to:   A +   +E +   +H +   +
+
+ +
+
+
+
+

+Previous: , Up: GNU History Library   [Contents][Index]

+
+

Appendix C Function and Variable Index

+
+
Jump to:   A +   +C +   +F +   +G +   +H +   +N +   +P +   +R +   +S +   +U +   +W +   +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index EntrySection
A
add_historyHistory List Management
add_history_timeHistory List Management
append_historyManaging the History File
C
clear_historyHistory List Management
current_historyInformation About the History List
F
free_history_entryHistory List Management
G
get_history_eventHistory Expansion
H
history_arg_extractHistory Expansion
history_baseHistory Variables
history_comment_charHistory Variables
history_expandHistory Expansion
history_expansion_charHistory Variables
history_getInformation About the History List
history_get_history_stateInitializing History and State Management
history_get_timeInformation About the History List
history_inhibit_expansion_functionHistory Variables
history_is_stifledHistory List Management
history_lengthHistory Variables
history_listInformation About the History List
history_max_entriesHistory Variables
history_no_expand_charsHistory Variables
history_quotes_inhibit_expansionHistory Variables
history_quoting_stateHistory Variables
history_searchSearching the History List
history_search_delimiter_charsHistory Variables
history_search_posSearching the History List
history_search_prefixSearching the History List
history_set_history_stateInitializing History and State Management
history_set_posMoving Around the History List
history_subst_charHistory Variables
history_tokenizeHistory Expansion
history_total_bytesInformation About the History List
history_truncate_fileManaging the History File
history_word_delimitersHistory Variables
history_write_timestampsHistory Variables
N
next_historyMoving Around the History List
P
previous_historyMoving Around the History List
R
read_historyManaging the History File
read_history_rangeManaging the History File
remove_historyHistory List Management
replace_history_entryHistory List Management
S
stifle_historyHistory List Management
U
unstifle_historyHistory List Management
using_historyInitializing History and State Management
W
where_historyInformation About the History List
write_historyManaging the History File
+
Jump to:   A +   +C +   +F +   +G +   +H +   +N +   +P +   +R +   +S +   +U +   +W +   +
+
+ +
+