WindyHana's Solanara: MAN 페이지

Category: 솔라리스
Description: MAN 페이지에 대해 설명
Update: 2010-02-04
You can found last updated documents at http://www.solanara.net/
@solanara(solanara on Twitter)
Sorry, for Korean only.

개요

유닉스 시스템은 [맨페이지(man pages)]라는 참조 매뉴얼 페이지(reference manual pages)가 있다. 쉽게 말해 도움말이다. 유닉스 커맨드 뿐만 아니라 유닉스 전반을 모두 다루고 있고, 별도의 문서를 보지 않고 맨페이지만 봐도 내용을 모두 알 수 있도록 방대한 내용을 다루고 있다.
R.T.F.M.(Read The F***ing Manual) 에서 M이 의미하는게 매뉴얼이고 참조 매뉴얼을 말하기도 하며, 결국 맨 페이지를 의미하기도 한다.
맨페이지는 전체 컨텐츠를 섹션(section)으로 구분하고 있다. 각 섹션은 각각의 주제에 맞는 맨 페이지를 가지고 있으며, 섹션에 맞는 주제에 대해 설명하기 때문에 같은 맨 페이지 이름이라도 내용이 다르다. 예를 들어 unlink(1m), unlink(2), unlink(3f) 처럼 말이다. 아래는 솔라리스에서 사용하는 섹션 이름과 간략한 섹션 설명이다.
- 섹션 1: 사용자 명령
- 섹션 1M: 시스템 관리자 명령
- 섹션 2: 시스템 콜
- 섹션 3: 라이브러리 및 헤더
- 섹션 4: 파일 형식(File Formats)
- 섹션 5: 표준, 환경, 매크로(Standards, Environments, and Macros)
- 섹션 6: 데모, 게임, 스크린세이버
- 섹션 7: 장치 및 네트워크 인터페이스
- 섹션 9: DDI(Device Driver Interface) 와 DKI(Driver Kernel Interface)
※ 각 섹션에 대한 설명은 intro(1) intro(2) intro(3) intro(4) intro(5) ... 에 있다. 또한 3C와 같이 뒤에 단어를 더 붙여 더 자세하게 섹션을 분류하고 있다.
※ 1M 섹션을 특별히 표기한건, 이 섹션이 다른 운영체제에서는 보통 섹션 8에 포함되기 때문이다. 솔라리스는 어드민 명령에 1M을 사용하며 8번 섹션에 mkisofs 명령 단 한개만 존재한다. 솔라리스 관련 문서에는 섹션 8이 없는 것으로 나온다.
참고
- Using Man Pages in the Solaris OS
- Solaris 10 Reference Manual Collection - Sun Microsystems

맨 페이지 관련 명령

man

[참조 매뉴얼 페이지], 즉 맨 페이지를 찾고 보여준다.

기본적인 사용 방법

[man 찾을이름]을 입력하면 찾고자 하는 맨페이지를 보여준다. 볼 때 사용할 수 있는 키는 more 에서 사용되는 키와 같다. 사용 가능한 키에 대해서는 자세한 내용은 다음 섹션에서 설명한다.

root@wl ~ # man standards
페이지를 다시 포맷 중입니다.  기다려 주십시오... 완료

Standards, Environments, and Macros                  standards(5)

NAME
     standards, ANSI, C, C++, ISO, POSIX, POSIX.1, POSIX.2,  SUS,
     SUSv2, SUSv3, SVID, SVID3, XNS, XNS4, XNS5, XPG, XPG3, XPG4,
     XPG4v2 - standards and specifications supported by Solaris

