Questions about libnmsg, nmsgtool, pynmsg, the development of libnmsg client programs or language bindings, or the NMSG binary protocol should be directed to the nmsg-dev mailing list:

https://lists.farsightsecurity.com/mailman/listinfo/nmsg-dev

nmsg has the following external dependencies:

• pcap

• protobuf

• protobuf-c

• wdns

• libxs

• zlib

On Debian systems, the following packages should be installed, if available:

pkg-config libpcap0.8-dev libprotobuf-c0-dev protobuf-c-compiler libxs-dev zlib1g-dev

On FreeBSD systems, the following ports should be installed, if available:

devel/libxs
devel/pkgconf
devel/protobuf
devel/protobuf-c

After satisfying the prerequisites, ./configure && make && make install should compile and install libnmsg and nmsgtool to /usr/local. If building from a git checkout, run the ./autogen.sh command first to generate the configure script.

Support for libxs can be disabled by passing the --without-libxs parameter to the configure script.

The documentation for the libnmsg API is located in the doc/doxygen/html directory. To rebuild the API documentation, run make html. This requires Doxygen to be installed.

The manpage documentation is built using DocBook 5, DocBook XSL, and xsltproc. git checkouts do not include the built manpages, but tarball releases do. To build the documentation on Debian systems, the following packages should be installed:

docbook5-xml docbook-xsl-ns xsltproc

libnmsg can be extended at runtime with new message types by installing message modules into the libnmsg module directory, which defaults to $PREFIX/lib/nmsg. This location is configurable by passing the --with-plugindir parameter to the configure script.

C language examples are in the examples/ directory.