Linux command
pod2man 命令
文件
涉及管道、覆盖或删除，执行前请先确认路径和参数。
常用示例
Convert POD to man page
pod2man [file.pod] > [file.1]
Specify section
pod2man --section=[1] [file.pod] > [file.1]
Set name and release
pod2man --name="[NAME]" --release="[1.0]" [file.pod] > [file.1]
说明
pod2man is a front-end for Pod::Man, converting Perl POD (Plain Old Documentation) into Unix manual page format (*roff). The output can be displayed with nroff via man, or printed with troff. If no input file is given, it reads from STDIN. If no output file is given, it writes to STDOUT. The default center header is "User Contributed Perl Documentation". Part of the standard Perl distribution, commonly used in module build systems.
参数
- --section _N_
- Man page section.
- --name _NAME_
- Man page name.
- --release _VERSION_
- Release version string.
- --center _TEXT_
- Center header text.
- --date _DATE_
- Date for left-hand footer (default: input file modification date).
- --utf8
- Assume UTF-8 encoding for input.
- --stderr
- Print errors to stderr.
- --fixed _FONT_
- Fixed-width font for verbatim text.
FAQ
What is the pod2man command used for?
pod2man is a front-end for Pod::Man, converting Perl POD (Plain Old Documentation) into Unix manual page format (*roff). The output can be displayed with nroff via man, or printed with troff. If no input file is given, it reads from STDIN. If no output file is given, it writes to STDOUT. The default center header is "User Contributed Perl Documentation". Part of the standard Perl distribution, commonly used in module build systems.
How do I run a basic pod2man example?
Run `pod2man [file.pod] > [file.1]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does --section _N_ do in pod2man?
Man page section.