summaryrefslogtreecommitdiffstats
path: root/man/keyfuzz.8.xml.in
blob: 60a31805f78d27506fa4c5e969530f0a5c45e83c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
<?xml version="1.0" standalone='no'?> <!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>

<!-- $Id$ -->

<!-- 
  This file is part of keyfuzz.

  keyfuzz 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.

  keyfuzz 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 keyfuzz; if not, write to the Free Software Foundation,
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
-->

  <manpage name="keyfuzz" section="8" desc="Modify keyboard scancode tables of the Linux input layer">

	<synopsis>
	  <cmd>keyfuzz [<arg>options</arg>]</cmd>
	</synopsis>
	
    <description>

      <p>You may use keyfuzz to manipulate the scancode/keycode
      translation tables of keyboard drivers supporting the Linux
      input layer API. ("evdev API") </p>

	</description>
	
	<options>
	  
	  <option>
		<p><opt>-g | --get</opt></p>
		<optdesc><p>Dump the current scancode translation table of the device to STDOUT.</p></optdesc>
	  </option> 
	  
	  <option>
		<p><opt>-s | --set</opt></p>
		<optdesc><p>Merge the translation table passed through STDIN into the current translation table of the device.</p></optdesc>
	  </option> 
	  
	  <option>
		<p><opt>-i | --info</opt></p>
		<optdesc><p>Show some information about the specified device.</p></optdesc>
	  </option>
	  
	  <option>
		<p><opt>-d | --device=</opt>DEVICE</p> 
		<optdesc><p>Use the specified event device. The virtual file
		/proc/bus/input/devices lists all input devices available on
		the local system. (Default: /dev/input/event0)</p></optdesc>
	  </option>

      <option>
       <p><opt>-v | --vebose</opt></p>
       <optdesc><p>Enable verbose mode. If used together with <opt>--set</opt> all translation tables changes are printed to STDERR.</p></optdesc>
      </option>

	  <option>
		<p><opt>-h | --help</opt></p>
		<optdesc><p>Show help</p></optdesc>
	  </option>
	  
	  <option>
		<p><opt>-v | --version</opt></p>
        <optdesc><p>Show version</p></optdesc>
	  </option> 
      
	</options>
	
	<section name="Translation tables">
	  <p>The scancode/keycode translation tables as read from STDIN or
	  written to STDOUT are formatted as follows: lines beginning with
	  a hashmark and empty lines are ignored. All other lines have to
	  contain a scancode and a keycode number separated by white
	  space. The numbers may be specified either in decimal or in
	  hexadecimal notation. In the latter case, a 0x as to be
	  prepended. You may save the current table by passing
	  <opt>--get</opt> to keyfuzz and storing its output in a
	  file. Then, you may restore the table by passing the contents of
	  that file back to keyfuzz with <opt>--set</opt>.</p>
	</section>

	<section name="Author">
	  <p>keyfuzz was written by Lennart Poettering
		&lt;@PACKAGE_BUGREPORT@&gt;. keyfuzz is available
		at <url
		href="@PACKAGE_URL@"/>
	  </p>
	</section>
	
	<section name="Comments">
	  <p>This man page was written using <manref name="xmltoman" section="1"
		  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
	</section>
	
  </manpage>