man - 온라인 매뉴얼 페이지 참조

man - manual

시스템에 등록된 명령어, 함수, 설정 파일 등의 상세한 사용 설명서(온라인 매뉴얼)를 화면에 출력하다.

1. 명령어 용도

• 시스템 명령어의 정확한 서식, 옵션, 인자 및 반환 값을 확인하고자 할 때 사용되다.
• 특정 명령어의 기능은 알고 있으나 정확한 옵션이 기억나지 않는 경우, 또는 관련 설정 파일의 형식을 검증할 때 주로 활용되다.
• 실무 및 Stack Overflow 등에서 자주 언급되는 대표적인 활용 상황은 다음과 같다.
  • 특정 명령어의 전체 옵션 및 활용 예제 확인: man tar, man ssh 등
  • 특정 섹션의 매뉴얼 확인: 동명의 명령어와 C언어 함수가 존재할 때(예: mkdir), 개발을 위해 시스템 콜 함수 설명이 필요할 경우 man 2 mkdir 형태로 조회하다.
  • 키워드 검색을 통한 명령어 매칭: 명령어의 정확한 이름이 생각나지 않을 때 기능적 키워드로 관련 매뉴얼 리스트를 검색하다.

2. 명령어 서식

man [옵션] [섹션] 명령어

3. 명령어 옵션

옵션	설명	사용가능 OS 및 쉘
-k, --apropos	지정한 키워드가 포함된 모든 매뉴얼의 한 줄 요약을 검색하다.
-f, --whatis	지정한 명령어의 간단한 기능 설명을 출력하다.
-S, -s, --sections	검색할 매뉴얼 섹션을 명시적으로 지정하다. (단일 섹션 지정 시 생략 가능)
-a, --all	일치하는 모든 매뉴얼 페이지를 순차적으로 모두 표시하다.
-w, --where	매뉴얼 페이지 파일이 실제로 위치한 물리적 경로를 출력하다.
-l, --local-file	시스템에 등록된 매뉴얼이 아닌, 로컬에 저장된 nroff 매뉴얼 파일을 직접 열다.
-C, --config-file	기본 설정 파일 대신 지정한 구성 파일을 사용하다.
-p, --preprocessor	매뉴얼을 표시하기 전에 실행할 전처리기를 지정하다.
-X	윈도우 크기에 맞게 gxditview 형식으로 매뉴얼을 출력하다.	[X11 지원 리눅스]

 

명령어 옵션 사용 예시

# mkdir에 대한 간단한 한 줄 설명을 조회하다
man -f mkdir
# mkdir (1) - make directories
# mkdir (2) - make a directory (System Call)

# passwd 키워드가 포함된 매뉴얼을 전체 검색하다
man -k passwd
# chpasswd (8)       - update passwords in batch mode
# gpasswd (1)        - administer /etc/group and /etc/gshadow
# passwd (1)         - change user password
# passwd (5)         - password file

# ls 명령어의 매뉴얼 파일 위치를 확인하다
man -w ls
# /usr/share/man/man1/ls.1.gz

# 3번 섹션(라이브러리 함수)에서 printf 설명을 조회하다
man 3 printf
# PRINTF(3)                Linux Programmer's Manual                PRINTF(3)
# NAME
#        printf, fprintf, dprintf, sprintf, snprintf - formatted output conversion
# ...

4. 명령어 특이사항(유의사항)

• 매뉴얼 페이지는 기본적으로 1부터 9까지의 섹션으로 분류되다. 표준 명령어는 섹션 1, 시스템 콜은 섹션 2, 라이브러리 함수는 섹션 3에 배치되므로, 동일한 이름의 키워드를 조회할 때는 섹션 번호를 정확히 지정해야 의도한 매뉴얼을 볼 수 있다.
• 시스템에 새로 설치한 프로그램의 매뉴얼이 검색되지 않을 경우, mandb 명령어를 통해 매뉴얼 데이터베이스를 수동으로 갱신해야 할 수 있다.
• 환경 변수 MANPATH가 잘못 지정되어 있으면 시스템 표준 매뉴얼 경로를 인식하지 못하는 현상이 발생하다.

https://ioerror.tistory.com/entry/UNIX-Linux-Command-Reference

UNIX & Linux Command Reference