Documentation

 
FreeTDS has three basic pieces of end-user documentation, the FAQ, the User Guide, and the Reference Manual.
 
The Frequently Asked Questions (FAQ) list covers questions the come up often on the mailing list and usually contains known bugs and work arounds, questions about feature support, and common pitfalls first time users may encounter.
 
The FreeTDS User Guide covers how to use FreeTDS to do specific tasks, like how to build FreeTDS, how to make your servers work with FreeTDS, how to configure PHP with FreeTDS, and a nice Troubleshooting section.
 
The FreeTDS Reference Manual is our start at documenting the APIs. In general, the definitive API documentation is available online from the vendors. It will be a big job for us to replace that, and at the rate we're going, we never will. Our first goal is to document our implementation: which functions work, and how well. We haven't reached even that goal yet. The reference manual is generated with Doxygen.
 
If you have checked both of these documents and have not found the answer to your problem, the Mailing List Archive is available for searching.
 
If you are interested in the format of the TDS protocol itself there is some preliminary documentation included with the distribution.
 
Programming documentation including the definition of the libtds API (the low-level interface to the TDS protocol used by dblib, ct-lib, and ODBC) is shipped in the doc/ directory of the source tree.
 

Other Documentation