Linux 매뉴얼 페이지를 만드는 방법

명령 남성 on Linux는 모든 Linux 개발자와 사용자의 머슬 메모리에 내장되어 있습니다. 말 그대로 모든 사람이 사용합니다. 아마추어 및 초보 개발자에서 Linux 전문가 및 전문가에 이르기까지.

Linux 명령, 구성 파일 또는 기타 기능에 대한 명령줄 매뉴얼 페이지를 읽는 데 사용됩니다. 매뉴얼 페이지는 일반적으로 Linux에서 소프트웨어 설치와 함께 설치됩니다. 명령에 의해 구문 분석되는 매뉴얼 페이지에 대해 정의된 구문이 있습니다.

내가 작성한 다음 bash 스크립트에 대한 매뉴얼 페이지를 작성해 보겠습니다.

#!/bin/bash if [ "$1" == "h" ]; then echo "안녕하세요" fi if [ "$1" = "b" ]; 그런 다음 "안녕" fi를 에코

이 스크립트는 두 가지만 수행합니다. 옵션 'h'가 인수로 지정되면 "Hello"를 출력하고 옵션 'b'가 인수로 지정되면 "Bye"를 출력합니다.

이 프로그램에 대한 매뉴얼 페이지를 작성해 보겠습니다. 사용 정력 또는 선택한 편집기를 사용하여 텍스트 파일을 만들 수 있습니다.

빔 테스트.1

확장자 '.1'은 이 매뉴얼 페이지가 실행 가능한 명령을 위한 것임을 나타냅니다. 강제가 아니라 매뉴얼 페이지를 작성할 때 널리 따르는 관례입니다. man을 위한 매뉴얼 페이지(남자 남자 !) 카테고리를 나열합니다.

 1 실행 프로그램 또는 쉘 명령 2 시스템 호출(커널에서 제공하는 기능) 3 라이브러리 호출(프로그램 라이브러리 내의 기능) 4 특수 파일(일반적으로 /dev에 있음) 5 파일 형식 및 규칙 예: /etc/passwd 6 게임 7 기타( 매크로 패키지 및 규칙 포함), 예 man(7), groff(7) 8 시스템 관리 명령(일반적으로 루트에만 해당) 9 커널 루틴 [비표준]

맨 페이지는 아주 오래된 roff 마크업 언어를 사용하여 생성됩니다. 다양한 제목과 섹션에 대한 명령(읽기 마커)이 있습니다.

  • .TH – 이것은 man 파일의 첫 번째 명령이어야 합니다. 매뉴얼 페이지의 제목 표제를 지정하는 데 사용됩니다.
  • .쉿 – 섹션 제목.
  • .비 – 옆에 있는 텍스트를 굵게 표시할 때 사용합니다.
  • .TP – 명령에 대한 인수(플래그)에 대한 정보를 표시하는 데 사용됩니다.
  • .BR – 텍스트를 볼드체 및 일반 로마자 글꼴로 표시하는 데 사용됩니다.

다음은 위의 (간단한) roff 명령만을 사용하여 만든 프로그램의 매뉴얼 페이지입니다.

.TH test.sh 1 .SH 이름 test.sh \- Hello 또는 Bye를 인쇄합니다. .SH 개요 .B test.sh [ h ] [ b ] .SH 설명 .B test.sh 이것은 두 가지만 수행하는 샘플 스크립트입니다 . 인수가 'h'이면 "Hello"를 인쇄하거나 인수가 'b'이면 "Bye"를 인쇄합니다. .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print Bye

파일 저장 먼저 를 눌러 ESC 키를 누른 다음 입력 :wq 파일을 저장하고 vim 콘솔을 종료합니다.

아래 명령을 사용하여 방금 만든 매뉴얼 페이지를 테스트합니다.

남자 ./test.1

자세한 내용은 남성 사용법, 실행 man 맨 페이지 터미널에서 명령.

?

이것은 매뉴얼 페이지를 작성하기 위한 기본 구문입니다. 일을 더 쉽게 하기 위해 txt2man과 같은 도구를 사용하여 일부 마크업 언어 형식의 파일을 roff 형식으로 변환할 수 있습니다.