← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/programs/Xserver/hw/darwin/utils/README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/programs/Xserver/hw/darwin/utils/README.txt
 
1
dumpkeymap - Diagnostic dump and detailed description of .keymapping files
 
2
Version 4
 
3
 
 
4
Copyright (C)1999,2000 by Eric Sunshine <sunshine@sunshineco.com>
 
5
Eric Sunshine, 1 December 2000
 
6
 
 
7
OVERVIEW
 
8
========
 
9
This package contains the diagnostic utility dumpkeymap, as well as highly
 
10
detailed documentation describing the internal layout of the Apple/NeXT
 
11
.keymapping file.
 
12
 
 
13
The dumpkeymap utility displays detailed information about each .keymapping
 
14
file mentioned on the command-line.  On Apple and NeXT platforms, if no
 
15
.keymapping files are mentioned on the command-line, then it will instead
 
16
dissect the key mapping currently in use by the WindowServer and AppKit.
 
17
 
 
18
Documentation includes a thorough and detailed description of the internal
 
19
layout of the .keymapping file, as well as an explanation of how to interpret
 
20
the output of dumpkeymap.
 
21
 
 
22
The complete set of documentation is available for perusal via dumpkeymap's
 
23
manual page (dumpkeymap.1), as well as via the command-line options described
 
24
below.
 
25
 
 
26
    --help
 
27
        Usage summary.
 
28
    --help-keymapping
 
29
        Detailed discussion of the internal format of a .keymapping file.
 
30
    --help-output
 
31
        Explanation of dumpkeymap's output.
 
32
    --help-files
 
33
        List of key mapping-related files and directories.
 
34
    --help-diagnostics
 
35
        Explanation of diagnostic messages.
 
36
 
 
37
Once the manual page is been installed, documentation can also be accessed
 
38
with the Unix `man' command:
 
39
 
 
40
    % man dumpkeymap
 
41
 
 
42
 
 
43
COMPILATION
 
44
===========
 
45
MacOS/X, Darwin
 
46
 
 
47
    cc -Wall -o dumpkeymap dumpkeymap.c -framework IOKit
 
48
 
 
49
MacOS/X DP4 (Developer Preview 4)
 
50
 
 
51
    cc -Wall -o dumpkeymap dumpkeymap.c -FKernel -framework IOKit
 
52
 
 
53
MacOS/X Server, OpenStep, NextStep
 
54
 
 
55
    cc -Wall -o dumpkeymap dumpkeymap.c
 
56
 
 
57
By default, dumpkeymap is configured to interface with the HID driver (Apple)
 
58
or event-status driver (NeXT), thus allowing it to dump the key mapping which
 
59
is currently in use by the WindowServer and AppKit.  However, these facilities
 
60
are specific to Apple/NeXT.  In order to build dumpkeymap for non-Apple/NeXT
 
61
platforms, you must define the DUMPKEYMAP_FILE_ONLY flag when compiling the
 
62
program.  This flag inhibits use of the HID and event-status drivers and
 
63
configures dumpkeymap to work strictly with raw key mapping files.
 
64
 
 
65
For example, to compile for Linux:
 
66
 
 
67
    gcc -Wall -DDUMPKEYMAP_FILE_ONLY -o dumpkeymap dumpkeymap.c
 
68
 
 
69
 
 
70
INSTALLATION
 
71
============
 
72
Install the dumpkeymap executable image in a location mentioned in the PATH
 
73
environment variable.  Typicall locations for executable files are:
 
74
 
 
75
    /usr/local/bin
 
76
    $(HOME)/bin
 
77
 
 
78
Install the manual page, dumpkeymap.1, in the `man1' subdirectory one of the
 
79
standard manual page locations or in any other location mentioned by the
 
80
MANPATH environment variable.
 
81
 
 
82
Typical locations for manual pages on most Unix platforms are:
 
83
 
 
84
    /usr/local/man/man1
 
85
 
 
86
Typical locations for manual pages on MacOS/X, Darwin, and MacOS/X Server are:
 
87
 
 
88
    /usr/local/man/man1
 
89
    /Local/Documentation/ManPages/man1
 
90
    /Network/Documentation/ManPages/man1
 
91
 
 
92
Typical locations for manual pages on OpenStep and NextStep are:
 
93
 
 
94
    /usr/local/man/man1
 
95
    /LocalLibrary/Documentation/ManPages/man1
 
96
    /LocalDeveloper/Documentation/ManPages/man1
 
97
 
 
98
 
 
99
CONCLUSION
 
100
==========
 
101
This program and its accompanying documentation were written by Eric Sunshine
 
102
and are copyright (C)1999,2000 by Eric Sunshine <sunshine@sunshineco.com>.
 
103
 
 
104
The implementation of dumpkeymap is based upon information gathered on
 
105
September 3, 1997 by Eric Sunshine <sunshine@sunshineco.com> and Paul S.
 
106
McCarthy <zarnuk@zarnuk.com> during an effort to reverse engineer the format
 
107
of the NeXT .keymapping file.
 
108
 
 
109
 
 
110
 
 
111
$XFree86: xc/programs/Xserver/hw/darwin/utils/README.txt,v 1.2 2000/12/05 21:18:34 dawes Exp $