GROFF_MAN(7)

명칭
groff_man - 메뉴얼 페이지 생성 서포트용 groff `man'매크로

서식
groff -man [ options... ] [ files... ]
groff -m man [ options... ] [ files... ]

해설
groff 그리고 메뉴얼 페이지를 생성하는데 사용된다 man 매크로는, James Clark 가 썼습니다. 이 문서는, 패키지중의 각 매크로의 사용법을, 짧게 집계한 것입니다.

옵션
man 매크로는, 다음과 같은 명령행 옵션을 이해합니다 (레지스터를 몇개인가 정의합니다).

-rcR=1
    본옵션 (nroff 모드에서는 디폴트)은, 복수 페이지대신에, 긴 단일 페이지를 출력합니다. 무효로 하려면 , -rcR=0 (으)로서 주세요.

-rC1
    명령행에 복수의 메뉴얼 페이지를 주었을 경우, 각각의 페이지 번호가 1 으로부터 시작되는 것이 아니라, 연속한 번호에 됩니다.

-rD1
    양면 인자로 합니다. 짝수 페이지와 홀수 페이지의 footer는, 다른 정형이 이루어집니다.

-rPnnn
    페이지의 세어 초를 1 은 아니고 nnn (으)로부터로 합니다.

-rSxx
    베이스드큐먼트폰트사이즈를 10 포인트는 아니고 xx 포인트로 합니다 (xx 에는 10, 11, 12 중 한쪽이 사용할 수 있습니다).

-rXnnn
    페이지 nnn 의 후의 페이지를 nnna, nnnb, nnnc 등과 같이 셉니다. 예를 들면, `-rX2'라고 하는 옵션의 경우, 페이지를 1, 2, 2a, 2b, 2c 와 같이 할당합니다.

사용법
이 섹션은, 메뉴얼 페이지용으로 사용 가능한 매크로에 대해 말하고 있습니다. 한층 더 커스터마이즈 하고 싶은 경우는, man.local 파일중에 추가의 매크로 및 리퀘스트를 두어 주세요. 이 파일은 man 의 직후에 로드 됩니다.

.TH title section [extra1] [extra2] [extra3]
    이 메뉴얼 페이지의 타이틀을 title 에, 섹션을 section (으)로 설정합니다. 섹션은, 1 에서 8 까지의 값을 받지 않으면 안됩니다. section 값에는, 뒤로 캐릭터 라인을 둘 수도 있습니다. 예를 들면, `.pm'로 하면(자), 메뉴얼 페이지의 특정의 서브 섹션을 가리킵니다. title (와)과 section (은)는 ,함께 헤더행의 좌단과 우단에 놓여집니다 (괄호로 묶어졌다 section 하지만 title 의 직후를 뒤따릅니다). extra1 (은)는, footer행의 중앙에 놓여집니다. extra2 (은)는, footer행의 왼쪽으로 놓여집니다 (양면 인자가 액티브하게 되어 있는 경우, 짝수 페이지에는 왼쪽으로, 홀수 페이지에는 오른쪽으로, 놓여집니다). extra3 (은)는 헤더행의 중앙에 놓여집니다.

    HTML 출력용으로는, 헤더 및 footer는 완전하게 제거됩니다.

    게다가 이 매크로는 개페이지 합니다. 새로운 행 번호는, 재차 1 에 됩니다 (명령행으로 `-rC1'옵션이 지정되어 있는 경우를 제외합니다). 이 기능은, 복수의 메뉴얼 페이지를 정형한다 경우 (을) 위해서만 있습니다. 메뉴얼 페이지가 1 개의 경우, TH (은)는, 파일의 선두에 있어, 확실히 1 개(살)만 존재해야 합니다.

.SH [text for a heading]
    번호 짓고를 하지 않는 섹션용의 표제를 설정합니다. 이것은 왼쪽 채우기가 됩니다. SH 에 계속된 텍스트 ( SH 에 인수가 없는 경우는 다음의 행의 텍스트)는, 줄 끝까지의 것이 모두 볼드체로, 그리고 베이스드큐먼트사이즈보다 1 만 큰 font size로 표시됩니다. 게다가 텍스트의 좌측의 margin는 기본값에 되돌려집니다.

