| .TH gendesc 1 "LCOV 1.10" 2012\-10\-10 "User Manuals" |
| .SH NAME |
| gendesc \- Generate a test case description file |
| .SH SYNOPSIS |
| .B gendesc |
| .RB [ \-h | \-\-help ] |
| .RB [ \-v | \-\-version ] |
| .RS 8 |
| .br |
| .RB [ \-o | \-\-output\-filename |
| .IR filename ] |
| .br |
| .I inputfile |
| .SH DESCRIPTION |
| Convert plain text test case descriptions into a format as understood by |
| .BR genhtml . |
| .I inputfile |
| needs to observe the following format: |
| |
| For each test case: |
| .IP " \-" |
| one line containing the test case name beginning at the start of the line |
| .RE |
| .IP " \-" |
| one or more lines containing the test case description indented with at |
| least one whitespace character (tab or space) |
| .RE |
| |
| .B Example input file: |
| |
| test01 |
| .RS |
| An example test case description. |
| .br |
| Description continued |
| .RE |
| |
| test42 |
| .RS |
| Supposedly the answer to most of your questions |
| .RE |
| |
| Note: valid test names can consist of letters, decimal digits and the |
| underscore character ('_'). |
| .SH OPTIONS |
| .B \-h |
| .br |
| .B \-\-help |
| .RS |
| Print a short help text, then exit. |
| .RE |
| |
| .B \-v |
| .br |
| .B \-\-version |
| .RS |
| Print version number, then exit. |
| .RE |
| |
| |
| .BI "\-o " filename |
| .br |
| .BI "\-\-output\-filename " filename |
| .RS |
| Write description data to |
| .IR filename . |
| |
| By default, output is written to STDOUT. |
| .RE |
| .SH AUTHOR |
| Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com> |
| |
| .SH SEE ALSO |
| .BR lcov (1), |
| .BR genhtml (1), |
| .BR geninfo (1), |
| .BR genpng (1), |
| .BR gcov (1) |
