mirror of https://github.com/CrimsonTome/tldr.git
CLIENT-SPECIFICATION: add lowercasing of commands (#5327)
parent
3c118dd49b
commit
8505e55b56
|
@ -59,28 +59,19 @@ tldr -l
|
||||||
|
|
||||||
The first argument that does not start with a dash (`-`), MUST be considered the page name.
|
The first argument that does not start with a dash (`-`), MUST be considered the page name.
|
||||||
|
|
||||||
In addition, page names MAY contain spaces (e.g. `git status`) - such page names MUST be transparently concatenated with dashes (`-`). For example, the page name:
|
Page names MAY contain spaces (e.g. `git status`), and such page names MUST be transparently concatenated with dashes (`-`). For example, the page name `git checkout` becomes `git-checkout`.
|
||||||
|
|
||||||
```
|
Page names MAY contain mixed capitalization, and such page names MUST be transparently lowercased. For example, the page name `eyeD3` becomes `eyed3`.
|
||||||
git checkout
|
|
||||||
```
|
|
||||||
|
|
||||||
becomes this:
|
|
||||||
|
|
||||||
```
|
|
||||||
git-checkout
|
|
||||||
```
|
|
||||||
|
|
||||||
Here are some example invocations:
|
Here are some example invocations:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tldr 7za
|
tldr 7za
|
||||||
tldr eyeD3
|
tldr eyeD3 # equivalent to tldr eyed3
|
||||||
tldr git checkout
|
tldr git checkout # equivalent to tldr git-checkout
|
||||||
tldr --platform osx bash
|
tldr --platform osx bash
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Directory structure
|
## Directory structure
|
||||||
|
|
||||||
This section documents the directory structure that contains the pages themselves.
|
This section documents the directory structure that contains the pages themselves.
|
||||||
|
@ -130,7 +121,7 @@ Although this specification is about the interface that clients must provide, it
|
||||||
|
|
||||||
This section defines the algorithm by which a client can decide which page a user has requested.
|
This section defines the algorithm by which a client can decide which page a user has requested.
|
||||||
|
|
||||||
After transparently replacing spaces (` `) with dashes (`-`), clients have several decisions to make:
|
After transparently replacing spaces (` `) with dashes (`-`) and lowercasing the name, clients have several decisions to make:
|
||||||
|
|
||||||
- The language of a page to display to a client
|
- The language of a page to display to a client
|
||||||
- The platform to display a page from
|
- The platform to display a page from
|
||||||
|
|
Loading…
Reference in New Issue