whatis(1)

이름
whatis - 메뉴얼 페이지 설명을 보여준다.

사용법
whatis [-dhV] [-r|-w ] [-m system[,...]] [-M path] name ...

설명
각각의 메뉴얼 페이지는 그것에 대해 짧은 설명을 가지고 있다. whatis 는 메뉴얼 페이지의 이름을 검색하여 특정 name 을 포함하고 있는 메뉴얼 페이지의 설명을 보여준다. name 은 와일드카드(wildcard) (-w) 를 포함하거나 정규식(regular expression) (-r) 일 수 있다. 이 옵션들을 사용하면서, 쉘이 특수 문자들을 해석하는 것을 막기 위해 name 을 인용하거나 에스케이프(escape)시켜야 할 수도 있다. 검색하는 동안 index 데이터베이스들이 사용된다. 해당 index 데이터베이스에서 예전 형식의 텍스트 whatis 데이터베이스를 만들기 위해서는 다음 명령을 사용하라. whatis -M manpath -w '*' | sort > manpath/whatis 여기에서 manpath 는 /usr/man 과 같이 메뉴얼 페이지의 계층 구조를 의미한다.

옵션

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

-r, --regex
    각각의 name 을 정규식으로 해석한다. 이때 name 정규식이 페이지 이름의 일부분과 맞는 메뉴얼 페이지에 대해 검색이 이루어진다. 이 옵션을 사용하면 데이터베이스 검색의 특성 때문에 whatis 동작이 조금 느려지게 될 것이다.

-w, --wildcard
    각각의 name 이 쉘 형식 와일드카드를 포함하는 패턴으로 해석된다. 검색이 이루어지기 위해서는 확장된 name 이 전체 페이지 이름과 맞아야만 한다. 이 옵션을 사용하면 데이터베이스 검색의 특성 때문에 whatis 동작이 조금 느려지게 될 것이다.

-m system [,...], --systems=system [,...]
    이 시스템에서 다른 운영체제의 메뉴얼 페이지 이름들에 접근할 수 있다면, 이 옵션을 사용해서 검색할 수 있다. 만약 NewOS의 메뉴얼 페이지 이름을 검색하고 싶다면, -m NewOS 옵션을 사용하면 된다. system 은 여러 운영체제의 이름을 쉼표(comma)로 구분하여 조합할 수 있다. 검색하는데 원래 운영체제의 메뉴얼 페이지 이름을 포함하고 싶다면, system 에 man 을 추가하면 된다. 이 옵션은 $SYSTEM 환경 변수에 우선한다.

-M path, --manpath=path
    기본 경로 외에 검색할 메뉴얼 페이지 경로를 콜론(:)으로 구분해서 설정한다. 기본적으로 apropos 는 $MANPATH 환경 변수를 사용한다. 만약 이 환경 변수가 설정되지 않았다면, $PATH 환경 변수를 기반으로 적절한 경로를 찾아낼 것이다. 이 옵션은 $MANPATH 환경 변수의 값에 우선한다.

-h, --help
    도움말을 출력하고 종료한다.

-V, --version
    버전과 저자 정보를 출력한다.

종료 코드

0   정상적인 종료.

1   사용법, 문법 혹은 설정 파일 오류.

2   조작상 오류.

16  주어진 값과 맞는 메뉴얼 페이지를 찾을 수 없을 때.

환경

SYSTEM
    $SYSTEM 이 설정되어 있으면, 이것은 -m 옵션으로 다른 운영체제를 지정해주는 것과 같은 효과를 나타낸다.

MANPATH
    $MANPATH 가 설정되어 있으면, 이 값은 콜론(:)으로 구분된 메뉴얼 페이지 구조의 경로로 해석된다.

파일

/usr/share/man/index.(bt|db|dir|pag)
    기본적인 index 데이터베이스 캐쉬.

/var/cache/man/index.(bt|db|dir|pag)
    부가적인 index 데이터베이스 캐쉬.

/usr/share/man/.../whatis
    기본적인 whatis 텍스트 테이터베이스.

관련 항목
apropos(1), man(1).

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

번역
한글 Manpage 프로젝트 (http://man.kldp.org), 2004년 3월 8일