v1.3.3

Highlight

This release brings changes to the build system so that the man pages are not compressed by default anymore. Indeed, compressing man pages is a distribution / user preference that should be handled on the packaging side rather than on the build system side.
Additionally, it can lead to unexpected side effects. For instance, gzip recording timestamps in metadata by default, which prevents reproducible builds (see 51efce8).

See https://cmpct.info/~sam/blog/posts/automatic-manpage-compression/ for detailed rational.

Styling

• Remove unconventional dots from output (#70) - (a330014) by @Antiz96

Miscellaneous

• (man) Don't compress man pages during build (#69) - (3048a2e) by @Antiz96

Full Changelog: v1.3.2...v1.3.3

v1.3.2

Highlight

This release updates the build instructions in the Makefile to make Zaman reproducible (see https://reproducible-builds.org).

Styling

• Add a missing dot in the help msg (#67) - (bcd4b86) by @Antiz96

Miscellaneous

• Get rid of gzip timestamps during build to make Zaman reproducible (#68) - (51efce8) by @Antiz96

Full Changelog: v1.3.1...v1.3.2

v1.3.1

Highlight

Just a quick fix release to remove some outdated parts from the documentation.

Documentation

• Update help message and man page (#66) - (a28f3de) by @Antiz96

Full Changelog: v1.3.0...v1.3.1

v1.3.0

Highlight

This release introduces a bunch of new features, most notably:

• Zaman now uses the default PDF reader defined in XDG Mime Applications on the system, zathura is now only used as a fallback option if no default PDF reader is set.
• Add auto-completion support for man pages. You can now use [TAB] when using zaman to auto-complete the man pages names (like you would do with plain man).

This release also includes multiple changes and improvements to the repo structure as well as the documentation.

Important note:
Some changes have been made to the way Zaman should be installed from source. Make sure to read the updated instructions (people using the AUR package are not affected).

Features

• Use default PDF reader defined in XDG Mime Application (fallback to zathura) (#65) - (40a6f71) by @Antiz96
• Add dynamic shell completions for man pages (#64) - (8586cb4) by @Antiz96
• Add the -D / --debug option (#63) - (28e6917) by @Antiz96

Fixes

• Fix script path in Makefile (#59) - (f1d2efb) by @Antiz96

Documentation

• Add the 'License' section to the table of content in the README (#60) - (2dabea9) by @Antiz96
• Overall documentation rework (#56) - (a08403a) by @Antiz96

Styling

• (CONTRIBUTING.md) Fix typos (#61) - (848e796) by @Antiz96

Miscellaneous

• Update mdl rules in CI (#62) - (5902d50) by @Antiz96
• Add Release instructions + Changelog (#58) - (d83b65c) by @Antiz96
• Add simple unit tests with 'bats' (#57) - (7d42d37) by @Antiz96
• Add issues / pull requests templates (#55) - (51a234f) by @Antiz96
• Add CONTRIBUTING.md (#54) - (cc25e41) by @Antiz96

Full Changelog: v1.2.3...v1.3.0

v1.2.3

Highlight

This release introduces basic shell completions (for bash, zsh and fish) for Zaman.

Also, commits, tags and auto-generated tar.gz source tarball on releases are now signed via GPG; and a trust path for users has been added in the form of the MAINTAINERS.md file.

Features

• Add shell completions for bash, zsh and fish by @Antiz96 in #50

Improvements

• Use complete version ref in man page by @Antiz96 in #46
• Add a trust path for users by @Antiz96 in #47
• Precise that Zaman is licensed under GPL3+ by @Antiz96 in #48
• Add comments to the Makefile by @Antiz96 in #49

Full Changelog: v1.2.2...v1.2.3

v1.2.2

What's Changed

• Add a GitHub action to run shellcheck on pull requests by @Antiz96 in #26
• Add basic but useful information at the top of the main script by @Antiz96 in #27
• Refactoring the script with functions by @Antiz96 in #28
• Add the '-m|--menu' option by @Antiz96 in #29
• Add a clear and concise help message (instead of simply printing the man page) for the --help option by @Antiz96 in #30
• Use separated exit codes for each type of errors by @Antiz96 in #31
• Bump the script to v1.2.2 by @Antiz96 in #32

Full Changelog: v1.2.1...v1.2.2

v1.2.1

What's Changed

• Run the zathura process in the background by @Antiz96 in #24

Full Changelog: v1.2.0...v1.2.1

v1.2.0

What's Changed

• Let the users choose their prefered pdf backend between [zathura-pdf-poppler] and [zathura-pdf-mupdf] by @Antiz96 in #19
• Add rofi support by @Antiz96 in #20
• Print a proper error if no man page or file path is specified when using the output option by @Antiz96 in #21
• Stop opening PDF man pages in fullscreen mode by default by @Antiz96 in #22
• Bump the main script to v1.2.0 by @Antiz96 in #23

Full Changelog: v1.1.0...v1.2.0

v1.1.0

• New feature: The -o/--output flag allows you to save the PDF converted man page to a file of your choice (resquested in #15 by @SomethingGeneric)

zaman -o ls ~/Documents/man/ls.pdf

• New feature: The -O/--save flag allows you to quickly save the PDF converted man page to a local file named man_<command>.pdf (resquested in #15 by @SomethingGeneric)

You can either select the man page to save as a PDF file via the dmenu list:

zaman -O

Or you can specify the man page to save as a PDF file directly in the command:

zaman -O ls

• Added the -o/-O flags' documentation in both README.md and the zaman man page.

• Added various little improvements to the script.

v1.0.2

• The repo has been restructured to better suit best practices.
• New install/uninstall method: The install.sh and uninstall.sh scripts have been removed in favor of a Makefile; which is cleaner, more standard and way easier to maintain.
• The wiki pages has been merged directly into the README to centralize information (the wiki has therefore been deleted).
• The "dependencies" (and overall) documentation has been improved.
• A LICENSE file has been added to the repo (GLP3).