~smlavine/err

Small error-printing library for C

7c5346e Add version identifiers to source files

~smlavine pushed to ~smlavine/err git

2 months ago

35f9fa9 Release 1.1.0

~smlavine pushed to ~smlavine/err git

2 months ago

#err - Small error-printing library for C

err is a small error-printing library for C programs. It was initially written as part of navipage. For examples of its use, see that project.

err can be used in projects written in any major version of C or C++.

These functions print exclusively to stderr.

The BSDes provide similar functionality in their standard library with a file of the same name. This library does not implement that interface, and might behave completely differently.

#Using err

  • Copy err.c and err.h into your project.
  • #include "err.h" in files where you want to use err functions.
  • Assign a value to argv0 before calling any err functions.
  • Call functions from err as you see fit!

#Documentation

err uses Doxygen to generate documentation. To compile the documentation into a readable form, run doxygen. The generated files will be put into the docs/ directory.

Documentation is compiled to HTML and manpage formats. The HTML documentation will be made available in an online form soon™.

The source code comments can also be read directly.

See the examples/ directory for example programs.

Copyright (C) 2021-2022 Sebastian LaVine mail@smlavine.com

err is published and made available under the terms of version 2.0 of the Mozilla Public License. A copy of the MPL-2.0 is distributed with err; alternatively you can obtain one at http://mozilla.org/MPL/2.0/.


This project is hosted at https://sr.ht/~smlavine/err.

To browse the source code repository, see https://git.sr.ht/~smlavine/err.

For patches and discussion related to the project, see the mailing list at https://lists.sr.ht/~smlavine/public-inbox. If you've used err in your own project, I'd love to hear about it!

For announcements related to the project, see the mailing list at https://lists.sr.ht/~smlavine/err-announce.