goprint is a command that prints the source code of a Go packages. The generated document is in HTML format, suitable for printing or converting to PDF.

The tool uses experimental CSS features for setting the page headers and footer that, at the present time, are not fully supported by browsers. However they are supported by Prince (http://www.princexml.com).

On the top left of the page is reported the package import path.

On the top right of the page is reported the file name.

On the bottom left of the page is reported the package's containing module. Currently only the module path is printed, without the version.

On the bottom right of the page is reported the page number.

Usage: goprint [flags] importpath
Flags:
  -font value
      font (default "Courier" 10pt/12pt)
  -m
      print all the packages in the module
  -page-margin value
      page margin (default 2.5cm 1cm)
  -page-size value
      page size (default A4 portrait)
  -test
      print _test.go source files

importpath is interpreted as in go list, however goprint only process the first package.

By default goprint will print all the .go source files, excluding the _test.go files.

Supported page sizes are A4 or letter. The page orientation is portrait and can not be changed.

The right, bottom and left margins can be omitted.

The font family, font size and line height must all be specified. The font family must be quoted, even if it contains no white space.

When the -test flag is set, goprint will print all the _test.go files, instead of the .go source files.

When the -m flag is set, goprint operates in module mode and importpath is interpreted as modulepath.

goprint will print the source files of all the packages belonging to the module named by the modulepath.

goprint main.go > build/pkg.html

goprint -font='"Inconsolata" 10pt/12pt' ./internal/css > build/pkg.html
prince -o build/pkg.pdf build/pkg.html

goprint requires at least Go 1.7. There are no external dependencies.