> 더 많은 정보: <https://example.com/command_name/help/page>.
- 코드 설명:
`command_name options`
- 코드 설명:
`command_name options`
...
```
예시:
```md
# 명령어 이름
# krita
> krita는 디지털 아티스트를 위해 설계된 스케치/페인팅 프로그램입니다.
> `gimp` 페이지도 참조하세요.
> 더 많은 정보: <https://docs.krita.org/en/reference_manual/linux_command_line.html>.
- krita 시작:
`krita`
- 로딩 화면 없이 시작:
`krita --nosplash`
- 특정 파일 열기:
`krita {{path/to/image1 path/to/image2 ...}}`
- 특정 workspace (`Animation`) 에서 시작:
`krita --workspace {{Animation}}`
- 전체화면으로 시작:
`krita --fullscreen`
```
> :bulb: 도움말 페이지는 매뉴얼 뿐 아니라 문서, 프로젝트, 튜토리얼 등이 될 수 있습니다.
> 그러나, 문서 페이지를 권장합니다.
위의 형식들을 강제하는 linter가 있습니다.
모든 pull 요청에 대해 자동으로 실행되지만, 제출하기 전 local에서 테스트하기 위해 설치할 수 있습니다.
```sh
npm install --global tldr-lint
tldr-lint path/to/tldr_page.md
```
`tldr-lint`를 사용하기 위한 여러 방법들이 많습니다. 다음은 이에 대한 안내 페이지입니다. 확인해 보세요! [`tldr tldr-lint`](https://github.com/tldr-pages/tldr/blob/main/pages/common/tldr-lint.md).
별칭 `tldrl`을 쓸 수도 있습니다.
Client는 `--render` 명령어를 통해 local에서 페이지를 미리 볼 수 있습니다.
```sh
tldr --render path/to/tldr_page.md
```
### Aliases
만약 명령어를 다른 별칭으로 부를 수 있는 경우 (ex: `vim`과 `vi`) 사용자가 원래 명령 이름을 가리키도록 별칭 페이지를 만들 수 있습니다.
```md
# 명령어 이름
> 이 명령어는 `originam-command-name`의 별칭입니다.
> 더 많은 정보는 <https://example.com/original/command/help/page>를 참조하세요.
- 원래 명령어에 대한 문서:
`tldr vim`
```
- 번역된 별칭 페이지 템플릿은 [여기](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/alias-pages.md)에서 확인할 수 있습니다.
## Token syntax
사용자 입력 값은 `tldr` 클라이언트에게 강조될 수 있도록 `{{token}}` 구문을 사용해야 합니다.
- 만약 일반적인 확장자가 필요하다면, **반드시 필요한 경우에만** `{{.ext}}`를 사용하십시오.
예시1: `find.md`의 "확장자로 파일 찾기"(`find {{root_path}} -name '{{*.ext}}'`)는 `{{*.ext}}`를 사용하여 불필요한 내용 없이, 구체적이지 않게 설명합니다.
예시2: `wc -l {{file}}`는 `{{file}}`을 (extension 없이) 사용하는 것 만으로 충분합니다.
### Special Cases
- 만약 명령어가 파일 시스템이나 장치에 돌이킬 수 없는 변경을 수행하는 경우, 모든 예제를 생각 없이 복사하여 붙여넣을 수 없도록 작성하십시오.
예를 들어 `ddrescue --force --no-scrape /dev/sda /dev/sdb` 대신에 `ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}}`를 사용하고, *block device*에 `/dev/sda1` 대신 `{{/dev/sdXY}}` 자리 표시자를 사용하세요.
