GSoC/GCI Archive
Google Code-in 2013 BRL-CAD

Add missing documentation (for any ONE command) #2

completed by: Shardul Chiplunkar

mentors: Sean

BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:

a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix

This task involves writing basic documentation for '''JUST ONE''' of those commands in the Docbook XML format. Pick one (at random). Spend a few minutes learning how to use the tool, read the soure code for hints, then write a basic manual page for it. The command documentation should provide a one-sentence description, a detailed description (200+ words), explanation of '''all''' available command-line options, and one or two examples on how to use the command.


  • doc/docbook/system/man1/en/
  • doc/docbook/system/man1/en/*.xml