Skip to content

Commit 8505e55

Browse files
authored
CLIENT-SPECIFICATION: add lowercasing of commands (#5327)
1 parent 3c118dd commit 8505e55

File tree

1 file changed

+5
-14
lines changed

1 file changed

+5
-14
lines changed

Diff for: CLIENT-SPECIFICATION.md

+5-14
Original file line numberDiff line numberDiff line change
@@ -59,28 +59,19 @@ tldr -l
5959

6060
The first argument that does not start with a dash (`-`), MUST be considered the page name.
6161

62-
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:
62+
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`.
6363

64-
```
65-
git checkout
66-
```
67-
68-
becomes this:
69-
70-
```
71-
git-checkout
72-
```
64+
Page names MAY contain mixed capitalization, and such page names MUST be transparently lowercased. For example, the page name `eyeD3` becomes `eyed3`.
7365

7466
Here are some example invocations:
7567

7668
```bash
7769
tldr 7za
78-
tldr eyeD3
79-
tldr git checkout
70+
tldr eyeD3 # equivalent to tldr eyed3
71+
tldr git checkout # equivalent to tldr git-checkout
8072
tldr --platform osx bash
8173
```
8274

83-
8475
## Directory structure
8576

8677
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
130121

131122
This section defines the algorithm by which a client can decide which page a user has requested.
132123

133-
After transparently replacing spaces (` `) with dashes (`-`), clients have several decisions to make:
124+
After transparently replacing spaces (` `) with dashes (`-`) and lowercasing the name, clients have several decisions to make:
134125

135126
- The language of a page to display to a client
136127
- The platform to display a page from

0 commit comments

Comments
 (0)