4
In order to debug problems, libpisock by default contains runtime debugging
6
Pass the --disable-debug configure option to disable at build time. Debugging
7
is enabled by default, so there is no --enable-debugging target.
9
The runtime debugging is controlled by four different environment variables:
16
PILOT_DEBUG controls what types of information are displayed.
21
SLP Serial Link Protocol
22
PADP Packet Assembly/Disassembly Protocol
23
CMP Connection Management Protocol
24
NET Network Sync Protocol
26
API API (datebook, todo, etc)
29
You can specify multiple types of information, ie:
31
PILOT_DEBUG="DEV SLP PADP"
33
PILOT_DEBUG_LEVEL controls the level of information displayed for each type.
39
WARN Non-critical errors
40
INFO General information
41
DEBUG Verbose debugging info
43
If PILOT_LOG is set, the information will be written to the file
44
"pilot-link.debug", this can be overridden by setting PILOT_LOGFILE to the
47
Here's an example of the usage (for bash, your shell may vary):
49
export PILOT_DEBUG="DEV SLP CMP PADP SOCK NET USER"
50
export PILOT_DEBUG_LEVEL="DEBUG"
51
export PILOT_LOG=1 # Set this to 0 to disable debugging
52
export PILOT_LOGFILE="debug.log"
1
======================================================================
3
Author: JP Rosevear, David A. Desrosiers
4
Updated: Mon Oct 16 16:37:45 EDT 2006
5
======================================================================
6
This README will describe in detail, the process and programs necessary
7
to debug any problems you might have with pilot-link with libusb on
8
Linux and Mac OS X machines.
11
--------------------------------------------------------------------------
12
To begin debugging problems, the core library "libpisock" contains
13
runtime debugging features. You do not need to recompile pilot-link to
16
If you want to disable them (not recommended, but you may if you know
17
what you're doing), simply pass the --disable-debug configure option to
18
disable at build time. Debugging is enabled by default, so there is no
19
--enable-debugging target.
22
Environment variables for debugging
23
--------------------------------------------------------------------------
24
The runtime debugging is controlled by setting four different
25
environment variables. These are:
32
PILOT_DEBUG controls what type of information is output to STDOUT or
33
your logfile. The levels of information available are:
36
SLP Serial Link Protocol
37
PADP Packet Assembly/Disassembly Protocol
38
CMP Connection Management Protocol
39
NET Network Sync Protocol
41
API API (datebook, address, todo, memos, etc)
44
You can specify multiple types of information to be output/captured
47
setenv PILOT_DEBUG "DEV SLP PADP" # for csh
51
export PILOT_DEBUG="DEV SLP PADP" # for bash
53
PILOT_DEBUG_LEVEL controls the level of information displayed for
54
each type. The availab levels are:
56
NONE No information displayed at all
58
WARN Non-critical errors
59
INFO General information
60
DEBUG Verbose debugging info, everything!
62
If the variable PILOT_LOG is set (nonzero), the information will be
63
written to the file "pilot-link.debug" by default. This logfile name
64
be overridden by setting PILOT_LOGFILE to the desired file name you
67
If you wish to disable logging for a particular session, just set
70
Here's an example of the overall usage (for bash, your shell may
73
export PILOT_DEBUG="DEV SLP CMP PADP SOCK NET USER"
74
export PILOT_DEBUG_LEVEL="DEBUG"
76
export PILOT_LOGFILE="debug.log"
78
These logs will provide a level of detail necessay for the
79
pilot-link developers (or yourself) to try to track down why your
80
Palm device is not communicating properly with pilot-link on your
81
machine or operating system.
85
--------------------------------------------------------------------------
89
How do I read this stuff?
90
--------------------------------------------------------------------------
94
Now what do I do next?
95
--------------------------------------------------------------------------
99
Donating to pilot-link
100
--------------------------------------------------------------------------
101
Do you like our work? Do you rely on the code we release for
102
your daily work or for your own commercial or OSS project?
104
Please consider donating to keep the project going. We're 100%
105
self-funded, and we see a LOT of traffic from users and
106
downloads. Every contribution helps, whether to pay for
107
bandwidth or to buy devices for testing.
109
You can help support us by visiting the pilot-link.org site and
110
clicking on the "Donate" button on the left side of the page.
112
We thank you for your contributions, whatever you can offer.
added
removed
doc/README.debugging
