# firebird-documentation

**Repository Path**: mirrors_FirebirdSQL/firebird-documentation

## Basic Information

- **Project Name**: firebird-documentation
- **Description**: Firebird documentation
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Firebird documentation
----------------------

This repository holds the sources of Firebird user documentation. You
can find the documentation in HTML and PDF format on the Firebird site
under [Documentation](https://firebirdsql.org/en/firebird-rdbms/).

After checking out the firebird-documentation repository, and if your
Java environment is set up correctly (Java 17 or higher is required),
open a command window and go to the directory containing 
the firebird-documentation repository. Then give one of these
commands:

```
./gradlew                         [ Unix    ]
.\gradlew                         [ Windows ]
```

to get an overview of compilable targets.

If that worked, try e.g.:

```
./gradlew asciidocHtml             [ Unix    ]
.\gradlew asciidocHtml             [ Windows ]
```

to build the HTML version of the docs.
(Note: the HTML pages will wind up in `build/docs/asciidoc/html/en/firebirddocs`)

To build a specific document, or a document from another set, or another
language, you can specify:

````
./gradlew asciidocHtml --docId=gbak
./gradlew asciidocPdf --baseName=refdocs --docId=fblangref25
./gradlew asciidocHtml --language=de
````

To get more information on a task, use

```
./gradlew help --task=asciidocHtml [ Unix    ]
.\gradlew help --task=asciidocHtml [ Windows ]
```

The repository also contains DocBook 4 sources of some older, unmaintained,
documentation. Building these directly is [no longer supported](devdoc/adr/2026-01-remove-docbook4-build-code.adoc).
If you need to build those documents, it might be an indication they need to be
migrated to AsciiDoc. Please ask for guidance or help on the [firebird-devel list](https://groups.google.com/g/firebird-devel).

If you have any questions, *first* get the [Docbuilding Howto](https://firebirdsql.org/file/documentation/html/en/firebirddocs/docbuildhowto/firebird-docbuilding-howto.html) and [Docwriting Guide](https://www.firebirdsql.org/file/documentation/html/en/firebirddocs/docwritehowto/firebird-docwriting-guide.html)
at:

  https://firebirdsql.org/en/reference-manuals/

If your question isn't answered there, post a message to the Firebird
Development list. You can use this page to subscribe:

  https://groups.google.com/g/firebird-devel