저는 리눅스에서 많은 도구와 명령을 사용하는 회사에서 일하고 있습니다. (내부 및 외부)리눅스 용 일반 매뉴얼을 만드는 방법은 무엇입니까?
도구마다 예제가있는 사용자 지정 설명서를 만들고 싶습니다.
이를 위해 정보 도구를 사용하여의 생각 :
info CompanyName tool1
info CompanyName tool2
info CompanyName tool3
..
각각의 출력은 나 추가 예제와 주석의 간단한 텍스트해야한다.
그러나 내가 아는 한 Linux의 정보는 사용자 정의 된 요구 사항이 아닌 특정 도구 용으로 작성됩니다.
위의 목표를 달성하는 가장 좋은 방법은 무엇입니까? 현재 도구마다 탭으로 한 번씩 숭고함을 사용하고 있습니다. 그런 다음 새로운 예제로 숭고한 탭을 업데이트합니다.
모든 조언을 가장 높이 평가할 것입니다.
가치가있는 것을 위해, 나는 정보 페이지의 팬이 아니다. 나는 오래된 유닉스 맨 페이지를 선호하며 그것들을 쓰는 것은 매우 간단하다. 편집기에서 임의의 man 페이지를 열어 소스 코드를보고 원하는대로 복사 할 수 있습니다.
대부분의 시스템에서 설명서 페이지는 /usr/share/man/{man1,man2,man3,man4,man5,man6,man7,man8}/과 같은 디렉토리에 있거나 man 명령의 -w 옵션을 사용하여 설명서 페이지의 위치를 확인한 다음 열 수 있습니다. 예를 들면
$ man -w ls
/usr/share/man/man1/ls.1.gz
$ vim /usr/share/man/man1/ls.1.gz
사용자는 설명서 작성 방법을 볼 수 있으며 사용자 설명서 페이지를 작성할 수 있습니다. 누구나 여러분이 작성한 매뉴얼 페이지를 읽을 수 있으려면, man 페이지가 매뉴얼 페이지를 검색하는 디렉토리 중 하나에 매뉴얼 페이지가 설치되어 있어야합니다. Linux에서는 보통 manpath 명령을 실행하여이 디렉토리 목록을 볼 수 있습니다 (다른 시스템에서는 다를 수 있으므로 man 명령 자체의 맨 페이지를보아야합니다). 이 디렉토리 중 하나에 설명서 페이지를 저장하면 어느 누구도 man 유틸리티를 사용하여 읽을 수 있습니다. 비표준 위치에 사람이 페이지를 저장하는 경우를 검색 할 수 man 있도록, 당신의 MANPATH 변수를 설정할 수 있도록 man 유틸리티는 또한, 환경 변수 MANPATH을 존중으로 POSIX 당
. 또는 /etc/man.conf 파일을 수정하여 설명서 페이지 디렉토리를 man의 검색 경로에 추가 할 수 있습니다.
이제 매뉴얼 페이지는 매크로 언어를 사용하여 마크 업을 수행합니다. 리눅스 시스템은 운영 체제의 BSD 계열에서 광범위하게 사용되는, mdoc(7)라는 사람 페이지를 작성하기위한 또 다른 현대적인 매크로 세트가,이 매뉴얼 here
을 볼 수있는 man(7) 매크로 구문을 사용하는 경향이있다. 매뉴얼을 볼 수 있습니다 here