1
2[//000000001]: # (bench::out::text \- Benchmarking/Performance tools)
3[//000000002]: # (Generated from file 'bench\_wtext\.man' by tcllib/doctools with format 'markdown')
4[//000000003]: # (Copyright &copy; 2007 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>)
5[//000000004]: # (bench::out::text\(n\) 0\.1\.2 tcllib "Benchmarking/Performance tools")
6
7<hr> [ <a href="../../../../toc.md">Main Table Of Contents</a> &#124; <a
8href="../../../toc.md">Table Of Contents</a> &#124; <a
9href="../../../../index.md">Keyword Index</a> &#124; <a
10href="../../../../toc0.md">Categories</a> &#124; <a
11href="../../../../toc1.md">Modules</a> &#124; <a
12href="../../../../toc2.md">Applications</a> ] <hr>
13
14# NAME
15
16bench::out::text \- bench::out::text \- Formatting benchmark results as human
17readable text
18
19# <a name='toc'></a>Table Of Contents
20
21  - [Table Of Contents](#toc)
22
23  - [Synopsis](#synopsis)
24
25  - [Description](#section1)
26
27  - [PUBLIC API](#section2)
28
29  - [Bugs, Ideas, Feedback](#section3)
30
31  - [See Also](#seealso)
32
33  - [Keywords](#keywords)
34
35  - [Category](#category)
36
37  - [Copyright](#copyright)
38
39# <a name='synopsis'></a>SYNOPSIS
40
41package require Tcl 8\.2
42package require bench::out::text ?0\.1\.2?
43
44[__::bench::out::text__ *bench\_result*](#1)
45
46# <a name='description'></a>DESCRIPTION
47
48This package provides commands for fomatting of benchmark results into human
49readable text\.
50
51A reader interested in the generation or processing of such results should go
52and read *[bench \- Processing benchmark suites](bench\.md)* instead\.
53
54If the bench language itself is the actual interest please start with the
55*[bench language introduction](bench\_lang\_intro\.md)* and then proceed from
56there to the formal *[bench language specification](bench\_lang\_spec\.md)*\.
57
58# <a name='section2'></a>PUBLIC API
59
60  - <a name='1'></a>__::bench::out::text__ *bench\_result*
61
62    This command formats the specified benchmark result for output to a file,
63    socket, etc\. This specific command generates human readable text\.
64
65    For other formatting styles see the packages __[bench](bench\.md)__
66    and __[bench::out::csv](bench\_wcsv\.md)__ which provide commands to
67    format benchmark results in raw form, or as importable CSV data,
68    respectively\.
69
70# <a name='section3'></a>Bugs, Ideas, Feedback
71
72This document, and the package it describes, will undoubtedly contain bugs and
73other problems\. Please report such in the category *bench* of the [Tcllib
74Trackers](http://core\.tcl\.tk/tcllib/reportlist)\. Please also report any ideas
75for enhancements you may have for either package and/or documentation\.
76
77When proposing code changes, please provide *unified diffs*, i\.e the output of
78__diff \-u__\.
79
80Note further that *attachments* are strongly preferred over inlined patches\.
81Attachments can be made by going to the __Edit__ form of the ticket
82immediately after its creation, and then using the left\-most button in the
83secondary navigation bar\.
84
85# <a name='seealso'></a>SEE ALSO
86
87[bench](bench\.md), [bench::out::csv](bench\_wcsv\.md)
88
89# <a name='keywords'></a>KEYWORDS
90
91[benchmark](\.\./\.\./\.\./\.\./index\.md\#benchmark),
92[formatting](\.\./\.\./\.\./\.\./index\.md\#formatting), [human
93readable](\.\./\.\./\.\./\.\./index\.md\#human\_readable),
94[performance](\.\./\.\./\.\./\.\./index\.md\#performance),
95[testing](\.\./\.\./\.\./\.\./index\.md\#testing),
96[text](\.\./\.\./\.\./\.\./index\.md\#text)
97
98# <a name='category'></a>CATEGORY
99
100Benchmark tools
101
102# <a name='copyright'></a>COPYRIGHT
103
104Copyright &copy; 2007 Andreas Kupries <andreas\_kupries@users\.sourceforge\.net>
105