man2pdf
v2.0.0
Published
Convert manpages to PDF
Downloads
1
Readme
man2pdf
Convert manpages to PDF.
NPM package
Install
npm install man2pdf
Usage
See the examples/js_ts
directory for usage.
There are three files:
- JavaScript version (CommonJS):
man.js
- JavaScript version (ESModule):
man.mjs
- TypeScript version:
man.ts
Bash script
The bash script is the src/bash/man2pdf.sh
file, for which the NPM script depends on.
Install to PATH
You can add man2pdf
to one of your PATH
directories to make it directly invocable from the command line.
The repository's Makefile
also provides you convenient operations:
make install
/make uninstall
: Install theman2pdf
script for the current user.- The
man2pdf
script will be placed in the/home/$USER/bin
directory.- Please ensure that the directory
/home/$USER/bin
exists (if not, you need to manually create it first), and is included in thePATH
environment variable.
- Please ensure that the directory
- Auxiliary scripts will be placed in the
/home/$USER/.local/share/man2pdf
directory.
- The
sudo make install
/sudo make uninstall
: Install theman2pdf
script for all users.- The
man2pdf
script will be placed in the/usr/local/bin
directory. - Auxiliary scripts will be placed in the
/usr/local/share/man2pdf
directory.
- The
Usage
man2pdf <manpage> [/path/to/out_file.pdf]
- The
<manpage>
is the name (or possibly the name and the section number, separated by a space character) of the manpage. It takes one of these forms:<manpage_name>
(The section is resolved automatically)"<section> <manpage_name>"
(with a space in-between, so must surrounded by quotation marks)
- The
[/path/to/out_file.pdf]
argument is optional.- If omitted, it will be resolved to the format
<manpage_name>(<section>).pdf
, and saved under the current working directory. - If it is specified as an existing directory, the filename will also be resolved to the format
<manpage_name>(<section>).pdf
, and saved under that directory.
- If omitted, it will be resolved to the format