1[comment {-*- tcl -*- doctools manpage}] 2[manpage_begin bench::out::text n 0.1.2] 3[see_also bench] 4[see_also bench::out::csv] 5[keywords benchmark] 6[keywords formatting] 7[keywords {human readable}] 8[keywords performance] 9[keywords testing] 10[keywords text] 11[copyright {2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>}] 12[moddesc {Benchmarking/Performance tools}] 13[titledesc {bench::out::text - Formatting benchmark results as human readable text}] 14[category {Benchmark tools}] 15[require Tcl 8.2] 16[require bench::out::text [opt 0.1.2]] 17[description] 18 19This package provides commands for fomatting of benchmark results into 20human readable text. 21 22[para] 23 24A reader interested in the generation or processing of such results should 25go and read [term {bench - Processing benchmark suites}] instead. 26 27[para] 28 29If the bench language itself is the actual interest please start with 30the [term {bench language introduction}] and then proceed from there 31to the formal [term {bench language specification}]. 32 33[para] 34 35[section {PUBLIC API}] 36 37[list_begin definitions] 38 39[call [cmd ::bench::out::text] [arg bench_result]] 40 41This command formats the specified benchmark result for output to a 42file, socket, etc. This specific command generates human readable 43text. 44 45[para] 46 47For other formatting styles see the packages [package bench] and 48[package bench::out::csv] which provide commands to format benchmark 49results in raw form, or as importable CSV data, respectively. 50 51[list_end] 52 53[vset CATEGORY bench] 54[include ../common-text/feedback.inc] 55[manpage_end] 56