DESCRIPTION
     Solaris 10 supports IEEE Std 1003.1  and  IEEE  Std  1003.2,
     commonly  known  as  POSIX.1  and POSIX.2, respectively. The
     following table lists each version of these standards with a
     brief  description  and  the  SunOS  or Solaris release that
     first conformed to it.

     POSIX Standard              Description                Release
     ________________________________________________________________
     POSIX.1-1988     system interfaces and headers       SunOS 4.1
     ________________________________________________________________
     POSIX.1-1990     POSIX.1-1988 update                 Solaris 2.0
     ________________________________________________________________
     POSIX.1b-1993    realtime extensions                 Solaris 2.4
     ________________________________________________________________
     POSIX.1c-1996    threads extensions                  Solaris 2.6
     ________________________________________________________________
     POSIX.2-1992     shell and utilities                 Solaris 2.5
     ________________________________________________________________
     POSIX.2a-1992    interactive shell and utilities     Solaris 2.5
     ________________________________________________________________
     POSIX.1-2001     POSIX.1-1990,      POSIX.1b-1993,   Solaris 10
                      POSIX.1c-1996,  POSIX.2-1992, and
                      POSIX.2a-1992 updates

     Solaris 10 also  supports  the  X/Open  Common  Applications
     Environment (CAE) Portability Guide Issue 3 (XPG3) and Issue
     4 (XPG4); Single UNIX  Specification  (SUS,  also  known  as
     XPG4v2);  Single  UNIX Specification, Version 2 (SUSv2); and
     Single UNIX Specification, Version 3 (SUSv3). Both XPG4  and
     SUS  include  Networking  Services  Issue  4  (XNS4).  SUSv2
     includes Networking Services Issue 5 (XNS5).
...
q
root@wl ~ #

페이지 보기시 사용 가능한 키

기본적으로 [more -s] 명령에서 사용할 수 있는 키와 같다. 자세한건 more(1)을 참고하자.

스페이스바  ▷ 다음 페이지로 스크롤
/정규표현식 ▷ 정규표현식을 찾음
b           ▷ 이전 페이지로 스크롤
f           ▷ 다음 페이지로 스크롤
q           ▷ 종료
h           ▷ 도움말(사용가능한 커맨드 보임)

사용예
- 특정 섹션을 지정해 맨 페이지 보기
```
root@wl ~ # man intro
...
root@wl ~ # man -s 5 intro 1)
...
root@wl ~ # man intro.5 2)
...
root@wl ~ # 
```
  1) intro 라는 키워드는 각 섹션마다 존재하며, 섹션 검색 순서에 따라 먼저 검색된 맨 페이지를 보여준다. 따라서 섹션 1에 대한 intro 맨 페이지가 보여질 것이다. 다른 섹션을 보려면 섹션 이름을 [-s]인자를 통해 전해야 한다.
  2) 공식적인건 아니지만, man 페이지의 파일 이름을 명시해도 된다. 섹션 5의 intro 가 출력된다. 솔라리스만 가능한 것으로 알고 있다.
- 특정 디렉토리 안의 맨 페이지 보기
```
root@wl ~ # man xhost
xhost에 대한 설명서 항목이 없습니다.
root@wl ~ # man -M /usr/openwin/share/man xhost 1)
페이지를 다시 포맷 중입니다.  기다려 주십시오... 완료

X Version 11                                             XHOST(1)

NAME
     xhost - server access control program for X
...
root@wl ~ #
```
  1) xhost 는 openwin 의 명령어로 솔라리스에서 사용 가능하지만, 맨페이지는 검색되지 않는다. man 은 별도의 설정을 하지 않는한 (하단의 MANPATH 환경변수 참조) /usr/share/man 아래의 디렉토리만 검색하기 때문이다. 따라서 xhost 맨 페이지가 없는 것으로 나온다. [-M] 옵션을 통해 디렉토리를 지정하면 맨 페이지를 볼 수 있다.
- 맨 페이지 파일 보기
```
root@wl /usr/openwin/share/man # nroff -man xhost.1 | more -s
...
```
  man 으로는 볼 수 없고 위와 같이 nroff 와 more 를 이용 해야 한다. 위 명령은 man 에서 처리하는 방법과 유사하다.
- MAN 페이지를 텍스트로
```
root@wl ~ # man pipe.2 | col -x -b
```
  텍스트로 전환하는 방법은 많지만 col 명령어를 사용하는 방법도 있어 소개한다. (man(1)에 설명되어있다)
- 검색
  [-f]옵션과 [-k]으로 검색이 가능하다. 자세한 사항은 문서 하단의 whatis 와 apropos 를 참조한다.
환경변수
man 명령을 사용할 때 중요한 환경변수에 대해 설명한다. MANPATH는 꼭 알아두어야 한다.
- MANPATH: 맨페이지 파일이 있는 디렉토리 이름. 콜론(:)으로 구분된 디렉토리명을 입력한다. 기본값은 [/usr/share/man]이며 MANPATH가 세팅되어있으면 그 값을 사용한다. 아울러 /usr/share/man/man.cf 파일에 나오는 섹션 순서대로 주어진 이름을 찾는다. 커맨드에서 -M이나 -s옵션을 사용해 이 값을 임시로 변경할 수 있다.
- PAGER: 페이징 파일. 기본값은 [more -s]
- TCAT: troffed 매뉴얼 페이지를 디스플레이할 프로그램
- TROFF: -t 플래그를 줬을때 사용할 troff형식의 파일 포매터(formatter).

