2026-02-18-notes-on-clarifying-man-pages-d55372f2af
man 페이지를 더 읽기 쉽게 만드는 방법에 대한 메모
Julia Evans
편집자 요약
작성자는 Git man 페이지를 다듬은 뒤 좋은 man 페이지의 조건을 고민하게 되었다고 합니다. 특히 tcpdump, git, dig 같은 도구의 문서를 찾아보기 어렵게 느껴서, man 페이지 안에 치트시트 같은 요약이 들어갈 수 있는지 살펴보고 있습니다. 예시로 rsync는 SYNOPSIS를 짧게 유지하고 OPTIONS SUMMARY에 각 옵션을 한 줄로 정리하며, strace는 옵션을 알파벳순이 아니라 범주별로 묶어 보여줍니다.
인사이트
초보자에게는 긴 옵션 목록보다 목적별 요약과 범주화가 탐색 비용을 줄여 줍니다. CLI 도구 문서를 읽을 때는 먼저 SYNOPSIS와 요약 섹션을 만들고, 옵션을 기능별로 묶는 구조를 참고하면 좋습니다.
댓글
댓글을 불러오는 중…