mirror of
https://github.com/clearlinux/telemetrics-client.git
synced 2026-09-07 06:06:15 +00:00
Auke Kok
3e4360e2cb
This adds several new manual pages to the project, ships them using `dist` and has a simple target to recreate the new roff files using the `ronn` utility: `make manpages`. These man pages are still very crude and contain the absolute minimum amount of information. I've attempted to cross link them as much as is reasonable. The telemetry API is documented in `telemetry(3)`. The important functions themselves are `linked` with a ref link that should make `man tm_create_record` (etc.) link to telemetry(3). I attempted to make this pass `make distcheck` and `make install` properly, but this should still be checked.
14 lines
411 B
Markdown
14 lines
411 B
Markdown
|
|
## Notes on manual pages
|
|
|
|
The manual pages are generated using `ronn(1)`. To recreate them,
|
|
run `make manpages` in the toplevel folder. If you want to edit
|
|
the documentation for upstream changes, make sure to edit the `*.md`
|
|
files and not the shipped nroff output files.
|
|
|
|
|
|
## Generating HTML documentation
|
|
|
|
At toplevel, run 'doxygen docs/Doxyfile'. The documentation is
|
|
generated in the docs/html/ directory.
|