{"id":20302659,"url":"https://github.com/sebastiancarlos/manpdf","last_synced_at":"2025-10-30T03:40:58.496Z","repository":{"id":154492868,"uuid":"624431702","full_name":"sebastiancarlos/manpdf","owner":"sebastiancarlos","description":"Read your Man pages in PDF format. Even online!","archived":false,"fork":false,"pushed_at":"2024-04-19T23:04:40.000Z","size":108,"stargazers_count":32,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-25T10:01:59.730Z","etag":null,"topics":["bash","cli","command-line","command-line-tool","groff","linux","macos","man","man-page","man-pages","manpage","manpages","pdf","pdf-generation","shell"],"latest_commit_sha":null,"homepage":"https://manpdf.pro","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sebastiancarlos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-06T13:03:21.000Z","updated_at":"2024-11-13T19:34:29.000Z","dependencies_parsed_at":"2024-01-07T21:02:11.914Z","dependency_job_id":"7fb7419a-45ae-4b9c-a515-49e1451e8c46","html_url":"https://github.com/sebastiancarlos/manpdf","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastiancarlos%2Fmanpdf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastiancarlos%2Fmanpdf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastiancarlos%2Fmanpdf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastiancarlos%2Fmanpdf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sebastiancarlos","download_url":"https://codeload.github.com/sebastiancarlos/manpdf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248410879,"owners_count":21098789,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","cli","command-line","command-line-tool","groff","linux","macos","man","man-page","man-pages","manpage","manpages","pdf","pdf-generation","shell"],"created_at":"2024-11-14T16:33:27.912Z","updated_at":"2025-10-30T03:40:53.466Z","avatar_url":"https://github.com/sebastiancarlos.png","language":"Shell","funding_links":[],"categories":["\u003ca name=\"cheatsheet\"\u003e\u003c/a\u003eCommands cheatsheet and snippets"],"sub_categories":[],"readme":"# 💪📄 ManPDF \u0026 ManWEB 💪🌎\n\n![man-pdf](https://user-images.githubusercontent.com/88276600/230772238-78562f6a-d0ea-4b91-88b1-0b5c52fb7adf.png)\n\nRead your Man pages in PDF format. Even Online!\n\nhttps://github.com/sebastiancarlos/manpdf/assets/88276600/0ca95ba0-54a8-4113-82f7-dfb58fb41cd9\n\n## Installation\n\n```shell\ngit clone https://github.com/sebastiancarlos/manpdf\ncd manpdf\nmake\n```\n\nThis will install the scripts `manpdf` and `manweb` in `/usr/local/bin`, which should be in your `$PATH`.\n\nIf you want to install in another location, like `$HOME/.local/bin`, run `make prefix=~/.local`. \n\n## Uninstallation\n\nSimply run `make uninstall`.\n\n## Example\n\nTo view the man page for `ls` in PDF format, run:\n\n```shell\nmanpdf ls\n```\n\nYou 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:\n\n```shell\nmanweb systemd\n````\n\nThis also supports PDF\n\n```shell\nmanweb systemd --pdf\n````\n\n## Usage\n\n```\nManWEB - Open a man page from Manned.org\n\nmanweb [OPTIONS] \u003cname-or-url\u003e [\u003csection\u003e]\n\t\u003cname-or-url\u003e:\n\t\tYou can pass either the name of the man page, the url to a\n\t\tmanned.org page, or the URL to any raw man page in roff format\n\t\t(hosted at manned.org or not)\n\t-p, --pdf, --no-pdf:\n\t\tif passed, the script will not open the man page on the terminal,\n\t\tit will just open it as a pdf.\n\t\t(off by default)\n\t-w, --where, --no-where:\n\t\tdon't actually show the man page, but print the url of the matching\n\t\tpage, if found.\n\t\t(off by default)\n\t-d, --debug, --no-debug:\n\t\tprint debug information too.\n\t\t(off by default)\n\t-t, --try-local, --no-try-local:\n\t\tif there's a local man page available, don't try to fetch from\n\t\tnetwork.\n\t\t(on by default)\n\t-o, --output:\n\t\tthe output file. if passed, the script will not open the man page,\n\t\tit will just save it to disk in roff format. when combined with the\n\t\t--pdf option, it will save the pdf to the provided filename.\n\t\t(no default)\n\t--pdf-viewer:\n\t\tthe command to open the pdf file.\n\t\t(defaults to 'xdg-open' or 'open' if not provided)\n\t\t(no default)\n\t-h, --help:\n\t\tprints this help.\n```\n\n```\nManPDF - Open a man page as a PDF file.\n\nmanpdf [OPTIONS] \u003cname-or-file\u003e [\u003csection\u003e]\n\t\u003cname-or-file\u003e:\n\t\tYou can pass either the name of the man page, a man page file\n\t\t(local or URL), or '-' to read file from stdin.\n\t-o, --output:\n\t\tThe output file.\n\t\t(defaults to temporary file)\n\t--pdf-viewer:\n\t\tThe command to open the PDF file.\n\t\t(defaults to 'xdg-open' or 'open' if not provided)\n\t--open-pdf, --no-open-pdf:\n\t\tOpen the PDF file after creating it\n\t\t(on by default)\n\t-d, --debug, --no-debug:\n\t\tPrint debug information too.\n\t\t(off by default)\n\t-h, --help:\n\t\tPrints this help.\n\t-v, --version:\n\t\tPrints version.\n```\n\n## Coming soon\n- [ ] Customizable PDF fonts.\n- [ ] Improve locale search (integration with `man-pages-l10n`)\n- [ ] Post-processing to remove PDF artifacts caused by common roff file inaccuracies.\n- [ ] Optionally inject `tldr` content to the top of the PDF file.\n- [ ] Suggest Info page if the search term is GNU tool or similar.\n- [ ] 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)\n- [ ] GUI. GTK and Mobile (native and Termux)\n- [ ] Autocomplete (Online-powered too as opt-in)\n- [ ] Interactive `fzf` integration.\n- [ ] Experimental PDF to manpage converter (AI Powered)\n- [ ] Smart relevance detection by cross-referencing other data besides manned.org\n- [ ] Improved search results experience for multiple matches or similar results.\n- [ ] Social feature, voting for man page of the day.\n- [ ] Buy Adobe. The company, not the software.\n- [ ] Improve support for non-standard man page section names.\n\n## Requirements\n\nManPDF and ManWEB should work everywhere. The only requirements (which should already be installed in your system anyway) are:\n - A `man` implementation (`man-db`, `mandoc`, or even that old non-GPL implementation on macOS),\n - `groff`, \n - `curl`,\n - `gzip`, to handle distros that compress man pages by default, and\n - `open` or `xdg-open` associated with an application that can open PDFs. (Optional: you can also pass your preferred PDF viewer)\n\n## Thanks to\n- [Argbash](https://argbash.io/) for generating the CLI parser.\n- [Groff](https://www.gnu.org/software/groff/) for generating the PDF.\n- [Manned.org](https://manned.org/) for the best online man pages.\n\n## Related repositories\n- [manpdf-web](https://github.com/sebastiancarlos/manpdf-web): The [website](https://manpdf.pro) for ManPDF.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsebastiancarlos%2Fmanpdf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsebastiancarlos%2Fmanpdf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsebastiancarlos%2Fmanpdf/lists"}