Fix to include keysym.h - may be required on other versions of Xorg
[softwedge.git] / README
blobdf117023c117547b6eb0e3e741915e8bea48d0b7
1 softwedge: A serial software keyboard wedge for *nix X11
2            (c) 2007 Yann Ramin <atrus@stackworks.net>
3 ---------------------------------------------------------
5 softwedge is a small Linux utility which forwards
6 data from a serial port (such as from a tty, or a barcode
7 scanner) and re-issues the data as X11 key press events.
9 softwedge was designed to allow ordinary applications 
10 to accept data from a Bluetooth barcode scanner (for testing,
11 the author used a Metrologic FocusBT, though any *decoded* serial
12 or Bluetooth barcode scanner should work). 
13 Un-decoded scanners won't work - softwedge expects input near 
14 the US-ASCII character-set, though not all control codes work at this time.
16 Quick start:
17 ------------
19 make
20 make install
22 (If serial port is /dev/rfcomm0)
23 softwedge
24 (or)
25 softwedge -c /dev/ttyWhatever
27 Options:
28 --------
30 -c:
31         Sets serial port 
32 -f:
33         Run in the foreground - don't fork
34 -v:
35         See version information
38 Limitations:
39 ------------
41 - Softwedge can't set any serial port parameters - use
42   stty
44 - No support of input cleanup is supported      
45   (extra LF removal, etc)
46 - Not all escape codes will directly transfer to X11 input at this time.
47   I.e., FedEx PDF417 codes, UPS MaxiCode
48 - International barcode character sets are untested (i.e. QR Code)
50 Future:
51 -------
53 - Multiple input methods to allow for more international control
54   i.e. text to clipboard
55 - Testing of more control codes
56 - Support of more Barcode specific features 
57           - FocusBT encryption support, 2-way support
58 - GUI config tool
59 - and more...