GSoC/GCI Archive
Google Code-in 2010 DragonFly BSD

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

completed by: Matt Rajca

mentors: Samuel J. Greear, Pratyush Kshirsagar

mmap(2) is used by every program on DragonFly BSD, either directly or indirectly through libc malloc. For programs that want more control than malloc provides, using mmap directly is essential. The mmap API has a large number of options tailored to numerous specific scenarios, the more common of these should be explored in examples.


Write an EXAMPLES section for the mmap(2) manpage(s) showing the usage of the functions defined in those manpage(s) 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.