OLD | NEW |
1 .TH genhtml 1 "LCOV 1.7" 2008\-11\-17 "User Manuals" | 1 .TH genhtml 1 "LCOV 1.10" 2012\-10\-10 "User Manuals" |
2 .SH NAME | 2 .SH NAME |
3 genhtml \- Generate HTML view from LCOV coverage data files | 3 genhtml \- Generate HTML view from LCOV coverage data files |
4 .SH SYNOPSIS | 4 .SH SYNOPSIS |
5 .B genhtml | 5 .B genhtml |
6 .RB [ \-h | \-\-help ] | 6 .RB [ \-h | \-\-help ] |
7 .RB [ \-v | \-\-version ] | 7 .RB [ \-v | \-\-version ] |
8 .RS 8 | 8 .RS 8 |
9 .br | 9 .br |
10 .RB [ \-q | \-\-quiet ] | 10 .RB [ \-q | \-\-quiet ] |
11 .RB [ \-s | \-\-show\-details ] | 11 .RB [ \-s | \-\-show\-details ] |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
45 .RB [ \-\-html\-extension | 45 .RB [ \-\-html\-extension |
46 .IR extension ] | 46 .IR extension ] |
47 .br | 47 .br |
48 .RB [ \-\-html\-gzip ] | 48 .RB [ \-\-html\-gzip ] |
49 .RB [ \-\-sort ] | 49 .RB [ \-\-sort ] |
50 .RB [ \-\-no\-sort ] | 50 .RB [ \-\-no\-sort ] |
51 .br | 51 .br |
52 .RB [ \-\-function\-coverage ] | 52 .RB [ \-\-function\-coverage ] |
53 .RB [ \-\-no\-function\-coverage ] | 53 .RB [ \-\-no\-function\-coverage ] |
54 .br | 54 .br |
| 55 .RB [ \-\-branch\-coverage ] |
| 56 .RB [ \-\-no\-branch\-coverage ] |
| 57 .br |
| 58 .RB [ \-\-demangle\-cpp ] |
| 59 .RB [ \-\-ignore\-errors |
| 60 .IR errors ] |
| 61 .br |
| 62 .RB [ \-\-config\-file |
| 63 .IR config\-file ] |
| 64 .RB [ \-\-rc |
| 65 .IR keyword = value ] |
| 66 .br |
55 .IR tracefile(s) | 67 .IR tracefile(s) |
56 .RE | 68 .RE |
57 .SH DESCRIPTION | 69 .SH DESCRIPTION |
58 Create an HTML view of coverage data found in | 70 Create an HTML view of coverage data found in |
59 .IR tracefile . | 71 .IR tracefile . |
60 Note that | 72 Note that |
61 .I tracefile | 73 .I tracefile |
62 may also be a list of filenames. | 74 may also be a list of filenames. |
63 | 75 |
64 HTML output files are created in the current working directory unless the | 76 HTML output files are created in the current working directory unless the |
65 \-\-output\-directory option is used. If | 77 \-\-output\-directory option is used. If |
66 .I tracefile | 78 .I tracefile |
67 ends with ".gz", it is assumed to be GZIP\-compressed and the gunzip tool | 79 ends with ".gz", it is assumed to be GZIP\-compressed and the gunzip tool |
68 will be used to decompress it transparently. | 80 will be used to decompress it transparently. |
69 | 81 |
70 Note that all source code files have to be present and readable at the | 82 Note that all source code files have to be present and readable at the |
71 exact file system location they were compiled. | 83 exact file system location they were compiled. |
72 | 84 |
73 Use option | 85 Use option |
74 .I \--css\-file | 86 .I \--css\-file |
75 to modify layout and colors of the generated HTML output. Files are | 87 to modify layout and colors of the generated HTML output. Files are |
76 marked in different colors depending on the associated coverage rate. By | 88 marked in different colors depending on the associated coverage rate. By |
77 default, the coverage limits for low, medium and high coverage are set to | 89 default, the coverage limits for low, medium and high coverage are set to |
78 0\-15%, 15\-50% and 50\-100% percent respectively. To change these | 90 0\-75%, 75\-90% and 90\-100% percent respectively. To change these |
79 values, use configuration file options | 91 values, use configuration file options |
80 .IR genhtml_hi_limit " and " genhtml_med_limit . | 92 .IR genhtml_hi_limit " and " genhtml_med_limit . |
81 | 93 |
| 94 Also note that when displaying percentages, 0% and 100% are only printed when |
| 95 the values are exactly 0% and 100% respectively. Other values which would |
| 96 conventionally be rounded to 0% or 100% are instead printed as nearest |
| 97 non-boundary value. This behavior is in accordance with that of the |
| 98 .BR gcov (1) |
| 99 tool. |
| 100 |
82 .SH OPTIONS | 101 .SH OPTIONS |
83 .B \-h | 102 .B \-h |
84 .br | 103 .br |
85 .B \-\-help | 104 .B \-\-help |
86 .RS | 105 .RS |
87 Print a short help text, then exit. | 106 Print a short help text, then exit. |
88 | 107 |
89 .RE | 108 .RE |
90 .B \-v | 109 .B \-v |
91 .br | 110 .br |
(...skipping 14 matching lines...) Expand all Loading... |
106 .RE | 125 .RE |
107 .B \-f | 126 .B \-f |
108 .br | 127 .br |
109 .B \-\-frames | 128 .B \-\-frames |
110 .RS | 129 .RS |
111 Use HTML frames for source code view. | 130 Use HTML frames for source code view. |
112 | 131 |
113 If enabled, a frameset is created for each source code file, providing | 132 If enabled, a frameset is created for each source code file, providing |
114 an overview of the source code as a "clickable" image. Note that this | 133 an overview of the source code as a "clickable" image. Note that this |
115 option will slow down output creation noticeably because each source | 134 option will slow down output creation noticeably because each source |
116 code character has to be inspected once. Note also that the GD.pm PERL | 135 code character has to be inspected once. Note also that the GD.pm Perl |
117 module has to be installed for this option to work (it may be obtained | 136 module has to be installed for this option to work (it may be obtained |
118 from http://www.cpan.org). | 137 from http://www.cpan.org). |
119 | 138 |
120 .RE | 139 .RE |
121 .B \-s | 140 .B \-s |
122 .br | 141 .br |
123 .B \-\-show\-details | 142 .B \-\-show\-details |
124 .RS | 143 .RS |
125 Generate detailed directory view. | 144 Generate detailed directory view. |
126 | 145 |
(...skipping 235 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
362 .br | 381 .br |
363 A relative path leading to the base directory (e.g. for locating css\-files). | 382 A relative path leading to the base directory (e.g. for locating css\-files). |
364 | 383 |
365 This option can also be configured permanently using the configuration file | 384 This option can also be configured permanently using the configuration file |
366 option | 385 option |
367 .IR genhtml_html_epilog . | 386 .IR genhtml_html_epilog . |
368 | 387 |
369 .RE | 388 .RE |
370 .BI "\-\-html\-extension " extension | 389 .BI "\-\-html\-extension " extension |
371 .RS | 390 .RS |
372 | |
373 Use customized filename extension for generated HTML pages. | 391 Use customized filename extension for generated HTML pages. |
374 | 392 |
375 This option is useful in situations where different filename extensions | 393 This option is useful in situations where different filename extensions |
376 are required to render the resulting pages correctly (e.g. php). Note that | 394 are required to render the resulting pages correctly (e.g. php). Note that |
377 a '.' will be inserted between the filename and the extension specified by | 395 a '.' will be inserted between the filename and the extension specified by |
378 this option. | 396 this option. |
379 | 397 |
380 This option can also be configured permanently using the configuration file | 398 This option can also be configured permanently using the configuration file |
381 option | 399 option |
382 .IR genhtml_html_extension . | 400 .IR genhtml_html_extension . |
383 .RE | 401 .RE |
384 | 402 |
385 .B \-\-html\-gzip | 403 .B \-\-html\-gzip |
386 .RS | 404 .RS |
387 | |
388 Compress all generated html files with gzip and add a .htaccess file specifying | 405 Compress all generated html files with gzip and add a .htaccess file specifying |
389 gzip\-encoding in the root output directory. | 406 gzip\-encoding in the root output directory. |
390 | 407 |
391 Use this option if you want to save space on your webserver. Requires a | 408 Use this option if you want to save space on your webserver. Requires a |
392 webserver with .htaccess support and a browser with support for gzip | 409 webserver with .htaccess support and a browser with support for gzip |
393 compressed html. | 410 compressed html. |
394 | 411 |
395 This option can also be configured permanently using the configuration file | 412 This option can also be configured permanently using the configuration file |
396 option | 413 option |
397 .IR genhtml_html_gzip . | 414 .IR genhtml_html_gzip . |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
431 the number of functions found and hit per file or directory, together with | 448 the number of functions found and hit per file or directory, together with |
432 the resulting coverage rate. In addition, each source code view will contain | 449 the resulting coverage rate. In addition, each source code view will contain |
433 a link to a page which lists all functions found in that file plus the | 450 a link to a page which lists all functions found in that file plus the |
434 respective call count for those functions. | 451 respective call count for those functions. |
435 | 452 |
436 This option can also be configured permanently using the configuration file | 453 This option can also be configured permanently using the configuration file |
437 option | 454 option |
438 .IR genhtml_function_coverage . | 455 .IR genhtml_function_coverage . |
439 | 456 |
440 .RE | 457 .RE |
| 458 .B \-\-branch\-coverage |
| 459 .br |
| 460 .B \-\-no\-branch\-coverage |
| 461 .RS |
| 462 Specify whether to display branch coverage data in HTML output. |
| 463 |
| 464 Use \-\-branch\-coverage to enable branch coverage display or |
| 465 \-\-no\-branch\-coverage to disable it. Branch coverage data display is |
| 466 .B enabled |
| 467 by default |
| 468 |
| 469 When branch coverage display is enabled, each overview page will contain |
| 470 the number of branches found and hit per file or directory, together with |
| 471 the resulting coverage rate. In addition, each source code view will contain |
| 472 an extra column which lists all branches of a line with indications of |
| 473 whether the branch was taken or not. Branches are shown in the following format: |
| 474 |
| 475 ' + ': Branch was taken at least once |
| 476 .br |
| 477 ' - ': Branch was not taken |
| 478 .br |
| 479 ' # ': The basic block containing the branch was never executed |
| 480 .br |
| 481 |
| 482 Note that it might not always be possible to relate branches to the |
| 483 corresponding source code statements: during compilation, GCC might shuffle |
| 484 branches around or eliminate some of them to generate better code. |
| 485 |
| 486 This option can also be configured permanently using the configuration file |
| 487 option |
| 488 .IR genhtml_branch_coverage . |
| 489 |
| 490 .RE |
| 491 .B \-\-demangle\-cpp |
| 492 .RS |
| 493 Specify whether to demangle C++ function names. |
| 494 |
| 495 Use this option if you want to convert C++ internal function names to |
| 496 human readable format for display on the HTML function overview page. |
| 497 This option requires that the c++filt tool is installed (see |
| 498 .BR c++filt (1)). |
| 499 |
| 500 .RE |
| 501 .B \-\-ignore\-errors |
| 502 .I errors |
| 503 .br |
| 504 .RS |
| 505 Specify a list of errors after which to continue processing. |
| 506 |
| 507 Use this option to specify a list of one or more classes of errors after which |
| 508 geninfo should continue processing instead of aborting. |
| 509 |
| 510 .I errors |
| 511 can be a comma\-separated list of the following keywords: |
| 512 |
| 513 .B source: |
| 514 the source code file for a data set could not be found. |
| 515 .RE |
| 516 |
| 517 .B \-\-config\-file |
| 518 .I config\-file |
| 519 .br |
| 520 .RS |
| 521 Specify a configuration file to use. |
| 522 |
| 523 When this option is specified, neither the system\-wide configuration file |
| 524 /etc/lcovrc, nor the per\-user configuration file ~/.lcovrc is read. |
| 525 |
| 526 This option may be useful when there is a need to run several |
| 527 instances of |
| 528 .B genhtml |
| 529 with different configuration file options in parallel. |
| 530 .RE |
| 531 |
| 532 .B \-\-rc |
| 533 .IR keyword = value |
| 534 .br |
| 535 .RS |
| 536 Override a configuration directive. |
| 537 |
| 538 Use this option to specify a |
| 539 .IR keyword = value |
| 540 statement which overrides the corresponding configuration statement in |
| 541 the lcovrc configuration file. You can specify this option more than once |
| 542 to override multiple configuration statements. |
| 543 See |
| 544 .BR lcovrc (5) |
| 545 for a list of available keywords and their meaning. |
| 546 .RE |
| 547 |
441 .SH FILES | 548 .SH FILES |
442 | 549 |
443 .I /etc/lcovrc | 550 .I /etc/lcovrc |
444 .RS | 551 .RS |
445 The system\-wide configuration file. | 552 The system\-wide configuration file. |
446 .RE | 553 .RE |
447 | 554 |
448 .I ~/.lcovrc | 555 .I ~/.lcovrc |
449 .RS | 556 .RS |
450 The per\-user configuration file. | 557 The per\-user configuration file. |
451 .RE | 558 .RE |
452 | 559 |
453 .SH AUTHOR | 560 .SH AUTHOR |
454 Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com> | 561 Peter Oberparleiter <Peter.Oberparleiter@de.ibm.com> |
455 | 562 |
456 .SH SEE ALSO | 563 .SH SEE ALSO |
457 .BR lcov (1), | 564 .BR lcov (1), |
| 565 .BR lcovrc (5), |
458 .BR geninfo (1), | 566 .BR geninfo (1), |
459 .BR genpng (1), | 567 .BR genpng (1), |
460 .BR gendesc (1), | 568 .BR gendesc (1), |
461 .BR gcov (1) | 569 .BR gcov (1) |
OLD | NEW |