https://github.com/firebirdsql/jaybird-manual
Jaybird JDBC Driver Java Programmer's Manual
https://github.com/firebirdsql/jaybird-manual
documentation firebird java jaybird jdbc
Last synced: about 1 year ago
JSON representation
Jaybird JDBC Driver Java Programmer's Manual
- Host: GitHub
- URL: https://github.com/firebirdsql/jaybird-manual
- Owner: FirebirdSQL
- License: other
- Created: 2016-02-13T13:14:34.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T15:03:35.000Z (about 1 year ago)
- Last Synced: 2025-04-04T16:28:23.749Z (about 1 year ago)
- Topics: documentation, firebird, java, jaybird, jdbc
- Language: Groovy
- Homepage: https://firebirdsql.github.io/jaybird-manual/jaybird_manual.html
- Size: 16.3 MB
- Stars: 7
- Watchers: 7
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# jaybird-manual
Jaybird JDBC Driver Java Programmer's Manual [](https://github.com/FirebirdSQL/jaybird-manual/actions?query=branch%3Amaster+workflow%3Apublish-to-github-pages)
Manual for [Jaybird](https://github.com/FirebirdSQL/jaybird), the Firebird JDBC driver.
Snapshot build of manual
========================
You can see the latest snapshot build of the manual on https://firebirdsql.github.io/jaybird-manual/jaybird_manual.html.
We also provide a print-friendly PDF on https://firebirdsql.github.io/jaybird-manual/jaybird_manual.pdf.
These documents are automatically built for each change on master.
Style
=====
Line breaking convention: a single sentence per line, no line breaks within a sentence. If a line
becomes too long, take that as a hint to rewrite (if possible).
NOTE: The previous convention was 100 characters per line. Only apply the single sentence per line style
per paragraph when making changes in that paragraph.
Sourcecode examples: indent 2 spaces, continuations: 4 spaces
How to build
============
Run `./gradlew` or its full equivalent `./gradlew clean asciidoctor`.
Add `asciidoctorPdf` for the PDF version.
Building the documentation requires Java 9 or higher, use of Java 17 or higher is advisable.
Supporting information
======================
This project uses [asciidoctor](https://asciidoctor.org/).
Reporting bugs
==============
Please report bugs or corrections through [issues](https://github.com/FirebirdSQL/jaybird-manual/issues) or create a pull request with your improvements.