| 1 |
\" Define project URL |
| 2 |
.ds lcovurl https://github.com/linux\-test\-project/lcov |
| 3 |
|
| 4 |
.TH genpng 1 "LCOV 2.0" 2023\-05\-12 "User Manuals" |
| 5 |
.SH NAME |
| 6 |
genpng \- Generate an overview image from a source file |
| 7 |
.SH SYNOPSIS |
| 8 |
.B genpng |
| 9 |
.RB [ \-h | \-\-help ] |
| 10 |
.RB [ \-v | \-\-version ] |
| 11 |
.RS 7 |
| 12 |
.br |
| 13 |
.RB [ \-t | \-\-tab\-size |
| 14 |
.IR tabsize ] |
| 15 |
.RB [ \-w | \-\-width |
| 16 |
.IR width ] |
| 17 |
.RB [ \-d | \-\-dark\-mode ] |
| 18 |
.br |
| 19 |
.RB [ \-o | \-\-output\-filename |
| 20 |
.IR output\-filename ] |
| 21 |
.br |
| 22 |
.IR source\-file |
| 23 |
.SH DESCRIPTION |
| 24 |
.B genpng |
| 25 |
creates an overview image for a given source code file of either |
| 26 |
plain text or .gcov file format. |
| 27 |
|
| 28 |
Note that the |
| 29 |
.I GD.pm |
| 30 |
Perl module has to be installed for this script to work |
| 31 |
(it may be obtained from |
| 32 |
.IR http://www.cpan.org ). |
| 33 |
|
| 34 |
Note also that |
| 35 |
.B genpng |
| 36 |
is called from within |
| 37 |
.B genhtml |
| 38 |
so that there is usually no need to call it directly. |
| 39 |
|
| 40 |
.SH OPTIONS |
| 41 |
.B \-h |
| 42 |
.br |
| 43 |
.B \-\-help |
| 44 |
.RS |
| 45 |
Print a short help text, then exit. |
| 46 |
.RE |
| 47 |
|
| 48 |
.B \-v |
| 49 |
.br |
| 50 |
.B \-\-version |
| 51 |
.RS |
| 52 |
Print version number, then exit. |
| 53 |
.RE |
| 54 |
|
| 55 |
.BI "\-t " tab\-size |
| 56 |
.br |
| 57 |
.BI "\-\-tab\-size " tab\-size |
| 58 |
.RS |
| 59 |
Use |
| 60 |
.I tab\-size |
| 61 |
spaces in place of tab. |
| 62 |
|
| 63 |
All occurrences of tabulator signs in the source code file will be replaced |
| 64 |
by the number of spaces defined by |
| 65 |
.I tab\-size |
| 66 |
(default is 4). |
| 67 |
.RE |
| 68 |
|
| 69 |
.BI "\-w " width |
| 70 |
.br |
| 71 |
.BI "\-\-width " width |
| 72 |
.RS |
| 73 |
Set width of output image to |
| 74 |
.I width |
| 75 |
pixel. |
| 76 |
|
| 77 |
The resulting image will be exactly |
| 78 |
.I width |
| 79 |
pixel wide (default is 80). |
| 80 |
|
| 81 |
Note that source code lines which are longer than |
| 82 |
.I width |
| 83 |
will be truncated. |
| 84 |
.RE |
| 85 |
|
| 86 |
.B \-d |
| 87 |
.br |
| 88 |
.B \-\-dark\-mode |
| 89 |
.RS |
| 90 |
Use a light-display-on-dark-background color scheme rather than the default dark-display-on-light-background. |
| 91 |
.RE |
| 92 |
|
| 93 |
.BI "\-o " filename |
| 94 |
.br |
| 95 |
.BI "\-\-output\-filename " filename |
| 96 |
.RS |
| 97 |
Write image to |
| 98 |
.IR filename . |
| 99 |
|
| 100 |
Specify a name for the resulting image file (default is |
| 101 |
.IR source\-file .png). |
| 102 |
.RE |
| 103 |
.SH AUTHOR |
| 104 |
Peter Oberparleiter <[email protected]> |
| 105 |
|
| 106 |
.SH SEE ALSO |
| 107 |
.BR lcov (1), |
| 108 |
.BR genhtml (1), |
| 109 |
.BR geninfo (1), |
| 110 |
.BR gendesc (1), |
| 111 |
.BR gcov (1) |
| 112 |
.br |
| 113 |
|
| 114 |
.I \*[lcovurl] |
| 115 |
.br |