Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebastiancarlos/manpdf
Read your Man pages in PDF format. Even online!
https://github.com/sebastiancarlos/manpdf
bash cli command-line command-line-tool groff linux macos man man-page man-pages manpage manpages pdf pdf-generation shell
Last synced: about 7 hours ago
JSON representation
Read your Man pages in PDF format. Even online!
- Host: GitHub
- URL: https://github.com/sebastiancarlos/manpdf
- Owner: sebastiancarlos
- License: mit
- Created: 2023-04-06T13:03:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-19T23:04:40.000Z (7 months ago)
- Last Synced: 2024-04-20T15:55:24.114Z (7 months ago)
- Topics: bash, cli, command-line, command-line-tool, groff, linux, macos, man, man-page, man-pages, manpage, manpages, pdf, pdf-generation, shell
- Language: Shell
- Homepage: https://manpdf.pro
- Size: 105 KB
- Stars: 27
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 💪📄 ManPDF & ManWEB 💪🌎
Read your Man pages in PDF format. Even Online!
https://github.com/sebastiancarlos/manpdf/assets/88276600/0ca95ba0-54a8-4113-82f7-dfb58fb41cd9
## Installation
```shell
git clone https://github.com/sebastiancarlos/manpdf
cd manpdf
make
```
This will install the scripts `manpdf` and `manweb` in `/usr/local/bin`, which should be in your `$PATH`.
If you want to install in another location, like `$HOME/.local/bin`, run `make prefix=~/.local`.
## Uninstallation
Simply run `make uninstall`.
## Example
To view the man page for `ls` in PDF format, run:
```shell
manpdf ls
```
You can download a man page from the web. Fox example, to view the man page for `systemd` in the latest version of Arch, btw, run:
```shell
manweb systemd
````
This also supports PDF
```shell
manweb systemd --pdf
````
## Usage
```
ManWEB - Open a man page from Manned.org
manweb [OPTIONS] []
:
You can pass either the name of the man page, the url to a
manned.org page, or the URL to any raw man page in roff format
(hosted at manned.org or not)
-p, --pdf, --no-pdf:
if passed, the script will not open the man page on the terminal,
it will just open it as a pdf.
(off by default)
-w, --where, --no-where:
don't actually show the man page, but print the url of the matching
page, if found.
(off by default)
-d, --debug, --no-debug:
print debug information too.
(off by default)
-t, --try-local, --no-try-local:
if there's a local man page available, don't try to fetch from
network.
(on by default)
-o, --output:
the output file. if passed, the script will not open the man page,
it will just save it to disk in roff format. when combined with the
--pdf option, it will save the pdf to the provided filename.
(no default)
--pdf-viewer:
the command to open the pdf file.
(defaults to 'xdg-open' or 'open' if not provided)
(no default)
-h, --help:
prints this help.
```
```
ManPDF - Open a man page as a PDF file.
manpdf [OPTIONS] []
:
You can pass either the name of the man page, a man page file
(local or URL), or '-' to read file from stdin.
-o, --output:
The output file.
(defaults to temporary file)
--pdf-viewer:
The command to open the PDF file.
(defaults to 'xdg-open' or 'open' if not provided)
--open-pdf, --no-open-pdf:
Open the PDF file after creating it
(on by default)
-d, --debug, --no-debug:
Print debug information too.
(off by default)
-h, --help:
Prints this help.
-v, --version:
Prints version.
```
## Coming soon
- [ ] Customizable PDF fonts.
- [ ] Improve locale search (integration with `man-pages-l10n`)
- [ ] Post-processing to remove PDF artifacts caused by common roff file inaccuracies.
- [ ] Optionally inject `tldr` content to the top of the PDF file.
- [ ] Suggest Info page if the search term is GNU tool or similar.
- [ ] Web rendering from locally generated HTML file (including section navigation, symbol cross-references, roff tags on hover, and hyperlinks to other man pages which will also be locally generated)
- [ ] GUI. GTK and Mobile (native and Termux)
- [ ] Autocomplete (Online-powered too as opt-in)
- [ ] Interactive `fzf` integration.
- [ ] Experimental PDF to manpage converter (AI Powered)
- [ ] Smart relevance detection by cross-referencing other data besides manned.org
- [ ] Improved search results experience for multiple matches or similar results.
- [ ] Social feature, voting for man page of the day.
- [ ] Buy Adobe. The company, not the software.
- [ ] Improve support for non-standard man page section names.
## Requirements
ManPDF and ManWEB should work everywhere. The only requirements (which should already be installed in your system anyway) are:
- A `man` implementation (`man-db`, `mandoc`, or even that old non-GPL implementation on macOS),
- `groff`,
- `curl`,
- `gzip`, to handle distros that compress man pages by default, and
- `open` or `xdg-open` associated with an application that can open PDFs. (Optional: you can also pass your preferred PDF viewer)
## Thanks to
- [Argbash](https://argbash.io/) for generating the CLI parser.
- [Groff](https://www.gnu.org/software/groff/) for generating the PDF.
- [Manned.org](https://manned.org/) for the best online man pages.
## Related repositories
- [manpdf-web](https://github.com/sebastiancarlos/manpdf-web): The [website](https://manpdf.pro) for ManPDF.
## License
MIT