매뉴얼 페이지를 어떻게 작성해야 하며 어떤 스타일을 사용해야 합니까? [폐쇄]

제 질문은 프로젝트가 거의 완료된 후에는 매뉴얼 페이지와 같은 문서화와 같은 작업에 집중할 시간이라는 것입니다.

이제 사람들은 맨페이지를 좋아할 수도 있고 좋아하지 않을 수도 있지만 맨페이지를 Linux 도구와 함께 제공하는 것은 거의 표준 관행입니다.

그러나 내 문제는 이를 정확하게 구축하고 프로그래밍하는 방법에 대한 정보를 찾는 것입니다.

어떤 섹션을 항상 포함해야 하는지 등에 대한 대략적인 지침이 있다는 것을 알고 있습니다. 그러나 나는 groff, ssh, , 와 같은 내용을 이해하고 base64이를 (올바르게) 작성하는 방법을 이해하기 위해 주로 이미 작성된 매뉴얼 페이지에 의존했습니다 .

문제는 그들의 스타일이 매우 다양하다는 것입니다.

옵션 테이블에 일반적으로 사용되는 명령 이 아닌 base64일반 명령을 사용하기 위한 매뉴얼 페이지입니다 . 그러나 troff와 유사한 이스케이프 시퀀스를 사용합니다..SH.TP.OP

.TP
\fB\-d\fR, \fB\-\-decode\fR
decode data

간단하다고만 말하면 충분합니다.

매뉴얼 페이지는 groff완전히 다른 이야기입니다. 개요에서는 유사한 스위치 명령을 사용합니다 .SY..OP

.SH SYNOPSIS
.\" --------------------------------------------------------------------
.
.SY groff
.OP \-abcegijklpstzCEGNRSUVXZ
.OP \-d cs
.OP \-D arg
.OP \-f fam
...

이스케이프 시퀀스를 거의 사용하지 않고 대신 텍스트는 다음과 같이 구성됩니다.

.TP
.B \-j
Preprocess with
.BR chem .
.
Implies
.BR \-p .

즉, 이스케이프 시퀀스 대신 troff 명령을 사용하십시오.

다른 유사한 예가 있으며 매뉴얼 페이지를 작성해 본 사람이라면 누구나 다른 스타일 등을 알고 있습니다.

이때 어떤 스타일을 따라야 할지 고민이 됩니다. 최소한 몇 가지 참조 가이드가 있으면 좋을 것입니다. 기본적으로 이를 구현하는 방법에 대한 입문서나 무언가가 있을 수 있습니다. (예: .SY명령이 무엇을 하는지 파악하지 못했습니다 .)

이 페이지는 시작에는 유용했지만 금방 그 유용성이 소진되었습니다.

• http://www.linuxhowtos.org/System/creatingman.htm
• https://www.linux.com/news/what-you-need-know-write-man-pages
• http://liw.fi/manpages/

---

편집: 매뉴얼 페이지의 추가 정보

• http://man7.org/linux/man-pages/man7/groff_man.7.html
• http://man7.org/linux/man-pages/man7/mdoc.samples.7.html
• http://man7.org/linux/man-pages/man7/mdoc.7.html

고마워요, 스티븐 해리스.