Scroll to navigation

HELP2MAN(1) 사용자 명령 HELP2MAN(1)

이름

help2man - 간단한 설명서 페이지를 만듭니다

요약

help2man [<옵션>]... <실행파일>

설명

`help2man'은(는) `--help'의 설명서 페이지 출력과 `--version' 출력을 만듭니다.

이름 문단 설명
설명서 페이지 섹션 번호
설명서 이름 (사용자 명령, ...)
프로그램 공급원 (FSF, 데비안, ...)
로캘 선택 (기본: "C")
`<파일>' 내용 포함
`<파일>'이 있다면 내용 포함
`<파일>'로 출력 보내기
Texinfo 설명서 이름
Texinfo 설명서 포인터 없애기
프로그램 이름에서 `lt-' 제외
이 도움말을 출력하고 나갑니다
버전 번호를 출력하고 나갑니다

<실행파일> 은 `--help' 옵션과 `--version' 옵션을 받아들여야 하며 다음 웁션을 대신 지정한다 하더라도 표준 출력으로 결과를 내보내야합니다:

도움말 옵션 문자열
버전 옵션 문자열
버전 문자열
옵션 출력을 해석할 때 표준 출력도 포함

<bug-help2man@gnu.org>에 버그를 알려주십시오.

파일 포함

추가 내용은 --include 과 --opt-include 옵션으로 만든 출력 내용에 들어갑니다. 형식은 간단합니다:


[섹션]
내용


/패턴/
내용

*roff 텍스트 블록은 주어진 [섹션] (대소문자 무관)으로 시작하거나, 또는 /패턴/ 과 일치하는 문단 다음에 있는 그대로 들어갑니다.

패턴은 펄 정규 표현식 문법을 활용하며, i, s 또는 m 수정자 ( perlre(1)참고)를따릅니다.

처음 섹션이전 행이나 '-'으로 시작하는 패턴은 옵션으로 처리합니다. 그 박의 내용은 조용히 무시하며 주석, RCS 키워드 등의 용도로 사용합니다.

섹션 출력 (포함) 순서:


이름
요약
설명
옵션
기타
환경
파일
폐제
저자
버그 보고
저작권
추가 참조

파일에 들어간 임의의 [이름] 또는 [요약] 섹션은 자동으로 만든 내용으로 (비록 필요한 경우 --name 으로 옵션 우선 적용을 할 수 있지만) 바뀝니다.

다른 섹션은 위에 제시한 표준 섹션에 자동으로 만든 출력 다음에 붙거나 기타 (위에) 넣어 포함 파일의 내용을 반영합니다.

섹션에 들어간 내용의 위치는 문법을 활용하여 분명하게 요청할 수 있습니다. [<섹션], [=섹션] 또는 [>섹션] 으로 추가 내용 이전 또는 기본 동작처럼 그 다음에 각각 넣을 수 있습니다.

가용성

이 배포본의 최신 버전은 다음 온라인 위치에서 살펴볼 수 있습니다:


ftp://ftp.gnu.org/gnu/help2man/

저자

Written by Brendan O'Dea <bod@debian.org>

저작권

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021, 2022 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

추가 참조

help2man 의 전체 문서는 Texinfo 설명서로 관리합니다. info 와 help2man 프로그램을 제대로 설치했다면,

info help2man

명령으로 완전한 설명서를 띄울 수 있어야합니다.

2022년 12월 GNU help2man 1.49.3