매뉴얼 페이지 읽는 법

명령과 함께 설치되는 기본 문서

Unix 도구는 보통 실행 파일과 함께 매뉴얼 페이지를 제공해. man ls, man ssh, man curl처럼 명령 이름을 넘기면 현재 머신에 설치된 바로 그 구현의 설명을 읽을 수 있어. 검색 결과의 오래된 블로그보다 로컬 버전의 옵션과 종료 상태를 확인하기에 적합해. 매뉴얼은 대개 less로 열리므로 긴 문서를 파일처럼 탐색할 수 있어.

매뉴얼의 구역을 구분해

같은 이름이 서로 다른 대상에 쓰일 수 있어서 매뉴얼은 구역 번호를 둬. 1번은 사용자 명령, 2번은 시스템 호출, 3번은 라이브러리 함수, 5번은 파일 형식, 7번은 개념과 관례, 8번은 시스템 관리 명령이 중심이야. man -a printf는 같은 이름의 항목을 차례로 보여 주고, man 3 printf처럼 번호를 지정하면 원하는 설명을 바로 열 수 있어.

문서 안에서 필요한 곳으로 이동해

매뉴얼을 연 뒤 /pattern으로 앞으로 검색하고 ?pattern으로 뒤로 검색해. n과 N은 다음·이전 일치 항목, g와 G는 처음·끝, q는 종료야. 옵션을 찾을 때는 하이픈까지 포함해 검색하면 본문의 우연한 단어와 구분하기 쉬워. h를 누르면 현재 pager의 키 도움말도 볼 수 있어.

이름을 모를 때는 설명을 검색해

apropos socket 또는 man -k socket은 설치된 매뉴얼의 한 줄 설명에서 단어를 찾아. 명령 이름은 기억나지 않지만 하고 싶은 일은 설명할 수 있을 때 유용해. 후보를 찾은 뒤 해당 매뉴얼의 SYNOPSIS, DESCRIPTION, EXIT STATUS, EXAMPLES를 순서대로 읽으면 호출 형태와 실패 의미를 빠르게 잡을 수 있어.

짧은 예시는 매뉴얼을 보완해

매뉴얼이 너무 딱딱하면 tldr나 요약 문서에서 대표 예제를 먼저 보고, 경계 사례와 정확한 옵션은 다시 매뉴얼에서 확인해. 온라인 문서는 최신 릴리스를 설명하고 로컬 바이너리는 이전 버전일 수 있으므로 버전 차이도 함께 봐야 해. macOS의 BSD 도구와 Linux의 GNU 도구는 같은 이름이어도 플래그가 다를 수 있으니, 실제 실행 환경의 문서가 마지막 기준이야.

Code

매뉴얼 페이지 능숙하게 보기·bash

man bash                  # less에서 열림
# 화면 안에서 /pattern으로 찾고 n 또는 N으로 이동
# G는 끝, g는 처음, q는 종료
man -k git                # 관련된 매뉴얼 페이지 검색
man -a printf             # 셸과 C의 printf 매뉴얼을 차례로 열기
man 5 crontab             # 명령이 아니라 파일 형식 매뉴얼

매뉴얼 페이지 출력을 다른 데로·bash

# 서식 이스케이프 없이 일반 텍스트로 출력
man ls | col -b > ls-manual.txt
# 직접 열지 않고 내용 검색
man bash | grep -n 'PROMPT_COMMAND'

Exercise

man ls를 열고 /를 눌러 -h를 검색한 뒤 해당 옵션의 의미를 확인해. q로 나온 다음 apropos network 결과에서 처음 보는 항목 세 개를 골라 man <name>으로 열고 사용법 요약을 읽어 봐. 이 과정을 5분만 반복해도 매뉴얼에서 필요한 정보를 찾는 일이 훨씬 편해져.