Skip to content

Latest commit

聽

History

History
154 lines (92 loc) 路 8.25 KB

CHANGELOG.md

File metadata and controls

154 lines (92 loc) 路 8.25 KB
Raw

Changelog

1.5.2 - 2024-03-29

Fixed

1.5.1 - 2023-11-21

Fixed

  • Display accurate progress for progressbar when downloading ZIP archive (02f3e24)

1.5.0 - 2023-11-21

Changed

  • Improve error message descriptions, formatting, and color (0b0f2f8, cfdfd34)
  • Display directories first in the error message for when the cache contains non-cache files (1221945)
  • Suppress the usage of ANSI color when the environment variable TERM=dumb (d553712)

Added

  • Add freebsd, netbsd, and openbsd platforms (ba4392f)
  • Display download progress for ZIP archive (cfdfd34)
  • Use the environment variable TLDR_MAN_ARCHIVE_URL as the location to download the page archive from (cfdfd34)

Removed

  • Remove prioritizing --render and --update over other subcommand options when multiple options are specified (b2503ce)

Fixed

  • Lock cache directory while reading and writing to prevent race conditions (b487466)

1.4.1 - 2023-08-27

Changed

  • Change error message for when the cache directory contains non-cache files (8342da2)

Fixed

  • Enable ANSI color when displaying help information when the environment variable NO_COLOR is an empty string (click-contrib/click-help-colors#21, 40aa283)
  • Ensure that filenames can be displayed in error messages by replacing any invalid bytes or surrogate escapes with a replacement character (9286a6e)

1.4.0 - 2023-08-18

Changed

  • Prevent overwriting cache directory if it contains unexpected files that were not generated by running the tldr --update command (08033f0). This prevents potential data loss.

Added

  • Use the environment variable TLDR_MAN_CACHE_DIR for the location of the cache directory if it is present (af9d673)
  • Suppress the usage of ANSI color when either of the environment variables TLDR_MAN_NO_COLOR or NO_COLOR are present and are not an empty string (9c228dc)

1.3.1 - 2023-08-07

Changed

  • Change GitHub links from tldr-man-client to tldr-man (f389033)

Fixed

1.3.0 - 2023-07-26

Changed

  • Exit with a non-zero exit code when a page does not exist (5c839f4)
  • Exit with exit code 3 when the cache directory does not exit (5c839f4)
  • Exit with exit code 130 on a Keyboard Interrupt (5c839f4)
  • Update PyPI trove classifiers (280ab5b)

Added

Removed

  • Drop dependency on xdg package (012fac9)

1.2.0 - 2023-06-16

Changed

  • Display help page when no arguments or options are specified (#7)
  • Shorten label for cache update progress bar (#9)
  • Update metavar names for --platform and --language to be more descriptive (#7)
  • Change project name to tldr-man from tldr-man-client (7661e81)

Added

  • Add shell completion for page names and the --language option (#8)
  • Display the number of added, updated, and unchanged pages after updating the cache (#9)
  • Add -M option as an alias for the --manpath option (#7)

Fixed

  • Remove trailing period from the end of the help and version descriptions (#7)

1.1.1 - 2023-03-20

Fixed

  • Bump minimum python from 3.10.0 to 3.10.4 to fix race condition in zipfile (#3, #4)

1.1.0 - 2023-03-13

Changed

  • Improve cache update speed (#2)
  • Improve error message for the --render option when a directory or nonexistent file is provided (04bd41a)

1.0.3 - 2022-08-06

Fixed

  • Fix incorrect styling for pages which contain asterisk characters (c9a440b)

1.0.2 - 2022-07-29

Added

  • Document Homebrew installation option (d0b9959)

1.0.1 - 2022-07-28

Fixed

1.0.0 - 2022-07-28

First release.