home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2007 September / PCWSEP07.iso / Software / Linux / Linux Mint 3.0 Light / LinuxMint-3.0-Light.iso / casper / filesystem.squashfs / usr / share / doc / libpisock9 / README.debugging < prev    next >
Encoding:
Text File  |  2007-02-14  |  3.7 KB  |  113 lines
  1. ======================================================================
  2. README.debugging
  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.
  9.  
  10. Debugging pilot-link
  11. --------------------------------------------------------------------------
  12. To begin debugging problems, the core library "libpisock" contains
  13. runtime debugging features. You do not need to recompile pilot-link to
  14. include these.
  15.  
  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.
  20.  
  21.  
  22. Environment variables for debugging
  23. --------------------------------------------------------------------------
  24.     The runtime debugging is controlled by setting four different
  25.     environment variables. These are:
  26.  
  27.         PILOT_DEBUG
  28.         PILOT_DEBUG_LEVEL
  29.         PILOT_LOG
  30.         PILOT_LOGFILE
  31.  
  32.     PILOT_DEBUG controls what type of information is output to STDOUT or
  33.     your logfile. The levels of information available are:
  34.         
  35.         DEV      Device IO
  36.         SLP      Serial Link Protocol
  37.         PADP     Packet Assembly/Disassembly Protocol
  38.         CMP      Connection Management Protocol
  39.         NET      Network Sync Protocol
  40.         SOCK     Socket Commands
  41.         API      API (datebook, address, todo, memos, etc)
  42.         USER     User data
  43.  
  44.     You can specify multiple types of information to be output/captured
  45.     as follows:
  46.  
  47.         setenv PILOT_DEBUG "DEV SLP PADP" # for csh
  48.  
  49.     or
  50.  
  51.         export PILOT_DEBUG="DEV SLP PADP" # for bash
  52.  
  53.     PILOT_DEBUG_LEVEL controls the level of information displayed for
  54.     each type. The availab levels are:
  55.  
  56.         NONE     No information displayed at all
  57.         ERR      Critical errors
  58.         WARN     Non-critical errors
  59.         INFO     General information
  60.         DEBUG    Verbose debugging info, everything!
  61.  
  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
  65.     wish to use.
  66.  
  67.     If you wish to disable logging for a particular session, just set
  68.     PILOT_LOG to 0.
  69.  
  70.     Here's an example of the overall usage (for bash, your shell may
  71.     vary):
  72.  
  73.         export PILOT_DEBUG="DEV SLP CMP PADP SOCK NET USER"
  74.         export PILOT_DEBUG_LEVEL="DEBUG"
  75.         export PILOT_LOG=1
  76.         export PILOT_LOGFILE="debug.log"
  77.  
  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.
  82.  
  83.  
  84. Capturing the output 
  85. --------------------------------------------------------------------------
  86.     FIXME
  87.  
  88.  
  89. How do I read this stuff?
  90. --------------------------------------------------------------------------
  91.     FIXME
  92.  
  93.  
  94. Now what do I do next?
  95. --------------------------------------------------------------------------
  96.     FIXME
  97.  
  98.  
  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?
  103.  
  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.
  108.  
  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.
  111.  
  112.         We thank you for your contributions, whatever you can offer.
  113.