search

beyondgrep / ack2

**ack 2 is no longer being maintained. ack 3 is the latest version.**
https://github.com/beyondgrep/ack3/
Other
1.48k stars 138 forks source link

Submit patches to tldr's repo #680

Closed petdance closed 4 years ago

petdance commented 5 years ago

The tool tldr (repo) is getting a lot of traction lately. It's a man-like tool that focuses on examples on how to use a tool.

tldr's examples for ack aren't especially strong or exhaustive. Provide them some.

$ tldr ack
ack

A search tool like grep, optimized for programmers.

- Find files containing "foo":
  ack foo

- Find files of a specific type:
  ack --ruby foo

- Count the total number of matches for the term "foo":
  ack -ch foo

- Show the file names containing "foo" and number of matches in each file:
  ack -cl foo

- List all valid types:
  ack --help=types
petdance commented 5 years ago

Hmmm, seems that they don't want very many examples:

  1. Try to keep pages at around 5 examples. Pages can be longer if needed, but don't exceed 8 examples. Remember, it's OK if the page doesn't cover everything; that's what man is for.