diff --git a/README.md b/README.md index e93bebf89f..53b916e14d 100644 --- a/README.md +++ b/README.md @@ -27,19 +27,23 @@ to traditional [man pages](https://en.wikipedia.org/wiki/Man_page). Maybe you're new to the command-line world? Perhaps you're just a little rusty or can't always recall the arguments for commands like `lsof`, or `tar`? -It certainly doesn't help that the first option explained in `man tar` is: +It certainly doesn't help that, in the past, the first option explained in `man tar` was: -``` +```console +$ man tar +... -b blocksize Specify the block size, in 512-byte records, for tape drive I/O. As a rule, this argument is only needed when reading from or writing to tape drives, and usually not even then as the default block size of 20 records (10240 bytes) is very common. +... ``` There seems to be room for simpler help pages, focused on practical examples. How about: -![Animated SVG of the tldr client displaying the tar command.](images/tldr.svg) +![Screenshot of the tldr client displaying the tar command in light mode.](images/tldr-light.png#gh-light-mode-only) +![Screenshot of the tldr client displaying the tar command in dark mode.](images/tldr-dark.png#gh-dark-mode-only) This repository is just that: an ever-growing collection of examples for the most common UNIX, Linux, macOS, SunOS, Android and Windows command-line tools. diff --git a/images/tldr-dark.png b/images/tldr-dark.png new file mode 100644 index 0000000000..a68ff58034 Binary files /dev/null and b/images/tldr-dark.png differ diff --git a/images/tldr-light.png b/images/tldr-light.png new file mode 100644 index 0000000000..052159deb0 Binary files /dev/null and b/images/tldr-light.png differ diff --git a/images/tldr.svg b/images/tldr.svg deleted file mode 100644 index 671549b4d6..0000000000 --- a/images/tldr.svg +++ /dev/null @@ -1,494 +0,0 @@ - - - - - - - - ➜ - ~ - - - ➜ - ~ - tldr - - - ➜ - ~ - tldr - tar - - - tar - - - Archiving - utility. - - - Often - combined - with - a - compression - method, - such - as - gzip - or - bzip2. - - - More - information: - https://www.gnu.org/software/tar. - - - - - [c]reate - an - archive - from - [f]iles: - - - tar - cf - target.tar - file1 - file2 - file3 - - - - - [c]reate - a - g[z]ipped - archive - from - [f]iles: - - - tar - czf - target.tar.gz - file1 - file2 - file3 - - - - - [c]reate - a - g[z]ipped - archive - from - a - directory - using - relative - paths: - - - tar - czf - target.tar.gz - --directory= - path/to/directory - . - - - - - E[x]tract - a - (compressed) - archive - [f]ile - into - the - current - directory: - - - tar - xf - source.tar[.gz|.bz2|.xz] - - - - - E[x]tract - a - (compressed) - archive - [f]ile - into - the - target - directory: - - - tar - xf - source.tar[.gz|.bz2|.xz] - --directory= - directory - - - - - [c]reate - a - compressed - archive - from - [f]iles, - using - [a]rchive - suffix - to - determine - the - compression - program: - - - tar - caf - target.tar.xz - file1 - file2 - file3 - - - - - Lis[t] - the - contents - of - a - tar - [f]ile - [v]erbosely: - - - tar - tvf - source.tar - - - - - E[x]tract - [f]iles - matching - a - pattern: - - - tar - xf - source.tar - --wildcards - " - *.html - " - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ➜ - ~ - t - - - - - ➜ - ~ - tl - - - - - ➜ - ~ - tld - - - - - - - - - - - - - - - ➜ - ~ - tldr - t - - - - - ➜ - ~ - tldr - ta - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - tar - xf - source.tar[.gz|.bz2|.xz] - --directory= - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -