OLD | NEW |
| (Empty) |
1 .TH gendesc 1 "LCOV 1.9" 2010\-08\-06 "User Manuals" | |
2 .SH NAME | |
3 gendesc \- Generate a test case description file | |
4 .SH SYNOPSIS | |
5 .B gendesc | |
6 .RB [ \-h | \-\-help ] | |
7 .RB [ \-v | \-\-version ] | |
8 .RS 8 | |
9 .br | |
10 .RB [ \-o | \-\-output\-filename | |
11 .IR filename ] | |
12 .br | |
13 .I inputfile | |
14 .SH DESCRIPTION | |
15 Convert plain text test case descriptions into a format as understood by | |
16 .BR genhtml . | |
17 .I inputfile | |
18 needs to observe the following format: | |
19 | |
20 For each test case: | |
21 .IP " \-" | |
22 one line containing the test case name beginning at the start of the line | |
23 .RE | |
24 .IP " \-" | |
25 one or more lines containing the test case description indented with at | |
26 least one whitespace character (tab or space) | |
27 .RE | |
28 | |
29 .B Example input file: | |
30 | |
31 test01 | |
32 .RS | |
33 An example test case description. | |
34 .br | |
35 Description continued | |
36 .RE | |
37 | |
38 test42 | |
39 .RS | |
40 Supposedly the answer to most of your questions | |
41 .RE | |
42 | |
43 Note: valid test names can consist of letters, decimal digits and the | |
44 underscore character ('_'). | |
45 .SH OPTIONS | |
46 .B \-h | |
47 .br | |
48 .B \-\-help | |
49 .RS | |
50 Print a short help text, then exit. | |
51 .RE | |
52 | |
53 .B \-v | |
54 .br | |
55 .B \-\-version | |
56 .RS | |
57 Print version number, then exit. | |
58 .RE | |
59 | |
60 | |
61 .BI "\-o " filename | |
62 .br | |
63 .BI "\-\-output\-filename " filename | |
64 .RS | |
65 Write description data to | |
66 .IR filename . | |
67 | |
68 By default, output is written to STDOUT. | |
69 .RE | |
70 .SH AUTHOR | |
71 Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com> | |
72 | |
73 .SH SEE ALSO | |
74 .BR lcov (1), | |
75 .BR genhtml (1), | |
76 .BR geninfo (1), | |
77 .BR genpng (1), | |
78 .BR gcov (1) | |
OLD | NEW |