매뉴얼 페이지의 중첩 목록

매뉴얼 페이지의 중첩 목록

나중에 몇 가지 플래그가 필요한 명령줄 인수가 있는데, 이를 매뉴얼 페이지 인수 목록에 목록으로 포함하고 싶습니다.

현재 나는 단순히 Flag - Description(매뉴얼 페이지) 그러나 이는 다음과 같은 이유로 이상적이지 않습니다.

  • 들여쓰기나 줄 바꿈이 없습니다. 수동으로 들여쓰기할 수 있지만 그런 다음에는 설정된 콘솔 너비를 가정해야 하는데 이는 원하지 않습니다.
  • 다음 줄로 이동하기 위해 이중 개행 문자에 의존해야 하는 경우에는 비슷한 것을 사용하고 싶습니다 .TP.

답변1

  • 목록은 로 시작 .RS하고 로 끝납니다 .RE.
  • term으로 시작하는 항목을 나열합니다 .IP. 두 개 이상의 단어를 포함하는 경우 해당 용어를 큰따옴표로 묶습니다.
  • 목록 항목 시작 후 다음 줄에 설명 텍스트를 배치합니다.
  • 중첩 가능하므로 설명에 더 많은 목록이 포함될 수 있습니다.
  • \fB. 대신 .. 를 사용하는 \fP굵은 용어 .B(밑줄에도 동일 - \fI. \fP대신 .. 사용 .I)
.RS
.IP \fBA\fP
\- Flag 1
.IP \fBB\fP
\- Flag 2
.IP \fBC\fP
\- A slightly longer flag description that could take up more than the width
of the average console. In fact you'd need a very wide console to read all
this.
.RE

생산성을 높이려면 매뉴얼 페이지를 보다 사용자 친화적인 형식으로 작성한 다음 변환하는 것이 좋습니다. 일부 적합한 도구는 다음 목록에 나열되어 있습니다.스크립트에 대한 매뉴얼 페이지를 만들 수 있나요?.

관련 정보