1 2 doc -- Generate and/or validate documentation 3 4 sak doc ?format? ?module...? 5 6 Convert the documentation for the specified module into the 7 given format. Modules can be specified by their plain name, or 8 as relative path. 9 10 The special format 'validate' causes the tool to syntax check 11 of the input without generating actual output. When output is 12 generated it is written into the sub-directory 'doc'/format of 13 the current working directory. 14 15 The special format 'imake' scans the checkout for manpages and 16 saves the list of found files into a file in the support 17 directory. This files will be put into CVS. The special format 18 'ishow' will dump the contents of this list to stdout. Both 19 have been added to make it easy to verify that a checkout has 20 all manpages it should have. These two formats ignore any 21 module information they are given. 22 23 The format is actually a glob and output is generated for all 24 known formats matching it. It is implicitly padded with a * to 25 allow the use of prefixes. 26 27 The known output formats (beyond 'validate') are 28 29 - dvi See latex, + conversion to dvi (via 'latex' application) 30 - html HTML pages 31 - latex LaTeX pages 32 - list A list of manpages 33 - nroff Manpages 34 - ps See dvi, + conversion to PostScript (via 'dvips' application) 35 - pdf See ps, + conversion to PDF (via 'ps2pdf' application) 36 - text Plain text 37 - tmml TMML (Tcl Manpage Markup Language) 38 - wiki Wiki markup (Tcler's Wiki) 39 40 - validate Validate syntax, no output 41 - imake Make list of all manpages and save in checkout, no output. 42 - ishow Print list of manpages saved in checkout to stdout. 43