|
@@ -0,0 +1,163 @@
|
|
|
+# ์คํ์ผ ๊ฐ์ด๋
|
|
|
+
|
|
|
+์ด ํ์ด์ง๋ `tldr` ํ์ด์ง์ ๋ํ ํ์ ์ง์ ์ง์นจ๋ค์ ๋์ดํฉ๋๋ค.
|
|
|
+
|
|
|
+## ๋ ์ด์์
|
|
|
+
|
|
|
+๊ฐ ํ์ด์ง์ ๊ธฐ๋ณธ ํฌ๋งท์ ๋ค์ ํ
ํ๋ฆฟ๊ณผ ์ผ์นํด์ผ ํ๋ฉฐ, ๋ค์๊ณผ ์ต๋ 8๊ฐ์ ๋ช
๋ น์ด ์์ ๋ฅผ ํฌํจํด์ผ ํฉ๋๋ค:
|
|
|
+```md
|
|
|
+# ๋ช
๋ น์ด ์ด๋ฆ
|
|
|
+
|
|
|
+> ์งง๊ณ ๊ฐ๊ฒฐํ ์ค๋ช
|
|
|
+> ๋ณดํต 1์ค, ํ์ํ 2์ค ๊น์ง ํ์ฉ๋จ
|
|
|
+> ๋ ๋ง์ ์ ๋ณด: <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}}` ๊ตฌ๋ฌธ์ ์ฌ์ฉํด์ผ ํฉ๋๋ค.
|
|
|
+
|
|
|
+ํ ํฐ์ ์ ํํ ๋ ๋ค์์ ๊ฐ์ด๋๋ผ์ธ์ ์ผ๋์ ๋์ญ์์ค:
|
|
|
+
|
|
|
+### Naming
|
|
|
+- ์งง์ง๋ง ์ค๋ช
์ ์ธ ํ ํฐ์ ์ฌ์ฉํ์ธ์.
|
|
|
+- ํ์ผ ๋ฐ ๋๋ ํ ๋ฆฌ ๊ฒฝ๋ก์ ๋ํ ์ฐธ์กฐ์ ๊ฒฝ์ฐ:
|
|
|
+ `{{path/to/<placeholder>}}`์ ํฌ๋งท์ ์ฌ์ฉํ์ธ์.
|
|
|
+ (์์์ ์ธ ๊ฒฝ๋ก์ธ ๊ฒฝ์ฐ๋ ์ ์ธ!)
|
|
|
+- ๊ฒฝ๋ก๊ฐ ์๋๊ฒฝ๋ก์ผ ์ ์์ง๋ง ํ์ผ ์์คํ
์ root์์ ์์ํด์ผ ํ๋ ๊ฒฝ์ฐ
|
|
|
+ ์ ๋์ฌ๋ก `/`๋ฅผ ๋ถ์
๋๋ค.
|
|
|
+ (ex: `get {{/path/to/remote_file
|
|
|
+- ํ์ผ ๋ฐ ๋๋ ํ ๋ฆฌ ์ฐธ์กฐ๊ฐ ๋ชจ๋ ๊ฐ๋ฅํ ๊ฒฝ์ฐ
|
|
|
+ `{{path/to/file_or_directory}}`๋ฅผ ์ฌ์ฉํ์ธ์.
|
|
|
+
|
|
|
+### Extensions
|
|
|
+
|
|
|
+- ํ์ผ์ ํน์ ํ์ฅ์๊ฐ ํ์ํ ๊ฒฝ์ฐ ์ถ๊ฐํ์ญ์์ค.
|
|
|
+ (ex: `unrar x {{compressed.rar}}`)
|
|
|
+- ๋ง์ฝ ์ผ๋ฐ์ ์ธ ํ์ฅ์๊ฐ ํ์ํ๋ค๋ฉด, **๋ฐ๋์ ํ์ํ ๊ฒฝ์ฐ์๋ง** `{{.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}}` ์๋ฆฌ ํ์์๋ฅผ ์ฌ์ฉํ์ธ์.
|
|
|
+- ๋ช
๋ น์ด๊ฐ ๋ง์ ์์ ๋ช
๋ น์ด๋ฅผ ํฌํจํ ์ ์๋ ๊ฒฝ์ฐ, ๋ค์๊ณผ ๊ฐ์ด ์๋ตํ์ฌ ํํํ์ธ์.
|
|
|
+ `{{arg1 arg2 ...}}` ์ฌ๋ฌ ์ต์
์ค ํ๋๊ฐ ๊ฐ๋ฅํ ๊ฒฝ์ฐ `{{either|or}}`๋ก ์์ฑํฉ๋๋ค.
|
|
|
+
|
|
|
+์ผ๋ฐ์ ์ผ๋ก, ํ ํฐ์ ๊ฐ๋ฅํ ํ ์ง๊ด์ ์ด์ด์ผ ํฉ๋๋ค.
|
|
|
+๋ช
๋ น์ ์ฌ์ฉํ๋ ๋ฐฉ๋ฒ์ ํ์
ํ๊ณ ๊ฐ์ผ๋ก ์ฑ์ฐ์ญ์์ค.
|
|
|
+
|
|
|
+๋ด์ฉ ์
๋ ฅ๋์ ๊ธฐ์ ๋ฌธ๊ตฌ๋ `backtick` ๊ตฌ๋ฌธ์ ์ฌ์ฉํด์ผ ํฉ๋๋ค.
|
|
|
+๋ค์๊ณผ ๊ฐ์ด ์ญ๋ฐ์ดํ๋ฅผ ์ฌ์ฉํ์ญ์์ค.
|
|
|
+
|
|
|
+- Paths, ex. `package.json`, `/etc/package.json`.
|
|
|
+- Extensions, ex. `.dll`.
|
|
|
+- Commands, ex. `ls`.
|
|
|
+
|
|
|
+## Imperative Mood
|
|
|
+
|
|
|
+์์ ์ค๋ช
ํ์ ๋ช
๋ น๋ฒ์ผ๋ก ํํ๋์ด์ผ ํฉ๋๋ค.
|
|
|
+์๋ฅผ ๋ค์๋ฉด `List all files.`๋ฅผ `Listing all files`, `File listing` ๋ฑ ์
๋๋ค.
|
|
|
+์ด๊ฒ์ ํน๋ณํ ๊ฒฝ์ฐ๋ฅผ ์ ์ธํ๊ณ ๊ธฐ๋ณธ์ ์ผ๋ก **๋ชจ๋ ๋ฒ์ญ์ ์ ์ฉ**๋ฉ๋๋ค.
|
|
|
+
|
|
|
+## Serial Comma
|
|
|
+
|
|
|
+3๊ฐ ์ด์์ ํญ๋ชฉ ๋ชฉ๋ก์ ์ ์ธํ ๋, Oxford ์ผํ๋ผ๊ณ ๋ ๋ถ๋ฅด๋ [์ฐ์ ์ผํ](https://en.wikipedia.org/wiki/Serial_comma)๋ฅผ ์ฌ์ฉํฉ๋๋ค.
|
|
|
+
|
|
|
+> Git brances, tags, remotes๋ฅผ ์ญ์ ํ์ธ์.
|
|
|
+
|
|
|
+์์ ์๋ ์ง๋ ฌ ์ผํ๋ฅผ ์ฌ์ฉํ์ง ์์ผ๋ฏ๋ก ๋ค์ ๋ ๊ฐ์ง ์ค ํ๋๋ฅผ ์๋ฏธํ ์ ์์ต๋๋ค.
|
|
|
+* `tags`์ `remotes`๋ผ๋ Git branch๋ค์ ์ญ์ ํ์ธ์.
|
|
|
+* Git branches, Git tag, Git remotes๋ฅผ ๋ชจ๋ ์ญ์ ํ์ธ์.
|
|
|
+
|
|
|
+๋ชฉ๋ก์ ๋ง์ง๋ง ์์์์ "and" ๋๋ "or" ์์ ์ผํ๋ฅผ ์ฝ์
ํ๋ฉด ์ด ๋ฌธ์ ๋ฅผ ํด๊ฒฐํ ์ ์์ต๋๋ค.
|
|
|
+
|
|
|
+> Git branches, tags ๋ฐ remotes๋ฅผ ์ญ์ ํ์ธ์.
|
|
|
+
|
|
|
+## More information links
|
|
|
+
|
|
|
+`More information` ์ค์๋ ์์ฑ์๊ฐ ์ ๊ณตํ ๋ฌธ์๋ก ์ฐ๊ฒฐํ๋ ๊ฒ์ ๊ถ์ฅํฉ๋๋ค.
|
|
|
+์ฌ์ฉํ ์ ์๋ ๊ฒฝ์ฐ, ๊ธฐ๋ณธ fallback์ผ๋ก <https://manned.org>๋ฅผ ์ฌ์ฉํฉ๋๋ค.
|