src/third_party/lcov/man/genpng.1

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