whatis

키워드에 대한 한줄 개요를 표시. [man -f] 와 같다.

root@wl ~ # man -f smf
smf             smf (5)         - service management facility
root@wl ~ # whatis smf
smf             smf (5)         - service management facility

1) 만약 /usr/share/man/windex 를 찾을 수 없다는 메시지가 나오면 [/usr/bin/catman -w]명령을 실행해 해결할 수 있다. catman에 대해서는 문서 하단의 내용을 참조하자.

apropos

주어진 키워드가 들어있는 페이지를 가진 맨 페이지 키워드를 검색해 출력. [man -k]와 같다.

root@wldev ~ # man -k smf
inetconv        inetconv (1m)   - convert inetd\&.conf entries into smf service manifests, import them into smf repository
ksslcfg         ksslcfg (1m)    - enable and configure SMF instance of Kernel SSL
smf             smf (5)         - service management facility
...
root@wldev ~ # apropos smf
inetconv        inetconv (1m)   - convert inetd\&.conf entries into smf service manifests, import them into smf repository
ksslcfg         ksslcfg (1m)    - enable and configure SMF instance of Kernel SSL
smf             smf (5)         - service management facility
...

catman

맨 페이지에 대해 형식화된 파일을 생성한다. 주로 -w 를 사용해 windex 파일을 만들거나 갱신할때 사용한다.
프로그램을 실행시켰을때 /usr/share/man/windex: No such file or directory 라는 메시지가 나오면 아래와 같이 실행한다.
```
root@wl ~ # /usr/bin/catman -w
```

MAN 페이지 생성

MAN페이지의 작성 방법에 대해 설명한다. 작성 방법은 man(5)에 설명되어있다.
MAN페이지 작성은 아래와 같이 두 단계로 이루어진다.
1. 텍스트 파일 작성
2. MAN페이지로 변환
텍스트 파일 작성
일단 man페이지에 들어갈 텍스트 파일을 작성해야 한다. 텍스트파일은 NROFF에 의해 해석되며 NROFF명령에 맞춰 작성해야 한다. MAN페이지에 흔히 사용되는 명령은 아래와 같다. 자세한 사항은 nroff를 참고하자.
- .\" 텍스트
  코멘트를 적을 수 있다.
- .TH 타이틀 섹션명
  타이틀을 적을 수 있다. 섹션명은 MAN페이지의 섹션명이다.
- .SH 텍스트
  섹션이름을 적을 수 있다. NAME, SYNOPSIS, DESCRIPTION, OPTIONS, RETURN VALUES, EXIT STATUS, FILES, SEE ALSO, DIAGNOSTICS, BUGS 가 일반적인 섹션 명이다.
- .P
  새로운 문단을 적을 수 있다.
- .I 텍스트
  텍스트를 기울여 쓴다.
- .B 텍스트
  텍스트를 굵게 쓴다.
mansample.txt
다운로드
```
.\" This is a comment.
.TH MANSAMPLE 1 "2010-01" "SunOS 5.10" "User Manual"
.SH NAME
mansample \- mansample script
.SH SYNOPSIS
.B mansample
.SH DESCRIPTION
.B mansample
is textfile for generating sample man pages. You can refer to
.BR man(5)
man pages.
.SH "SEE ALSO"
.BR man(5)
.SH AUTHOR
WindyHana <windyhana@solanara.net>
```

MAN페이지로 변환

root@wl ~ # mkdir man1
root@wl ~ # cd man1
root@wl ~/man1 # nroff -man mansample.txt > mansample.1
root@wl ~/man1 # cd ..
root@wl ~ # man -M `pwd` mansample
페이지를 다시 포맷 중입니다.  기다려 주십시오... 완료

User Manual                                          MANSAMPLE(1)

NAME
     mansample - mansample script

SYNOPSIS
     mansample

DESCRIPTION
     mansample is textfile for generating sample man  pages.  You
     can refer to man(5) man pages.

SEE ALSO
     man(5)

AUTHOR
     WindyHana <windyhana@solanara.net>

SunOS 5.10            Last change: 2010-01                      1

root@wl ~ #