GROFF_TMAC(5)

명칭
groff_tmac - roff 정서 시스템내에 있는 매크로 파일

해설
roff(7) 정서 시스템은, 특수한 용도의 문서에 적절했다 매크로 패키지를 제공하고 있습니다. 각각의 매크로 패키지는, 그 패키지의 tmac 파일 (으)로 불리는 파일중에 매크로 및 정의를 격납하고 있습니다. tmac 라는 이름은, `Troff MACros' (을)를 줄인 것입니다.

tmac 파일은, 보통 roff 소스 문서입니다. 다만, 통상 이 파일에는 정의 및 설정 명령 밖에 포함되지 않고, 텍스트는 들어가 있지 않습니다. tmac 파일은 모두 tmac 디렉토리라고 하는 1 개 혹은 소수의 디렉토리내에 보관되고 있습니다.

명칭 붙어라
옛부터 있는 roff 시스템에는, 기묘한 명칭부의 체계가 있었습니다. 매크로 패키지의 명칭이 그리고 시작되어 있는 경우에는, 이 캐릭터는 생략 되었습니다. 예를 들면, 메뉴얼 페이지용의 매크로 패키지 man 하 an (으)로 불려 그 패키지의 매크로 파일은 tmac.an (으)로 불렸습니다 (현재의 버젼의 groff 에서는, 이 파일은 대신에 an.tmac (으)로 불리는 것에 주의해 주세요).

비슷한 이유로, 명칭이 그리고 시작되지 않는 매크로 패키지는, (을)를 붙여 나타내지는 일이 자주 있었습니다. 예를 들면, tmac.doc 에 대응하는 패키지는, mdoc (으)로 불렸습니다. 왜냐하면, 이 패키지를 액티브하게 하기 위한 명령행은, 다음과 같이 나타내지기 때문입니다.

현재의 groff(1) 의 버젼에서는, 패키지명에 하지만 붙든지 붙지 않든지가, 이 괴로운 매크로 패키지의 명칭부 체계를 어느쪽이나 제공하고 있습니다. 그러므로, groff 그럼, man 매크로 패키지는, 다음의 머지않아에서도 지정 가능합니다.

시스템으로 어느 매크로 패키지가 이용 가능한가를 판별하는데 가장 간단한 방법은, tmac 디렉토리군의 내용을 조사하는 것입니다. 예를 들면, tmac.anything 또는 anything.tmac (으)로 불리는 파일은, anything (이)라는 이름의 매크로 패키지를 결정하고 있습니다.

groff 그럼, 매크로 패키지의 대부분은, 옛부터 있는 패키지에 대해서 (을)를 선두에 붙였다 groff_<name>(7) (이)라는 이름의 메뉴얼 페이지로 설명이 되고 있습니다.

혼잡
문서중에서 매크로 패키지를 사용하기 위한 방법은 몇개인가 있습니다. 실행시에, groff 의 옵션 (을)를 이용해 매크로 파일 name.tmac 안의 정의를 명칭붙어라 의 섹션으로 말한 것처럼 이용 가능하게 합니다. 이 파일이 발견되지 않는 경우, tmac.name 하지만 찾아집니다.

groff 리퀘스트 혹은 (을)를 이용해 매크로 파일을 문서에 수중에 넣는 일도 가능합니다. 에 대해서는, 매크로 파일의 풀 패스에서의 파일명을 지정하지 않으면 안됩니다 — 그 매크로 파일이 보존되고 있는 디렉토리를 포함할 필요가 있습니다. 매크로 파일이 tmac 디렉토리군의 어떤 것이나 1 개에 격납되고 있는 경우, 대신에 (을)를 사용하는 편이 편리합니다. 왜냐하면, 이 리퀘스트는 tmac 패스를 탐색해 파일명을 찾아내기 때문입니다. 더욱, 인클루드 되는 파일의 이름이 name.tmac 그렇다고 하는 서식의 경우로 이것이 발견되지 않는 경우, (은)는 대신에 tmac.name (을)를 오픈하려고 합니다. 또, 이 반대도 실시합니다.

및 리퀘스트를 해결하기 위해서, roff 프리프로세서 하지만 불리지 않으면 안 되는 것에 주의해 주세요. 다만, 인클루드 되는 파일이 사전 처리가 필요한 경우에 한정합니다. 이것은, 명령행상에서 파이프라인으로부터 직접 부르는지, 또는 의 옵션을 사용할까 하면 할 수 있습니다.

약속한일의형태 의 섹션으로 말하고 있도록(듯이), 프리프로세서 워드중에 캐릭터 (을)를 넣어도 좋습니다.

예를 들면, 매크로 파일이 /usr/share/tmac/macros.tmac 에 보존되고 있어 docu.roff (이)라는 이름의 문서로 사용되고 있다고 합니다.

실행시에 있어, 이 문서에 대한 포매터 호출은 다음과 같이 실시합니다.

문서내에 직접 매크로 파일을 수중에 넣으려면 ,
    .mso macros.tmac
혹은
    .so /usr/share/tmac/macros.tmac
(을)를 사용합니다.

어느 쪽의 경우에서도, 포매터는
    groff -s docu.roff
(을)를 사용해 불려 갑니다.

약속한 일의 형태

최근의 roff 정서 시스템이 많고로 서포트되고 있는 약속한 일의 형태가 있습니다. 다음에 진술되고 있는 것 같은 프리프로세서 워드 하지만 그것입니다.

문서의 1 행 째가 코멘트인 경우, 최초의 단어 (코멘트 캐릭터 및 공백의 뒤)는 프리프로세서 워드 (으)로 구성됩니다. 이것은 즉, 이 워드의 캐릭터가, 문서를 정형할 때에 기동하지 않으면 안 되는 프리프로세서 명령의 생략형이라고 해석된다고 하는 것입니다. 대부분의 경우, 프리프로세서의 옵션에 대응한 캐릭터만이 인식됩니다. 그것은, 입니다 ( roff(7) (을)를 참조).

게다가 유저에게로의 좋은망비록으로서 써 둡니다만, 포매터에 따라서는 ( man(1) 프로그램과 같이) 프리프로세서 워드로 지정된 프리프로세서를 자동적으로 기동시키는 것까지도 할 수 있는 것이 있습니다. 다만, 이것을 목표로 해서는 안됩니다.

매크로 파일을 기술한다
매크로 파일을 기술하는 것은 간단합니다. 매크로, 캐릭터 라인, 레지스터등의 세트를 설계해 주세요. 그리고 그것을 1 개의 파일에 보존해 주세요. 기술한 매크로를 사용하는 문서는, 혼잡 섹션으로 말한 것처럼 리퀘스트를 사용해 매크로를 수중에 넣습니다.

tmac 의 기능을 사용하려면 , 매크로 파일 whatever.tmac (또는 tmac.whatever )(을)를 호출해, tmac 패스의 어떤 것인가의 디렉토리에 파일을 둡니다. 관련파일 섹션을 참조해 주세요. 그렇다면, 문서는 혼잡 섹션으로 말한 것처럼 리퀘스트 혹은 옵션을 사용해 매크로 파일을 수중에 넣을 수가 있습니다.

만약 당신이 쓴 매크로가 일반 용도에 사용할 수 있을지도 모르는 것이라면, groff 멘테나에 연락을 해, 그 매크로가 groff 의 contrib 소스 디렉토리에 포함되도록 해 주세요.

매크로를 쓰려면 , 몇개인가 일반적인 가이드 라인이 있으면 도움이 된다 그렇지.

•   기능이 있는 backslash는 모두 2 겹으로 합니다. ->

•   인자 가능한 backslash는 모두 (와)과 같이 쓰지 않으면 안됩니다.

•   닷은 모두 이스케이프 해 주세요. ->

•   텍스트 부분에는, 인자할 수 없는 캐릭터 (을)를 넓게 사용하도록 해 주세요. 특히, 의 전이나 줄머리로 사용해 주세요. 다만, 지연 명령의 전에서는 사용하지 말아 주세요.

•   캐릭터 (을)를 일시적인 변수명에 사용해 주세요.

•   당신이 쓴 매크로를 텍스트 및 그래픽 디바이스에 대해서 테스트해 주세요. 예를 들면, latin1 (와)과 ps 하지만 그렇습니다.

관련 파일
tmac 메카니즘을 사용하고 싶은 매크로명은 모두, name.tmac 또는 tmac.name 의 서식에 따라 이름이 붙여지지 않으면 안됩니다.

매크로 파일은, tmac 디렉토리군 에 보존되고 있습니다. 이 디렉토리군 모든 것이 tmac 패스 (을)를 구성해 있습니다.

매크로 파일을 검색하는 패스의 요소는 (차례로) 다음과 같습니다:

•   troff 에 대응하는 groff 의 -M 명령행 옵션으로 지정되는 디렉토리 command line option

•   GROFF_TMAC_PATH 환경 변수로 주어지는 디렉토리

•   현재의 디렉토리 ( -U 명령행 스윗치를 사용해, 안전하지 않는 모드인 경우만)

•   홈 디렉토리

•   사이트 고유의 (플랫폼비의존의) 디렉토리, 플랫폼 고유 디렉토리, 그리고 메인 tmac 디렉토리:

    /usr/share/tmac
    /usr/share/tmac
    /usr/share/tmac

환경 변수

GROFF_TMAC_PATH
    코론 단락의 추가의 tmac 디렉토리 리스트이며, 이 리스트로부터 매크로 파일을 찾습니다. 상세한 것에 대하여는, 전의 마디를 참조해 주세요.

버그
groff 문서는, 현재 발전중입니다. 일시적으로 다른 문서와의 사이에 작은 어긋나는 점이 가능하게 될 가능성이 있습니다.

저자
이 문서는 groff, 즉 GNU roff 배포물의 일부입니다. 이 문서는 Bernd Warken <bwarken@mayn.de> 가 썼습니다.

이 문서는 FDL (GNU Free Documentation License) 버젼 1.1 이후의 조항의 아래에서 배포되고 있습니다. 사용의 시스템에는 FDL 의 카피가 있을 것입니다. 또,

    <http://www.gnu.org/copyleft/fdl.html>
(으)로부터 온라인에서도 입수 가능합니다.

관련 항목
groff 시스템의 상세 모두에 임해서 신뢰할 수 있는 정보원은, groff 의 info(1) 파일입니다.

groff 의 개요에 대해서는, roff(7) 및 groff 소스 패키지중의 README 파일을 참조해 주세요.

groff tmac 매크로 패키지는, groff_man(7), groff_mwww(7), groff_mdoc(7), groff_mdoc.samples(7), groff_me(7), groff_mm(7), groff_mmroff(7), groff_ms(7) 입니다.

groff 의 언어에 대해서는 groff(7) 그리고, 포매터에 대해서는 groff(1), troff(1) 그리고 설명되고 있습니다.

파일 시스템 계층 표준 (FHS)은 http://www.pathname.com/fhs/ 그리고 입수 가능합니다.