https://github.com/kristapsdz/sqlite2mdoc
extract C reference manpages from SQLite header file
https://github.com/kristapsdz/sqlite2mdoc
manpages mdoc sqlite3
Last synced: about 1 month ago
JSON representation
extract C reference manpages from SQLite header file
- Host: GitHub
- URL: https://github.com/kristapsdz/sqlite2mdoc
- Owner: kristapsdz
- License: isc
- Created: 2016-03-28T20:51:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-19T07:01:51.000Z (4 months ago)
- Last Synced: 2025-01-19T08:17:27.663Z (4 months ago)
- Topics: manpages, mdoc, sqlite3
- Language: C
- Size: 2.05 MB
- Stars: 11
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Synopsis
This utility accepts an [SQLite](https://www.sqlite.org) header file
`sqlite3.h` and produces a set of decently well-formed
[mdoc(7)](https://man.openbsd.org/mdoc.7) files
documenting the C API.
These will be roughly equivalent to the [C-language Interface
Specification for SQLite](https://www.sqlite.org/c3ref/intro.html).
You can also use it for any file(s) using the documentation standards of
SQLite.
See the [sqlite2mdoc.1](sqlite2mdoc.1) manpage for syntax details.
**Note**: this only works with sqlite3, *not* the original `sqlite.h`
format.
Release snapshots are archived in
https://kristaps.bsd.lv/sqlite2mdoc/snapshots.
## Installation
Run `./configure` then `make`.
This utility isn't meant for installation, but for integration into your
SQLite deployment phase. You can run `make install`, however, if you
plan on using it for other documentation.
There are no compile-time or run-time dependencies.
This software has been tested and run on
[OpenBSD](https://www.openbsd.org),
[FreeBSD](https://www.freebsd.org),
[NetBSD](https://www.netbsd.org),
IllumOS, Solaris, Mac OS X, and Linux (glibc and musl).
## Examples
I've used [mandoc](https://mandoc.bsd.lv) to generate some Markdown from
the [mdoc(7)](https://man.openbsd.org/mdoc.7) output.
- [sqlite3\_open(3)](samples/sqlite3_open.3.md)
- [SQLITE\_FCNTL\_LOCKSTATE(3)](samples/SQLITE_FCNTL_LOCKSTATE.3.md)
## Testing
The system is tested using [Valgrind](https://valgrind.org/), AFL and
now [AFLplusplus](https://aflplus.plus/), and the ASAN and UBSAN
compiler flags. These are run over the `make regress` regression
analysis. They may be run manually or as part of the CI.
For AFL and AFL++, the `afl` directory contains a simple seed input
file.
## License
All sources use the ISC (like OpenBSD) license.
See the [LICENSE.md](LICENSE.md) file for details.