Home | History | Annotate | Line # | Download | only in sqlite2mdoc 
      1 ## Synopsis
      2 
      3 This utility accepts an [SQLite](https://www.sqlite.org) header file
      4 `sqlite3.h` and produces a set of decently well-formed
      5 [mdoc(7)](https://man.openbsd.org/mdoc.7) files
      6 documenting the C API.
      7 These will be roughly equivalent to the [C-language Interface
      8 Specification for SQLite](https://www.sqlite.org/c3ref/intro.html).
      9 
     10 You can also use it for any file(s) using the documentation standards of
     11 SQLite.
     12 See the [sqlite2mdoc.1](sqlite2mdoc.1) manpage for syntax details.
     13 
     14 **Note**: this only works with sqlite3, *not* the original `sqlite.h`
     15 format.
     16 
     17 Release snapshots are archived in
     18 https://kristaps.bsd.lv/sqlite2mdoc/snapshots.
     19 
     20 ## Installation
     21 
     22 Run `./configure` then `make`.
     23 
     24 This utility isn't meant for installation, but for integration into your
     25 SQLite deployment phase.  You can run `make install`, however, if you
     26 plan on using it for other documentation.
     27 
     28 There are no compile-time or run-time dependencies.
     29 
     30 This software has been tested and run on 
     31 [OpenBSD](https://www.openbsd.org),
     32 [FreeBSD](https://www.freebsd.org),
     33 [NetBSD](https://www.netbsd.org),
     34 IllumOS, Solaris, Mac OS X, and Linux (glibc and musl).
     35 
     36 ## Examples
     37 
     38 I've used [mandoc](https://mandoc.bsd.lv) to generate some Markdown from
     39 the [mdoc(7)](https://man.openbsd.org/mdoc.7) output.
     40 
     41 - [sqlite3\_open(3)](samples/sqlite3_open.3.md)
     42 - [SQLITE\_FCNTL\_LOCKSTATE(3)](samples/SQLITE_FCNTL_LOCKSTATE.3.md)
     43 
     44 ## License
     45 
     46 All sources use the ISC (like OpenBSD) license.
     47 See the [LICENSE.md](LICENSE.md) file for details.
     48