Show More
Commit Commit message Age Author Refs
r73:15e817e06815
.dir-locals.el: use clang-format in save-hook.
ng0
0
r72:0376fe0153f7
update tags
convert-repo
0
r71:faf60d131214
clean-all
ng0
0
r70:38ae3bd593b9
AUTHORS
ng0
0
r69:20e9d8aba887
ignore .old files
ng0
0
r68:4b89503fe15d
HACKING, Makefile, add moderately okayish .clang-format file
ng0
0
r67:172473bf1af2
bring in a new oconfigure
ng0
0
r66:57d5fc6ec116
rename
ng0
0
r65:b6ae8d0395d2
dir-locals.el
ng0
0
r64:2ba479112d7e
add ChangeLog, gitignore
ng0
0
< 1 2 3 4 5 .. 8 >

## Synopsis

This utility accepts an [SQLitee](https://www.sqlite.org) header file
`sqlite3.h` and produces a set of decently well-formed
[mdoc(7)](https://man.openbsd.org/OpenBSD-current/man7/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.

This [GitHub](https://www.github.com) repository is a read-only mirror
of the project's CVS repository.

**Note**: this only works with sqlite3, *not* the original `sqlite.h`
format.

## 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 used on OpenBSD, Mac OS X, and Linux machines.

## 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)

## License

All sources use the ISC (like OpenBSD) license.
See the [LICENSE.md](LICENSE.md) file for details.