GSoC/GCI Archive
Google Code-in 2010 DragonFly BSD

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

completed by: gh0st

mentors: Samuel J. Greear, Pratyush Kshirsagar

poll is used to bundle many sockets together in an effort to more efficiently be notified of changes on those sockets, such as when data is available for the program to read, or room in the kernel buffers is available for the program to write into. poll should be demonstrated in a working example on at least a non-blocking socket for both read and write.


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