GSoC/GCI Archive
Google Code-in 2010 DragonFly BSD

doc: Write an EXAMPLES section for the setitimer(2) manpage

completed by: Taras Klaskovsky

mentors: Samuel J. Greear, Pratyush Kshirsagar

Interval timers are a useful tool exposed by the kernel that might be somewhat difficult to know how to handle properly without an example.


Write an EXAMPLES section for the setitimer(2) manpage showing the usage of the functions defined in that manpage in a plausible, real-world and if possible only semi-contrived scenario.


All examples should follow the style guidelines in the style(9) manpage.

All examples should be written in a manner that is self-documenting and make copious use of comments in order to explain the actions being taken.

Examples should be real and working code. They should not include headers or even a main function, but it should be reasonable for a developer to copy and paste an example from a manpage and expect it to work.


An example of a manpage with excellent example code is umtx(2).


Deliverables: A complete EXAMPLES manpage section in mdoc format.