NAME

rakudoc2man - Convert Rakudoc files to formatted *roff input

SYNOPSIS

rakudoc2man [--name=<name>] [--section=<section>] [<input>] [<output>]
  rakudoc2man --help

DESCRIPTION

rakudoc2man is a front-end for Pod::To::Man, using it to generate *roff input from Rakudoc source. The resulting *roff code is suitable for displaying on a terminal using man(1). rakudoc2man is meant to be a more robust alternative to using Pod::To::Man with Raku's --doc renderer.

input is the file to read for Rakudoc source. If input is not given, it defaults to STDIN. The Rakudoc source should consist solely of Rakudoc data, it should not be embedded with normal Raku code (this is unfortunately a limitation with Pod::Load). If you wish to supply Rakudoc data embedded in normal Raku code, you will have to process it through some sort of Rakudoc extractor.

output is the file to output the *roff to. It defaults to STDOUT if not otherwise specified.

OPTIONS

• --name=name

  Specify the name to be used by the generated *roff's heading. By default, Pod::To::Man will try to intelligently determine the *roff name by scanning the Rakudoc source for =head1 NAME or =NAME text data and extracting it from that. Otherwise, it will default to rakudoc2man, which will almost certainly not be what you want.

• --section=section

  Specify the section to be used by the generated *roff's heading. Will be 1 by default.

• --help

  Print the rakudoc2man usage message and exit.

AUTHOR

rakudoc2man was written by Samuel Young <[email protected]>. Pod::To::Man was originally written by Mike Clarke <[email protected]>, with notable contributions by Vadim Belman <[email protected]> and Samuel Young.

Some of this documentation was shamelessly copied from the pod2man manual page for Perl.

SEE ALSO

Pod::Load, Pod::To::Man, man(1), nroff(1), pod2man(1), man(7)