WHATIS(1)

이름
whatis - 설명서 페이지 설명 한 줄을 표시합니다

개요
whatis [-dlv?V] [-r|-w] [-s 목록] [-m 시스템[,...]] [-M 경로] [-L 로캘] [-C 파일] 이름 ...

설명
각 설명서 페이지에는 간단한 설명이 들어있습니다. whatis는 설명서 페이지 이름을 검색하며, 이름과 일치하는 설명서 페이지 설명 부분을 출력합니다. 이름에는 와일드카드(-w)가 들어가거나 정규 표현식-r)이 들어갑니다. 이 옵션을 활용하면, 이름을 따옴표로 둘러쌓거나 특수 문자를 이스케이핑(\) 처리하여 셸에서 해석하거나 실행하지 못하게 막아야 합니다. 색인 데이터베이스는 검색시 활용하며, mandb 프로그램에서 업데이트합니다. 설치 상태에 따라 크론 작업으로 주기적으로 실행하거나 새 설명서 페이지를 설치한 후 직접 실행해야 합니다. 상대 색인 데이터베이스에서 구세대 방식 whatis 데이터베이스를 만들려면, 다음 명령을 실행합니다: whatis -M 맨_페이지_경로 -w '*' | sort > 맨_페이지_경로/WHATIS 맨페이지경로는 /usr/man과 같은 설명서 페이지 계층입니다.

옵션

-d, --debug
    디버깅 정보를 출력합니다.

-v, --verbose
    경고 메시지를 자세하게 출력합니다.

-r, --regex
    각 이름을 정규 표현식으로 해석합니다. 이름이 페이지 이름 일부와 일치하면, 일치 항목으로 간주합니다. 이 옵션은 whatis의 데이터베이스 검색 방식으로 인해 조금 느리게할 수 있습니다.

-w, --wildcard
    각 이름을 셸 방식 와일드카드 문자가 들어간 패턴으로 해석합니다. 일치 항목이 되려면, 확장 이름이 전체 페이지 이름과 일치해야 합니다. 이 옵션은 whatis의 데이터베이스 검색 방식으로 인해 조금 느리게할 수 있습니다.

-l, --long
    터미널 폭에 맞춰 출력을 자르지 않습니다. 보통, 정돈이 제대로 안된 NAME 섹션의 깔끔하지 못한 출력을 다듬을 목적으로 터미널 폭으로 자릅니다.

-s 목록, --sections=목록, --section=목록
    주어진 설명서 섹션에 대해서만 검색합니다. 목록은 콜론 또는 쉼표로 구분한 섹션 목록입니다. 목록의 항목이 "3"과 같은 단순 섹션이라면, "3", "3perl", "3x" 과 같은 식으로 설명 목록이 페이지에 들어갑니다. 목록에 들어간 항목이 "3perl" 과 같은 확장자일 경우, 설명서 섹션의 정확한 페이지 부분만 목록에 들어갑니다.

-m 시스템[,...], --systems=시스템[,...]
    시스템에서 다른 운영 체제의 설명서 페이지 이름에 접근할 수 있다면, 이 옵션으로 접근할 수 있습니다. NewOS의 설명서 페이지 이름을 검색하려면 -m NewOS 옵션을 사용하십시오. 시스템에는 쉼표로 구분한 여러 운영체제 이름을 지정할 수 있습니다. 자체 운영체제 설명서 페이지 이름의 검색 대상을 넣으려면 시스템 이름 man을 인자 문자열에 반드시 넣어야합니다. 이 옵션은 $SYSTEM 환경 변수를 대체합니다.

-M 경로, --manpath=경로
    콜론으로 구분한 검색 대상 설명서 페이지 계층을 대신 지정합니다. 기본적으로 whatis은 $MANPATH 환경 변수가 비어있거나 설정하지 않는 한 이를 활용하는데, 비어 있거나 설정하지 않았을 경우에는 $PATH 환경 변수를 기반으로 적절한 맨 페이지 경로를 지정합니다. 이 옵션은 $MANPATH 내용을 대신합니다.

-L 로캘, --locale=로캘
    whatis은 보통 $LC_MESSAGES와 $LANG 같은 다양한 환경 변수를 조사하는 C 함수 setlocale(3)을 호출하여 현재 로캘을 결정합니다. 결정한 값을 임시로 대체 적용하려면 로캘 문자열을 바로 whatis에 전달하는 이 옵션을 사용하십시오. 참고로 페이지가 실제로 시작하는 부분을 검색하기 전까지는 아무런 영향을 주지 않습니다. 도움말 메시지와 같은 출력 결과는 항상 로캘을 초기에 결정한 다음 나타납니다.

-C 파일, --config-file=파일
    ~/.manpath 기본값 대신 사용자 설정 파일을 활용합니다.

-?, --help
    도움말 메시지를 출력하고 나갑니다.

--usage
    간단한 사용법 메시지를 출력하고 나갑니다.

-V, --version
    버전 정보를 출력합니다.

종료 상태

0   프로그램 실행 성공.

1   사용법, 문법, 구성 파일 오류.

2   처리 오류.

16  지정한 단어에 일치하는 요소를 찾지 못했습니다.

환경

SYSTEM
    $SYSTEM을 설정했다면, -m 옵션의 인자 지정과 같이 동작합니다.

MANPATH
    $MANPATH를 설정했다면, 콜론으로 구분한 설명서 페이지 검색 경로로 값을 해석합니다. 환경 변수 처리 방식의 기본 동작 및 자세한 내용은 manpath(5)의 검색 경로 섹션을 살펴보십시오.

MANWIDTH
    $MANWIDTH를 설정하면, 이 값을 터미널 폭으로 사용합니다(--long 옵션 참조). 이 값을 설정하지 않으면 터미널 폭을 $COLUMNS 값으로 계산하며, 가능하다면 ioctl(2) 값을 활용합니다. 앞서 두가지 방식의 처리에 실패하면 80문자 폭으로 대체합니다.

파일

/usr/share/man/index.(bt|db|dir|pag)
    전통 전역 색인 데이터베이스 캐시입니다.

/var/cache/man/index.(bt|db|dir|pag)
    FHS 준수 전역 색인 데이터베이스 캐시입니다.

/usr/share/man/.../whatis
    전통 WHATIS 텍스트 데이터베이스입니다.

추가 참조
apropos(1), man(1), mandb(8)

저작자
Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

버그
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db