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