man 페이지 제목에 숫자 (예: sleep(3))
Source: Hacker News
Overview
Linux 시스템 프로그래밍을 한다면, 명령줄에서든, 혹은 제가 개인적으로 선호하는 훌륭한 man7.org 혹은 linux.die.net을 이용하든 man 페이지를 많이 살펴보았을 것입니다.
sleep(3)와 read(2)에서 보이는 숫자들을 언제나 보고는 “이게 뭘 의미하나?” 하고 궁금해했지만, 실제로 찾아보지는 않았습니다—그런데 풀 리퀘스트에 대한 리뷰 코멘트에서 처음 알게 되었습니다:
// Behaves like man 2 basename
// reviewer: nit: it’s not a syscall, so “man 2” is incorrect
Man page section numbers
man(1) 페이지(또는 man man으로 접근 가능)에는 섹션 번호와 해당 섹션에 포함된 페이지 유형을 매핑한 표가 있습니다:
1 Executable programs or shell commands
2 System calls (functions provided by the kernel)
3 Library calls (functions within program libraries)
... less common section numbers
따라서 올바른 코멘트는 다음과 같아야 합니다:
// behaves like man 3 basename
왜냐하면 basename(3)은 libc 라이브러리 호출이기 때문입니다.
Suffixes
숫자 섹션 외에도, 특수 카테고리를 나타내기 위해 다양한 문자 접미사가 붙을 수 있습니다:
p– POSIX man 페이지, 예:free(3p)x– X 문서, 예:ncurses(3x)
수년간 man 페이지를 사용하면서 오늘야말로 이 사실을 알게 된 것이 부끄럽습니다.