Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typo in the help message #47

Merged
merged 2 commits into from
Oct 29, 2023
Merged

Fix typo in the help message #47

merged 2 commits into from
Oct 29, 2023

Conversation

kbdharun
Copy link
Member

@kbdharun kbdharun commented Oct 29, 2023

Changes

  • Add support for the newly added FreeBSD and NetBSD Platforms.
  • Update Capitalization for these platforms in Code.
  • Minor fixes.

Reference image

image

Reference output

➜  debug git:(feat/bsd) ./tldr
tlrc v1.6.0 (implementing the tldr client specification v2.0) - debug build (2323da0)
A tldr client written in Rust

Usage: tldr [OPTIONS] <PAGE>...

Arguments:
  <PAGE>...  The tldr page to show

Options:
  -u, --update               Update the cache
  -l, --list                 List all pages in the current platform
  -a, --list-all             List all pages
  -i, --info                 Show cache information (installed languages and the number of pages)
  -r, --render <FILE>        Render the specified markdown file
      --clean-cache          Clean the cache
      --gen-config           Print the default config
      --config-path          Print the default config path and create the config directory
  -p, --platform <PLATFORM>  Specify the platform to use [default: linux] [possible values: linux, osx, openbsd, freebsd, netbsd, windows, android, sunos, common]
  -L, --language <LANGUAGE>  Specify the languages to use
  -o, --offline              Do not update the cache, even if it is stale
  -c, --compact              Strip empty lines from output
      --no-compact           Do not strip empty lines from output (overrides --compact)
  -R, --raw                  Print pages in raw markdown instead of rendering them
      --no-raw               Render pages instead of printing raw file contents (overrides --raw)
  -q, --quiet                Suppress status messages
      --color <WHEN>         Specify when to enable color [default: auto] [possible values: auto, always, never]
      --config <FILE>        Specify an alternative path to the config file
  -v, --version              Print version
  -h, --help                 Print help

See 'man tldr' or https://tldr.sh/tlrc for more information.

@kbdharun kbdharun requested a review from acuteenvy October 29, 2023 12:46
@kbdharun kbdharun marked this pull request as draft October 29, 2023 12:49
@kbdharun kbdharun marked this pull request as ready for review October 29, 2023 13:01
@acuteenvy
Copy link
Member

I'm sorry, I've just finished removing the Platform enum and implementing platform detection from the cache directory (as suggested in tldr-pages/tldr#11313 (comment)). I had the changes locally and I didn't push it.

I hope this didn't take too long

@kbdharun
Copy link
Member Author

I'm sorry, I've just finished removing the Platform enum and implementing platform detection from the cache directory (as suggested in tldr-pages/tldr#11313 (comment)). I had the changes locally and I didn't push it.

I hope this didn't take too long

No issues, feel free to close this PR.

@kbdharun kbdharun closed this Oct 29, 2023
@kbdharun kbdharun deleted the feat/bsd branch October 29, 2023 13:55
@acuteenvy acuteenvy restored the feat/bsd branch October 29, 2023 13:56
@acuteenvy acuteenvy reopened this Oct 29, 2023
@acuteenvy acuteenvy changed the title feat: add support for FreeBSD and NetBSD Fix typo Oct 29, 2023
@acuteenvy acuteenvy changed the title Fix typo Fix typo in the help message Oct 29, 2023
@acuteenvy acuteenvy merged commit a5e2457 into main Oct 29, 2023
3 checks passed
@acuteenvy acuteenvy deleted the feat/bsd branch October 29, 2023 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants