[manpage] manpage만들기

manpage파일은 매크로로 작성하게된다.

몇 가지 매크로를 알아보자.

.TH : 타이틀명

사용형식 -> .TH 이름 섹션넘버 [날짜[버전]]

.SH : 세션이름

사용형식 -> .SH 세션이름

.SS : 서브세션

사용형식 -> .SH아래 .SS 서스세션이름

.R : 기본 글꼴 (Roman)

사용형식 -> .R 내용

.B : 굵은 글꼴 (Bold)

사용형식 -> .B 내용

.I : 기울인 글꼴 (Italic) - 터미널 따라 기울임 대신 밑줄이 될 수 있다.

사용형식 -> .I 내용

.IP : * 기호와 같은 것을 통해 여러 문장을 나열할 때

사용형식 -> .IP [기호]

문단

.HP : 앞 문단과 내용 상 이어지지는 않지만 동일한 들여쓰기를 유지하고 싶을 때 사용

사용형식 -> .HP

문단

.PP : 앞에서 적용한 들여쓰기를 원래 값으로 되돌리기 위해 사용한다.

사용형식 -> .PP

작성하는 방법은 간단한것 밖에 모른다.

예

파일명은 "검색할 문자열.(세션번호)"로 만든다.

파일명) getphname.1

.TH GETNAME 1 "November 3,2012" "version 0.1" "유저 명령"

.SH NAME

getphname, getphphone, adddata, deldata

.SH SYNOPSIS

.SS HEADER

#include "phbook.h"

.SS FUNCTIONS

.B extern struct pinfo getphname(const char *_name)

- 이름으로 검색하여 레코드에 있는 데이터를 반환한다.

.B extern struct pinfo getphphone(const char *_phone)

- 전화번호로 검색하여 레코드에 있는 데이터를 반환한다.

.B int adddata(char *name, char *phone)

- 이름과 전화번호를 저장한다.

.B int deldata(char *name, char *phone)

- 이름이나 전화번호를 받아 해당 레코드를 삭제한다.

이러한 파일을 작성하고, 이파일을 manpath에 있는 디렉터리로 옮겨야한다.

$manpath

를 입력하면,

/usr/local/share/man, /usr/share/man

2개의 path가 나올것이다. 앞의 path는 정확히 기억나지 않고, 안에는 비어있는 디렉터리이다.

위치시킬 디렉터리는 /usr/share/man이다.

$ls /usr/share/man

을 입력하면 다양한 디렉터리가 보이고, 그중에 눈에 띄는 디렉터리들이 있다.

man1 man1p등..

manpage 1세션에 등록할것이므로,

$mv getphname.1 /usr/share/man/man1/getphname.1

mv명령을 통해 해당경로로 이동시킨다.

자 이제 manpage를 검색해보자.

$man getphname

을 입력하면 작성된 manpage파일에 따라 내용이 보여질 것 이다.

잘못된부분, 수정할 부분, 추가할 내용이 있다면,

조언 부탁드립니다.

감사합니다.