시스템 & 인프라/Linux & DevOps

[리눅스 한 학기 살기 #9] tldr로 리눅스 명령어 예제 찾기: man과의 차이

kugorang 2025. 5. 27. 22:40
728x90

TL;DR (세 줄 요약)

  1. tldr은 명령어의 사용 예제만 짧게 보여 주는 도구입니다. man 페이지는 옵션 전체를 나열하지만, 지금 하려는 일을 어떻게 입력하는지는 바로 찾기 어렵습니다.
  2. tldr-pages는 명령어마다 Markdown 파일 하나를 두고, 한 줄 설명과 예제 5~8개만 적습니다. 프로그램은 전체 페이지 묶음(zip)을 내려받아 내 컴퓨터에 저장해 두고, 조회할 때는 저장된 파일을 읽습니다.
  3. 처음 배울 때는 tldr로 예제를 따라 해 보고, 옵션 조합이 헷갈리면 man과 explainshell로 확인하는 순서가 효율적입니다.

이 글은 "리눅스 한 학기 살기" 과제의 9주 차 기록입니다. tldr은 "Too Long; Didn't Read(너무 길어서 읽지 않았다)"의 줄임말입니다.

1. tldr은 무엇을 보여 주나요?

터미널 창 모양 안에 tldr이라는 글자가 크게 적힌 그림
그림. tldr의 특징에 맞춰 간결하게 만든 대표 이미지

$ tldr tar
tar
Archiving utility.
More information: https://www.gnu.org/software/tar

- [c]reate an archive and write it to a [f]ile:
  tar cf target.tar file1 file2

출력은 세 부분으로 이루어집니다.

  1. 명령어 이름
  2. 한 줄 설명과 공식 문서 주소
  3. 예제 목록. 각 예제는 "- 설명:" 한 줄과 실제 명령어 한 줄로 되어 있습니다.

설명에서 대괄호로 감싼 글자는 그 옵션의 약자입니다. 위 예에서 [c]reate는 c 옵션이 create(만들기)를 뜻한다는 표시입니다.

2. 예제 데이터는 어디에서 오나요?

  1. tldr-pages 저장소에 pages/(영어), pages.ko/(한국어) 같은 언어 폴더가 있습니다.
  2. 각 언어 폴더 아래에 common/, linux/, windows/, osx/ 플랫폼 폴더가 있습니다.
  3. tldr 프로그램(클라이언트)이 GitHub 릴리스의 tldr.zip을 내려받아 캐시 폴더에 풉니다. 캐시는 다시 내려받지 않도록 내 컴퓨터에 저장해 둔 사본입니다.
  4. tldr 명령을 실행하면 현재 운영체제와 언어에 맞는 파일을 찾아 읽습니다.
  5. 맞는 파일이 없으면 common/의 영어 페이지를 보여 줍니다.

tldr 클라이언트는 여러 종류가 있습니다.

클라이언트특징
Node.js 클라이언트~/.tldr/에 저장합니다. .tldrrc 파일로 색상과 경로를 설정합니다.
Python 클라이언트~/.cache/tldr/(XDG 규칙)에 저장합니다. TLDR_LANGUAGE, TLDR_CACHE_MAX_AGE 환경변수로 설정합니다.
tealdeer (Rust)실행 파일 하나로 되어 있고 실행이 빠릅니다. --auto-update를 지원합니다.
tlrc (Rust)공식 구현입니다. 언어별 SHA256 값을 비교해서 바뀐 언어만 갱신합니다.

3. 어떻게 설치하고 사용하나요?

sudo apt install tldr        # Debian/Ubuntu
sudo dnf install tldr        # Fedora
cargo install tealdeer       # Rust
brew install tldr            # macOS

tldr --update                # 캐시 갱신
tldr -p linux ls             # 플랫폼 지정
tldr --language ko tar       # 언어 지정
tldr --search "extract"      # 전체 페이지 검색
  • tldr --update: 캐시를 최신으로 갱신합니다.
  • tldr -p linux ls: 플랫폼을 지정해서 조회합니다.
  • tldr --language ko tar: 언어를 지정해서 조회합니다.
  • tldr --search "extract": 전체 페이지에서 단어를 검색합니다.

한 번 받아 두면 인터넷 없이도 동작합니다. 최신 내용이 필요할 때만 --update를 실행합니다. 클라이언트 종류에 따라 지원하는 옵션이 조금씩 다릅니다.

4. man, explainshell, cheat.sh와는 어떻게 다른가요?

도구역할
tldr"이 명령어로 무엇을 할 수 있는가"를 예제로 보여 줍니다. 옵션 전체 목록은 없습니다.
man모든 옵션과 동작의 정확한 정의, 반환값, 파일 위치를 담고 있습니다.
explainshell입력한 명령줄을 조각으로 나누고, 각 옵션의 뜻을 man 페이지에서 찾아 붙여 줍니다.
cheat.sh여러 출처의 요약 자료(치트시트)를 curl로 조회합니다. 인터넷이 필요합니다.

자주 묻는 질문 (FAQ)

Q1. tldr에 원하는 예제가 없습니다.

tldr은 예제를 5~8개로 제한하기 때문에 드물게 쓰는 옵션은 없습니다. 그때는 man으로 확인합니다. 필요하면 tldr-pages 저장소에 PR(Pull Request, 변경 제안)을 보내 예제를 추가할 수 있습니다. Markdown 파일 하나를 고치는 일이라서 오픈소스에 처음 기여해 보기에도 적합합니다.

Q2. 오프라인에서도 쓸 수 있나요?

쓸 수 있습니다. 처음 실행할 때나 --update를 실행할 때 zip을 받아 캐시에 저장하고, 그 뒤에는 네트워크 없이 저장된 파일을 읽습니다. 다만 캐시가 오래되면 새로 추가된 옵션이 빠져 있을 수 있습니다.

Q3. 한국어 페이지가 나오지 않습니다.

번역이 없는 명령어이거나 클라이언트의 언어 설정이 영어로 되어 있을 수 있습니다. tldr --language ko로 언어를 지정해 봅니다. 그래도 없으면 영어 페이지가 표시됩니다. 번역된 페이지 수는 영어보다 적습니다.

수정 안내

이 글은 2026년 11월 21일에 다시 썼습니다. 설치 명령어 주석에서 apt로 설치되는 클라이언트의 종류를 적은 부분은 배포판 버전에 따라 다를 수 있어 삭제했습니다.

참고 자료

같은 주제의 다른 글: [리눅스 한 학기 살기 #6] Docker로 Jenkins 실행하기: CI/CD 개념과 초기 설정, [리눅스 한 학기 살기 #7] Vim 입문: 모드, 저장과 종료, 이동, 매크로, [리눅스 한 학기 살기 #8] ca-certificates란? 사내 CA 인증서 추가 방법, [리눅스 한 학기 살기 #10] tree 명령어로 디렉터리 구조 보기: 동작 순서와 옵션, [리눅스 한 학기 살기 #11] htop 사용법: top과의 차이, CPU·메모리 수치 읽기

728x90
728x90