GSoC/GCI Archive
Google Code-in 2010 DragonFly BSD

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

completed by: yeputons

mentors: Samuel J. Greear, Pratyush Kshirsagar, Venkatesh Srinivas

Sendfile is a used to implement something known as non-blocking i/o, it is a high performance mechanism by which to transmit file data over a socket. Examples for sendfile should demonstrate its behavior in a blocking as well as non-blocking fashion.


Write an EXAMPLES section for the sendfile(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.