VGRIND(1)

명칭
vgrind - 프로그램의 소스를 정서한다

서식
vgrind [-] [-W] [-d file] [-f] [-h header] [-llanguage] [-n] [-p postproc] [-sn] [-t] [-x] name ...

해설
vgrind 유틸리티는, 프로그램의 소스를 troff(1) (을)를 사용해 정서합니다. 코멘트 (은)는 이탤릭체로, 키워드는 볼드체로, 현재 인쇄중의 함수명은, 각 페이지의 margin 부분에 열거됩니다.

vgrind 유틸리티에는 2 개의 기본적인 모드, 필터 모드( -f 옵션의 항을 참조)와 표준 모드가 있습니다. 필터 모드에서는, vgrind 하 tbl(1) (와)과 같이 에 행동합니다. 즉, 이하의 troff 라이크 매크로에 둘러싸인 부분 이외 (은)는 소 통합니다.

.vS 처리 area 개시

.vE 처리 area 종료

매크로에 둘러싸인 행은 이미 가리킨 것처럼 정서됩니다. vgrind (으)로부터의 출력을 troff 에 건네주는 것으로 인쇄할 수가 있습니다. eqn(1) (이)나 tbl(1) (와)과의 호출 순서에는 특별한 제한은 없습니다.

통상 모드에서는, vgrind (은)는 입력 파일 전체를 처리해, 포스트프로세서를 기동해 출력 처리를 실시하게 합니다. 포스트프로세서의 디폴트는 psroff(1) 입니다

어느 쪽의 모드에서도, vgrind (은)는 피리어드로 개시하는 행은 변경하지 않고 출력합니다.

옵션은 이하대로입니다.

-   표준 입력으로부터 읽어들입니다( -f 옵션이 지정되었을 경우는 디폴트입니다).

-W  (네로우) 바리안용이 아니고, (와이드) 바사텍크프린타의 출력을 실시합니다.

-d file
    프로그램 언어 정의 파일을 지정합니다(디폴트에서는 /usr/share/misc/vgrindefs (을)를 사용합니다).

-f  필터 모드로 동작합니다.

-h header
    각 페이지의 헤더 캐릭터 라인을 지정합니다(디폴트는 입력 파일명입니다).

-l  입력 파일의 프로그램 언어를 지정합니다. 현재 사용 가능한 것은 이하 대로입니다: PASCAL (-lp), MODEL (-lm), C (-lc 혹은 디폴트), C++ (-lc++), CSH (-lcsh), SHELL (-lsh), RATFOR (-lr), MODULA2 (-lmod2), YACC (-lyacc), LISP (-lisp), ICON (-lI), PERL (-lperl)

-n  키워드의 볼드화를 실시하지 않습니다.

-p postproc
    postproc (을)를 출력의 포스트프로세서로서 사용합니다. psroff(1) 하지만 디폴트입니다.

-s  출력 캐릭터의 포인트 사이즈를 지정합니다(troff 의 .ps 와 같은 인수입니다).

-t  troff 의 동일한 옵션과 같이, 포맷 후, 표준 출력에 써냅니다.

-x  인덱스 파일을 정서합니다. vgrind (은)는, 커런트 디렉토리에 index (이)라는 이름의 파일이 있으면 항상 인덱스를 출력합니다. 이 인덱스 파일을 vgrind 에 -x 옵션과라고도 (으)로 지정하는 것으로, 정서할 수가 있습니다.

관련 파일
index
    인덱스 파일
/usr/share/tmac/tmac.vgrind
    매크로 패키지
/usr/libexec/vfontedpr
    프리프로세서
/usr/share/misc/vgrindefs
    언어 기술 파일

관련 항목
getcap(3), vgrindefs(5)

버그
vfontedpr 는, 이하의 프로그래밍 스타일을 가정하고 있습니다:

C 언어 - 함수명은, 공백 또는 asterisk만으로부터 되는 행의 직후에 있어, 괄 호로 묶어진 인수 리스트가 같은 행에 있다.

PASCAL - 함수명은, 키워드 function 또는 procedure (와)과 같은 행에 있다.

MODEL - 함수명은, 키워드 is beginproc (와)과 같은 행에 있다.

만약 이상에 따르지 않은 경우, 인덱스와 margin에의 함수명 인쇄가 부정확한 물건이 됩니다.

그 외, 몇개의 프로그래밍 스타일은 예쁘게 정서되지 않습니다: 공백에 의해 원시 코드의 선두등을 가지런히 했을 경우, 올바르고 포맷 되고 선. vgrind (을)를 사용해 정서하는 경우는, 탭에 의해 원시 코드를 가지런히 한다 같게 합니다. 이것은 vgrind 하지만 가변폭폰트를 사용하기 때문입니다.

vgrind (은)는, ctags(1) 하지만 함수를 검출하는 방식을 채용해야 합니다.

필터 모드는 -me 또는 -ms 매크로를 이용한 문서로, 올바르게 동작하지 않습니다. (이 모드는 도대체 어디서 사용하겠지요)

역사
vgrind 하 3.0BSD 그리고 추가되었습니다.