{"id":29091514,"url":"https://github.com/antiz96/zaman","last_synced_at":"2025-06-28T06:07:23.568Z","repository":{"id":54406148,"uuid":"522269649","full_name":"Antiz96/zaman","owner":"Antiz96","description":"A simple CLI tool to display (or save) man pages as PDFs.","archived":false,"fork":false,"pushed_at":"2025-03-18T10:20:23.000Z","size":135,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-23T00:12:28.531Z","etag":null,"topics":["cli","dmenu","man","manpage","manpages","manual","page","pages","pdf","rofi","tool","tools","zaman","zathura"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Antiz96.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"github":"Antiz96"}},"created_at":"2022-08-07T16:47:39.000Z","updated_at":"2025-03-18T10:20:26.000Z","dependencies_parsed_at":"2023-12-12T20:24:56.053Z","dependency_job_id":"4b836da2-e203-419a-af26-18a82d5a5171","html_url":"https://github.com/Antiz96/zaman","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/Antiz96/zaman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Antiz96%2Fzaman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Antiz96%2Fzaman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Antiz96%2Fzaman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Antiz96%2Fzaman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Antiz96","download_url":"https://codeload.github.com/Antiz96/zaman/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Antiz96%2Fzaman/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262382744,"owners_count":23302298,"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":["cli","dmenu","man","manpage","manpages","manual","page","pages","pdf","rofi","tool","tools","zaman","zathura"],"created_at":"2025-06-28T06:07:13.925Z","updated_at":"2025-06-28T06:07:23.541Z","avatar_url":"https://github.com/Antiz96.png","language":"Shell","funding_links":["https://github.com/sponsors/Antiz96"],"categories":[],"sub_categories":[],"readme":"# Zaman\n\n## Table of contents\n\n- [Description](#description)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Description\n\nA simple CLI tool to display (or save) man pages as PDFs files for an easier reading.  \nZaman first looks for the default PDF reader defined in [XDG MIME Applications](https://wiki.archlinux.org/title/XDG_MIME_Applications) and fallback to [Zathura](https://pwmt.org/projects/zathura/) if no default PDF reader is set.  \nIt also allows to navigate through all the man pages available on the system through a dynamic menu via [Rofi](https://davatorium.github.io/rofi/) or [Dmenu](https://tools.suckless.org/dmenu/).\n\n## Installation\n\n### AUR\n\nInstall the [zaman](https://aur.archlinux.org/packages/zaman) AUR package (also check the list of optional dependencies for anything you may want or need).  \n\n### From Source\n\nInstall dependencies:\n\n- Replace `zathura-pdf-poppler` by `zathura-pdf-mupdf` if you prefer to use the `mupdf` backend.\n- Replace `rofi` by `dmenu` if you prefer to use that (provided by the `suckless-tools` package on Debian / Ubuntu).\n- The second line are build dependencies (not required to run `zaman` once it is installed).\n\n#### Debian / Ubuntu\n\n```bash\nsudo apt install man-db groff xdg-utils zathura zathura-pdf-poppler rofi\nsudo apt install make bats scdoc\n```\n\n#### Fedora\n\n```bash\nsudo dnf install man-db groff groff-perl \"perl(Compress::Zlib)\" xdg-utils zathura zathura-pdf-poppler rofi\nsudo dnf install make bats scdoc\n```\n\n#### Arch Linux\n\n```bash\nsudo pacman -S man-db groff xdg-utils zathura zathura-pdf-poppler rofi\nsudo pacman -S --asdeps make bats scdoc\n```\n\n#### Alpine Linux\n\n```bash\nsudo apk add man-db groff xdg-utils zathura zathura-pdf-poppler rofi\nsudo apk add make bats scdoc\n```\n\n#### Gentoo\n\n```bash\nsudo emerge man-db groff xdg-utils zathura zathura-pdf-poppler rofi\nsudo emerge make bats scdoc\n```\n\nDownload the archive of the [latest stable release](https://github.com/Antiz96/zaman/releases/latest) and extract it (alternatively, you can clone this repository with `git`).\n\nTo install `zaman`, go into the extracted/cloned directory and run the following command:\n\n```bash\nsudo make\nsudo make test\nsudo make install\n```\n\nOnce the installation is complete, you may optionally clean up the directory of files generated during installation by running the following command:\n\n```bash\nsudo make clean\n```\n\nTo uninstall `zaman`, go into the extracted/cloned directory and run the following command:\n\n```bash\nsudo make uninstall\n```\n\n## Usage\n\nRun the `zaman` command in your terminal to display a list of all the available man pages on your system in a dynamic menu (via [Rofi](https://davatorium.github.io/rofi/) or [Dmenu](https://tools.suckless.org/dmenu/)), allowing you to search for the one to display as a PDF.\n\n![zaman](https://user-images.githubusercontent.com/53110319/226755165-3080f232-cb9f-4d5b-aa06-b18032cd8eaa.png)\n\nAlternatively, you can directly specify the man page to open in the command (example below with the \"ls\" man page):\n\n![zaman_cmd](https://user-images.githubusercontent.com/53110319/226755190-9d005cbe-b893-4b96-b6c1-db97a70f3a4b.png)\n\nThe man page is opened as a PDF file in the default PDF reader defined in [XDG Mime Applications](https://wiki.archlinux.org/title/XDG_MIME_Applications) or in [Zathura](https://pwmt.org/projects/zathura/) if no default PDF reader is set.\n\n![zaman_pdf](https://github.com/Antiz96/zaman/assets/53110319/fca2f8a7-c428-47f9-a1cd-e3dd295ce3ca)\n\nYou can export a specific man page in a PDF file called \"man_`command`.pdf\" in your current directory with the `-O` (or `--save`) option *(if you run `zaman -O` without specifying which man page to save, `zaman` will offer you to select one via rofi / dmenu)*:\n\n![zaman_save](https://user-images.githubusercontent.com/53110319/226755247-637c4827-9940-43e4-88e9-4978152e4cc4.png)\n\nAlternatively, you can specify the destination file with the `-o` (or `--output`) option:\n\n![zaman_output](https://user-images.githubusercontent.com/53110319/226755261-cb4bf006-fae3-48ea-8187-8c4e1772b7b0.png)\n\n## Documentation\n\nSee `zaman --help` and the [zaman(1) man page](https://github.com/Antiz96/zaman/blob/main/doc/man/zaman.1.scd).\n\n## Contributing\n\nSee the [contributing guidelines](https://github.com/Antiz96/zaman/blob/main/CONTRIBUTING.md).\n\n## License\n\nzaman is licensed under the [GPL-3.0 license](https://github.com/Antiz96/zaman/blob/main/LICENSE) (or any later version of that license).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantiz96%2Fzaman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantiz96%2Fzaman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantiz96%2Fzaman/lists"}