.SS [text for a heading]
    번호 짓고 하지 않는 섹션의 2 번째의 표제를 설정합니다. SS 에 계속된 텍스트 ( SS 에 인수가 없는 경우는 다음의 행의 텍스트)는, 줄 끝까지의 것이 모두 볼드체로, 그리고 베이스드큐먼트사이즈와 같은 크기의 폰트로 표시됩니다. 게다가 텍스트의 좌측의 margin는 기본값에 되돌려집니다.

.TP [nnn]
    인덴트 된, label포함의 단락을 설정합니다. 인덴트폭은, 인수가 주어지고 있으면 nnn (으)로 설정됩니다 (생략 되고 있으면, 디폴트의 단위는 `n'입니다). 인수가 주어지지 않으면, 인덴트폭은 기본값로 설정됩니다. 이 매크로의 뒤에 계속된 텍스트의 1 행 째는, 왼쪽 채워에 표시하는 캐릭터 라인으로서 해석되어 label로서 사용하는데 적절한 것이 됩니다. 이것은 단락의 일부이다고는 해석은 되지 않으므로, 계속하는 입력행의 텍스트로 1 행 째를 채우려고는 하지 않습니다. 그런데도, label가 인덴트폭(정도)만큼 넓어지지 않은 경우에는, 같은 행으로부터 단락이 시작되어 (다만, 인덴트는 됩니다), 다음의 행으로 계속되어 갑니다. label가 인덴트폭보다 넓은 경우는, 단락의 설명 부분은 label의 다음의 행으로부터 시작되어, 모두 인덴트 됩니다. label의 폰트의 형태도 사이즈도 기본값에는 설정되지 않는다 일로 주의해 주세요. 이것에 대해서, 나머지의 텍스트는 디폴트의 폰트 설정이 됩니다. TP 매크로는, 당신이 지금 막 읽고 있는 이 해설에 사용되고 있다 매크로입니다.

.LP
.PP
. P
    이러한 매크로는, 공통의 별명입니다. 이러한 우리 어떤 것을 사용해도 현재의 위치에서 행을 중지합니다. 그리고, 그 후에 PD 매크로로 지정한 양만 수직 방향으로 스페이스를 둡니다. 폰트의 사이즈 및 형태는 기본값에 되돌려집니다 (10pt 낭만체). 마지막으로, 현재의 좌측의 margin의 양을 복원합니다.

.IP [designator] [nnn]
    인덴트 된 단락을 설정합니다. 그 때, designator (을)를 단락의 시작에 표를 붙이기 위한 태그로서 사용합니다. 인덴트폭은, 인수가 주어지고 있는 경우는 nnn (으)로 설정됩니다 (디폴트의 단위는 `n'입니다). 인수가 주어지지 않은 경우는, 디폴트의 인덴트폭이 사용됩니다. 이 단락 (다만, 지시자 (designator)를 포함하지 않고)의 font size 및 페이스는 기본값에 되돌려집니다. 특정의 인덴트를 하지만 지시자를 붙이지 않는 단락을 개시하려면 , 제 2 인수에 `""' (더블 쿼트 2 개(살))를 사용해 주세요.

    예를 들면 다음의 단락은, `.IP \(bu 4'를 이용해, 모두 지시자로서 중점을 붙여 설정됩니다:

    •   IP (은)는, 리스트를 정형하기 위해서 man 그리고 사용되는 3 개의 매크로 중 1 개입니다.

    •   HP (은)는, 또 다른 매크로입니다. 이 매크로는, 좌측으로 매달고 인덴트 된 단락을 생성합니다.

    •   TP (은)는, 또 다른 매크로입니다. 이 매크로는, 인덴트 되지 않는 label를 생성해, 그 후에 인덴트 된 단락이 계속됩니다.

.HP [nnn]
    좌측으로 매달고 인덴트 된 단락을 설정합니다. 인수가 주어지고 있는 경우, 인덴트폭은 nnn (으)로 설정됩니다 (디폴트의 단위는 `n'입니다). 인수가 주어지지 않은 경우, 디폴트의 인덴트폭이 사용됩니다. font size 및 페이스는 기본값에 되돌려집니다. 다음의 단락은, 인덴트폭을 4 로 설정되어 있을 때의 이 매크로의 효과를 나타낸 것입니다:

    이 단락은, HP 매크로를 실행한 뒤의 단락입니다. 본 대로, 이 매크로는, 최초의 행을 제외한 행 모든 것이 인덴트 된 단락을 생성하고 있습니다.

.RS [nnn]
    이 매크로는, 값이 주어지고 있으면 (디폴트 단위는 `n'입니다) 그 값만 좌측의 margin를 오른쪽으로 이동합니다. 값이 주어지지 않으면, 디폴트의 인덴트폭이 사용됩니다. RS 매크로의 호출은 상자로 할 수 있습니다.

.RE [nnn]
    이 매크로는, 좌측의 margin를 nnn 레벨까지 되돌립니다. 인수가 주어지지 않으면, 이 매크로는 레벨을 1 개만 되돌립니다. 제 1 레벨 (즉, 아직 RS (을)를 호출하지 않았다)는 번호 1 을 가지고 있어 RS 매크로를 호출할 때 마다 레벨이 1 두개증가합니다.

정리하면(자), 다음의 매크로는, 수직 방향으로 스페이스를 들어갈 수 있었다 행의 반환을 실시합니다 (스페이스의 양은 PD 매크로를 사용한다고 변경할 수 있습니다): SH, SS, TP, LP (PP, P), IP, HP 매크로 RS 및 RE 도 행을 되풀이합니다만, 수직 방향으로 스페이스를 들어갈 수 있습니다.

폰트를 설정하기 위한 매크로
표준 폰트는 낭만체입니다. 그리고, 디폴트의 텍스트 사이즈는 10 포인트입니다.

.SM [text]
    같은 행에 있는 텍스트 혹은 다음의 행에 있는 텍스트가, 디폴트의 폰트보다 1 포인트만 작은 폰트로 표시되게 됩니다.

.SB [text]
    같은 행에 있는 텍스트 혹은 다음의 행에 있는 텍스트가, 볼드체의 폰트로, 그리고 디폴트의 폰트보다 1 포인트만 작은 폰트로 표시되게 됩니다.

.BI text
    같은 행에 있는 텍스트가, 볼드체와 이탤릭체를 교대로 사용해 표시되게 됩니다. 텍스트는 매크로 호출과 같은 행에 있는 것이 필요합니다. 따라서,

        .BI this "word and" that

    그렇다고 하는 행은, `this'와 `that'가 볼드체로 표시되어 그에 대한 `word and'의 부분은 이탤릭체로 표시됩니다.

.IB text
    텍스트가, 이탤릭체와 볼드체를 교대로 사용해 표시되게 됩니다. 텍스트는 매크로 호출과 같은 행에 있는 것이 필요합니다.

.RI text
    매크로 호출과 같은 행에 있는 텍스트가, 낭만체와 이탤릭체를 교대로 사용해 표시되게 됩니다. 텍스트는, 매크로 호출과 같은 행에 있는 것이 필요합니다.

.IR text
    매크로 호출과 같은 행에 있는 텍스트가, 이탤릭체와 낭만체를 교대로 사용해 표시되게 됩니다. 텍스트는, 매크로 호출과 같은 행에 있는 것이 필요합니다.

.BR text
    매크로 호출과 같은 행에 있는 텍스트가, 볼드체와 낭만체를 교대로 사용해 표시되게 됩니다. 텍스트는, 매크로 호출과 같은 행에 있는 것이 필요합니다.

.RB text
    매크로 호출과 같은 행에 있는 텍스트가, 낭만체와 볼드체를 교대로 사용해 표시되게 됩니다. 텍스트는, 매크로 호출과 같은 행에 있는 것이 필요합니다.

. R [text]
    text 하지만 낭만체 폰트로 표시되게 됩니다. 매크로가 불려 간 행에 텍스트가 없는 경우는, 다음의 행의 텍스트가 낭만체로 표시됩니다. 이것이, 다른 매크로를 다 처리했을 때에 돌려주어지는 텍스트의 디폴트의 폰트입니다.

. B [text]
    text 하지만 볼드체로 표시되게 됩니다. 매크로가 불려 간 행에 텍스트가 없는 경우는, 다음의 행의 텍스트가 볼드체로 표시됩니다.

. I [text]
    text 하지만 이탤릭체로 표시되게 됩니다. 매크로가 불려 간 행에 텍스트가 없는 경우는, 다음의 행의 텍스트가 이탤릭체로 표시됩니다.

그 외
grohtml (을)를 제외한 출력 디바이스용의 인덴트폭은 모두 7.2n 입니다. grohtml 의 경우는 인덴트를 무시합니다.

.DT 0.5 인치 마다 탭을 설정합니다. 이 매크로는 항상 TH 리퀘스트중에서 불리기 (위해)때문에, 탭 위치가 변경되었을 경우에 한해서 호출하는 것에는 의미가 있습니다.

.PD [nnn]
    새로운 단락 (섹션)의 전의 스페이스를 조정합니다. 옵션의 인수는, 스페이스의 양을 줍니다 (디폴트의 단위는 `v'). 파라미터 없음의 경우, 이 값은 기본값에 되돌려집니다 (tty 디바이스에서는 1 행으로, 그 이외에서는 0.4v). 이 리퀘스트는, SH, SS, TP, LP (각각 PP 및 P), IP, HP 매크로에 영향을 줍니다.

다음의 캐릭터 라인이 정의되고 있습니다:

\*S 디폴트의 font size에 되돌립니다.

\*R 「등록」마크입니다.

\*(Tm
    「상표」마크입니다.

\*(lq
\*(rq
    왼쪽 및 오른쪽 쿼트입니다. 이것은, 각각 `\(lq'와 `\(rq'와 같습니다.

tbl 혹은 eqn (와)과 같은 프리프로세서가 필요한 경우, 메뉴얼 페이지의 1 행 째를 다음과 같이 보이도록(듯이) 하는 예가 됩니다:

    .\" word

더블 쿼트의 뒤에는 공백 캐릭터 1 개(살)이 들어가는 것에 주의해 주세요. word (은)는, 필요한 프리프로세서를 나타내는 캐릭터로 성립되고 있습니다. `e'는 eqn (을)를 나타내, `r'는 refer (을)를, 그리고 `t'는 tbl (을)를 나타냅니다. 최근의 man 프로그램의 실장에서는, 이 1 행 째를 읽어 자동적으로 올바르다 프리프로세서를 호출합니다.

관련 파일

man.tmac
an.tmac
    이것들은, andoc.tmac (을)를 호출하는 나팔 파일입니다.

andoc.tmac
    이 파일은, man 매크로 또는 mdoc 패키지의 머지않아를 사용해야할 것인가를 판정합니다.

an-old.tmac
    전 man 매크로가, 이 파일에 포함됩니다.

man.local
    로컬의 수정과 커스터마이즈는, 이 파일에 넣습니다.

관련 항목
man 매크로는, groff 리퀘스트의 모임에서 되어 있기 때문에, 원리적으로는, 필요가 있는 경우에는 자기류의 groff 리퀘스트를 만들어 man 의 기능을 추가할 수가 있습니다. 이러한 리퀘스트의 완전한 리스트는 WWW 페이지

http://www.cs.pdx.edu/~trent/gnu/groff/groff_toc.html (으)로부터 입수할 수 있습니다.

tbl(1), eqn(1), refer(1), man(1)

저자
이 메뉴얼 페이지는, 본래 Debian GNU/Linux 시스템용으로 Susan G. Kleinmann <sgk@debian.org> 가 쓴 것입니다. 그것을 Werner Lemberg <wl@gnu.org> 가 수정해, 갱신했습니다. 그것이 지금은 GNU troff 배포물의 일부가 되어 있습니다.