{ "content": [ { "type": "text", "text": "# dumpkeys (man)\n\n## NAME\n\ndumpkeys - dump keyboard translation tables\n\n## SYNOPSIS\n\ndumpkeys [OPTIONS]\n\n## DESCRIPTION\n\ndumpkeys writes, to the standard output, the current contents of the keyboard driver's trans‐\nlation tables, in the format specified by keymaps(5).\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (14 subsections)\n- **FILES**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "dumpkeys", "section": "", "mode": "man", "summary": "dumpkeys - dump keyboard translation tables", "synopsis": "dumpkeys [OPTIONS]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-h", "long": "--help", "arg": null, "description": "Prints the program's version number and a short usage message to the program's stan‐ dard error output and exits." }, { "flag": "-i", "long": "--short-info", "arg": null, "description": "Prints some characteristics of the kernel's keyboard driver. The items shown are: Keycode range supported by the kernel This tells what values can be used after the keycode keyword in keytable files. See keymaps(5) for more information and the syntax of these files. Number of actions bindable to a key This tells how many different actions a single key can output using various modifier keys. If the value is 16 for example, you can define up to 16 differ‐ ent actions to a key combined with modifiers. When the value is 16, the kernel probably knows about four modifier keys, which you can press in different com‐ binations with the key to access all the bound actions. Ranges of action codes supported by the kernel This item contains a list of action code ranges in hexadecimal notation. These are the values that can be used in the right hand side of a key definition, ie. the vv's in a line keycode xx = vv vv vv vv (see keymaps(5) for more information about the format of key definition lines). dumpkeys(1) and loadkeys(1) support a symbolic notation, which is preferable to the numeric one, as the action codes may vary from kernel to kernel while the symbolic names usually remain the same. However, the list of action code ranges can be used to determine, if the kernel actually supports all the symbols load‐ keys(1) knows, or are there maybe some actions supported by the kernel that have no symbolic name in your loadkeys(1) program. To see this, you compare the range list with the action symbol list, see option --long-info below. Number of function keys supported by kernel This tells the number of action codes that can be used to output strings of characters. These action codes are traditionally bound to the various function and editing keys of the keyboard and are defined to send standard escape se‐ quences. However, you can redefine these to send common command lines, email addresses or whatever you like. Especially if the number of this item is greater than the number of function and editing keys in your keyboard, you may have some \"spare\" action codes that you can bind to AltGr-letter combinations, for example, to send some useful strings. See loadkeys(1) for more details. Function strings You can see you current function key definitions with the command dumpkeys --funcs-only" }, { "flag": "-s", "long": "--long-info", "arg": null, "description": "This option instructs dumpkeys to print a long information listing. The output is the same as with the --short-info appended with the list of action symbols supported by loadkeys(1) and dumpkeys(1), along with the symbols' numeric values." }, { "flag": "-n", "long": "--numeric", "arg": null, "description": "This option causes dumpkeys to by-pass the conversion of action code values to sym‐ bolic notation and to print the in hexadecimal format instead." }, { "flag": "-f", "long": "--full-table", "arg": null, "description": "This makes dumpkeys skip all the short-hand heuristics (see keymaps(5)) and output the key bindings in the canonical form. First a keymaps line describing the currently de‐ fined modifier combinations is printed. Then for each key a row with a column for each modifier combination is printed. For example, if the current keymap in use uses seven modifiers, every row will have seven action code columns. This format can be useful for example to programs that post-process the output of dumpkeys." }, { "flag": "", "long": "--shape", "arg": "_", "description": "Available shapes: 2 default output. 4 one line for each keycode. 8 one line for each (modifier,keycode) pair. 16 one line for each keycode until 1st hole." }, { "flag": "-1", "long": "--separate-lines", "arg": null, "description": "This forces dumpkeys to write one line per (modifier,keycode) pair. It prefixes the word plain for plain keycodes." }, { "flag": "-t", "long": "--funcs-only", "arg": null, "description": "When this option is given, dumpkeys prints only the function key string definitions. Normally dumpkeys prints both the key bindings and the string definitions." }, { "flag": "-k", "long": "--keys-only", "arg": null, "description": "When this option is given, dumpkeys prints only the key bindings. Normally dumpkeys prints both the key bindings and the string definitions." }, { "flag": "-d", "long": "--compose-only", "arg": null, "description": "When this option is given, dumpkeys prints only the compose key combinations. This option is available only if your kernel has compose key support." }, { "flag": "", "long": "--charset", "arg": "_", "description": "This instructs dumpkeys to interpret character code values according to the specified character set. This affects only the translation of character code values to symbolic names. Valid values for charset currently are iso-8859-X, Where X is a digit in 1-9. If no charset is specified, iso-8859-1 is used as a default. This option produces an output line `charset \"iso-8859-X\"', telling loadkeys how to interpret the keymap. (For example, \"division\" is 0xf7 in iso-8859-1 but 0xba in iso-8859-8.)" }, { "flag": "", "long": "--console", "arg": "_", "description": "The affected console device can be specified using the -C (or --console ) option. This option supports exactly one device name." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "Turn on verbose output." }, { "flag": "-V", "long": "--version", "arg": null, "description": "Prints version number and exits." } ], "examples": [], "see_also": [ { "name": "loadkeys", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/loadkeys/1/json" }, { "name": "keymaps", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/keymaps/5/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 6, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-h --help", "lines": 3, "flag": "-h", "long": "--help" }, { "name": "-i --short-info", "lines": 49, "flag": "-i", "long": "--short-info" }, { "name": "-l -s --long-info", "lines": 4, "flag": "-s", "long": "--long-info" }, { "name": "-n --numeric", "lines": 3, "flag": "-n", "long": "--numeric" }, { "name": "-f --full-table", "lines": 7, "flag": "-f", "long": "--full-table" }, { "name": "-S_ --shape=_", "lines": 10, "long": "--shape", "arg": "_" }, { "name": "-1 --separate-lines", "lines": 3, "flag": "-1", "long": "--separate-lines" }, { "name": "-t --funcs-only", "lines": 3, "flag": "-t", "long": "--funcs-only" }, { "name": "-k --keys-only", "lines": 3, "flag": "-k", "long": "--keys-only" }, { "name": "-d --compose-only", "lines": 3, "flag": "-d", "long": "--compose-only" }, { "name": "-c_ --charset=_", "lines": 7, "long": "--charset", "arg": "_" }, { "name": "-C_ --console=_", "lines": 3, "long": "--console", "arg": "_" }, { "name": "-v --verbose", "lines": 2, "flag": "-v", "long": "--verbose" }, { "name": "-V --version", "lines": 2, "flag": "-V", "long": "--version" } ] }, { "name": "FILES", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 4, "subsections": [] } ], "sections": { "NAME": { "content": "dumpkeys - dump keyboard translation tables\n", "subsections": [] }, "SYNOPSIS": { "content": "dumpkeys [OPTIONS]\n", "subsections": [] }, "DESCRIPTION": { "content": "dumpkeys writes, to the standard output, the current contents of the keyboard driver's trans‐\nlation tables, in the format specified by keymaps(5).\n\nUsing the various options, the format of the output can be controlled and also other informa‐\ntion from the kernel and the programs dumpkeys(1) and loadkeys(1) can be obtained.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-h --help", "content": "Prints the program's version number and a short usage message to the program's stan‐\ndard error output and exits.\n", "flag": "-h", "long": "--help" }, { "name": "-i --short-info", "content": "Prints some characteristics of the kernel's keyboard driver. The items shown are:\n\nKeycode range supported by the kernel\n\nThis tells what values can be used after the keycode keyword in keytable files.\nSee keymaps(5) for more information and the syntax of these files.\n\nNumber of actions bindable to a key\n\nThis tells how many different actions a single key can output using various\nmodifier keys. If the value is 16 for example, you can define up to 16 differ‐\nent actions to a key combined with modifiers. When the value is 16, the kernel\nprobably knows about four modifier keys, which you can press in different com‐\nbinations with the key to access all the bound actions.\n\nRanges of action codes supported by the kernel\n\nThis item contains a list of action code ranges in hexadecimal notation. These\nare the values that can be used in the right hand side of a key definition, ie.\nthe vv's in a line\n\nkeycode xx = vv vv vv vv\n\n(see keymaps(5) for more information about the format of key definition lines).\ndumpkeys(1) and loadkeys(1) support a symbolic notation, which is preferable to\nthe numeric one, as the action codes may vary from kernel to kernel while the\nsymbolic names usually remain the same. However, the list of action code ranges\ncan be used to determine, if the kernel actually supports all the symbols load‐\nkeys(1) knows, or are there maybe some actions supported by the kernel that\nhave no symbolic name in your loadkeys(1) program. To see this, you compare the\nrange list with the action symbol list, see option --long-info below.\n\nNumber of function keys supported by kernel\n\nThis tells the number of action codes that can be used to output strings of\ncharacters. These action codes are traditionally bound to the various function\nand editing keys of the keyboard and are defined to send standard escape se‐\nquences. However, you can redefine these to send common command lines, email\naddresses or whatever you like. Especially if the number of this item is\ngreater than the number of function and editing keys in your keyboard, you may\nhave some \"spare\" action codes that you can bind to AltGr-letter combinations,\nfor example, to send some useful strings. See loadkeys(1) for more details.\n\nFunction strings\n\nYou can see you current function key definitions with the command\n\ndumpkeys --funcs-only\n", "flag": "-i", "long": "--short-info" }, { "name": "-l -s --long-info", "content": "This option instructs dumpkeys to print a long information listing. The output is the\nsame as with the --short-info appended with the list of action symbols supported by\nloadkeys(1) and dumpkeys(1), along with the symbols' numeric values.\n", "flag": "-s", "long": "--long-info" }, { "name": "-n --numeric", "content": "This option causes dumpkeys to by-pass the conversion of action code values to sym‐\nbolic notation and to print the in hexadecimal format instead.\n", "flag": "-n", "long": "--numeric" }, { "name": "-f --full-table", "content": "This makes dumpkeys skip all the short-hand heuristics (see keymaps(5)) and output the\nkey bindings in the canonical form. First a keymaps line describing the currently de‐\nfined modifier combinations is printed. Then for each key a row with a column for each\nmodifier combination is printed. For example, if the current keymap in use uses seven\nmodifiers, every row will have seven action code columns. This format can be useful\nfor example to programs that post-process the output of dumpkeys.\n", "flag": "-f", "long": "--full-table" }, { "name": "-S_ --shape=_", "content": "Available shapes:\n\n2 default output.\n\n4 one line for each keycode.\n\n8 one line for each (modifier,keycode) pair.\n\n16 one line for each keycode until 1st hole.\n", "long": "--shape", "arg": "_" }, { "name": "-1 --separate-lines", "content": "This forces dumpkeys to write one line per (modifier,keycode) pair. It prefixes the\nword plain for plain keycodes.\n", "flag": "-1", "long": "--separate-lines" }, { "name": "-t --funcs-only", "content": "When this option is given, dumpkeys prints only the function key string definitions.\nNormally dumpkeys prints both the key bindings and the string definitions.\n", "flag": "-t", "long": "--funcs-only" }, { "name": "-k --keys-only", "content": "When this option is given, dumpkeys prints only the key bindings. Normally dumpkeys\nprints both the key bindings and the string definitions.\n", "flag": "-k", "long": "--keys-only" }, { "name": "-d --compose-only", "content": "When this option is given, dumpkeys prints only the compose key combinations. This\noption is available only if your kernel has compose key support.\n", "flag": "-d", "long": "--compose-only" }, { "name": "-c_ --charset=_", "content": "This instructs dumpkeys to interpret character code values according to the specified\ncharacter set. This affects only the translation of character code values to symbolic\nnames. Valid values for charset currently are iso-8859-X, Where X is a digit in 1-9.\nIf no charset is specified, iso-8859-1 is used as a default. This option produces an\noutput line `charset \"iso-8859-X\"', telling loadkeys how to interpret the keymap. (For\nexample, \"division\" is 0xf7 in iso-8859-1 but 0xba in iso-8859-8.)\n", "long": "--charset", "arg": "_" }, { "name": "-C_ --console=_", "content": "The affected console device can be specified using the -C (or --console ) option. This\noption supports exactly one device name.\n", "long": "--console", "arg": "_" }, { "name": "-v --verbose", "content": "Turn on verbose output.\n", "flag": "-v", "long": "--verbose" }, { "name": "-V --version", "content": "Prints version number and exits.\n", "flag": "-V", "long": "--version" } ] }, "FILES": { "content": "/usr/share/keymaps\nThe recommended directory for keytable files.\n", "subsections": [] }, "SEE ALSO": { "content": "loadkeys(1), keymaps(5)\n\n\nkbd 1 Sep 1993 DUMPKEYS(1)", "subsections": [] } } } }