Skip to content

kristapsdz/sqlite2mdoc

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
afl
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Synopsis

This utility accepts an SQLite header file sqlite3.h and produces a set of decently well-formed mdoc(7) files documenting the C API. These will be roughly equivalent to the C-language Interface Specification for SQLite.

You can also use it for any file(s) using the documentation standards of SQLite. See the sqlite2mdoc.1 manpage for syntax details.

This GitHub 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 tested and run on OpenBSD, FreeBSD, NetBSD, IllumOS, Solaris, Mac OS X, and Linux (glibc and musl). The portability measures are continuously tested by the BSD.lv build system.

Examples

I've used mandoc to generate some Markdown from the mdoc(7) output.

License

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

About

extract C reference manpages from SQLite header file

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published