Linux Lexicon — 매뉴얼 페이지 분석

게시 됨: 2016-11-01

짧은 바이트: 소프트웨어 매뉴얼 페이지와 문서는 모든 종류의 괄호와 괄호로 묶인 애매한 규칙이 없는 초보자에게 충분히 두껍고 어려울 수 있습니다. 여기에서는 Linux 매뉴얼 페이지의 복잡성을 줄이고 이해하기 쉽게 만들려고 합니다.

M 페이지는 일반적으로 이름과 설명, 사용법 및 주의 사항을 자세히 설명하는 일련의 섹션으로 나뉩니다. 매뉴얼 페이지는 읽기 어려울 수 있지만, 급히 활용할 수 있는 귀중한 리소스이며 인터넷이 필요하지도 않습니다.

이름
첫 번째는 이름 제목이며 요약됩니다. 이 섹션에는 유틸리티 이름과 간단한 설명이 포함됩니다.

개요
맨페이지마다 가독성의 정도가 다르지만 한 가지는 확실합니다. 가장 어려운 부분은 일반적으로 털이 많은 시놉시스를 해독하는 것입니다. 주어진 명령에 필요한 정보를 나타내는 몇 가지 규칙이 있습니다. 이러한 규칙은 다른 형식의 표기법뿐만 아니라 다른 대괄호와 괄호로 구성됩니다. 이러한 모든 다른 규칙은 초보자에게는 매우 혼란스러울 수 있으며, 경험은 있지만 매뉴얼 기술에 정통하지 않은 사람에게는 여전히 벅찰 수 있습니다. 아래에서 우리는 횡설수설을 소화 가능한 규칙으로 분해할 것입니다.

대담한	표시된 대로 정확하게 입력하십시오.
기울임꼴 또는 밑줄	적절한 인수로 대체하십시오.
[-abcxyz]	대괄호 안의 모든 플래그는 선택 사항입니다.
-아 \| -비	파이프로 구분된 옵션은 함께 사용할 수 없습니다.
<필수>	필수 인수로 일반적으로 옵션 설명에 있습니다.
{예 아니오}	제한된 옵션, 지정된 옵션만 작동합니다.
…	생략 부호가 뒤따르는 인수는 반복될 수 있습니다.

이러한 규칙은 상당히 간단하지만 긴 함수 정의에 사용되는 경우, 특히 중첩된 경우에는 더욱 어려워지고 위협적으로 됩니다. 그래서, 우리가 분해한 것을 구축하기 위해 아래에서 몇 가지 중첩을 살펴보겠습니다.

tar {A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ ARG …]

tar 명령에는 많은 옵션이 있습니다. 표시된 대로 입력해야 하므로 tar 명령의 이름이 굵게 표시됩니다. 그런 다음 중괄호가 파이프로 구분된 옵션으로 열려 있는 것을 볼 수 있습니다. 이는 해당 옵션으로 제한되어 하나만 선택해야 함을 나타냅니다. 다음은 선택적 플래그입니다. 아무 숫자나 사용할 수 있지만 모두 함께 작동하지 않을 수도 있습니다. 매뉴얼 페이지를 자세히 읽어보면 잠재적인 옵션 충돌에 대해 밝힐 수 있습니다. 마지막으로 작업 중인 파일에 대해 tar의 경우 반복 가능한 인수가 있습니다.

su [옵션] [-] [ 사용자 [ 인수 ...]]

다시 말하지만 su 는 명령의 이름이기 때문에 굵게 표시됩니다. 둘째, 플래그는 실제로 지정되지 않고 선택 사항일 뿐입니다. 셋째, 단일 플래그가 지정되지만 이 플래그도 선택 사항입니다. 마지막으로 선택적 인수 내에서 반복 가능한 선택적 인수를 봅니다. 이제 매우 신비롭게 보였던 것이 더 이해가 됩니다.

후이즈 [{-h|–호스트 } 호스트 ] [{-p|–포트} 포트 ] [-abBcdGHKlLmMrRx] [-g SOURCE:FIRST-LAST ] [-i ATTR [, ATTR ]…] [-s 소스 [, SOURCE ]...] [-T TYPE [, TYPE ]...] [-verbose] OBJECT

이것은 특히 밀도가 높은 것입니다. 그것을 즐겨 사용하는 텍스트 편집기에 복사하고 읽기에 도움이 된다면 거기에 공백을 추가하십시오. 이것을 스캔한 후 몇 가지 패턴을 보기 시작해야 합니다. 호스트 및 포트 부분은 해당 옵션에 대한 인수가 뒤에 오는 옵션의 짧고 긴 형식에 대해 동일한 형식을 사용하지만 둘 다 선택 사항입니다. 그런 다음 선택적 플래그 문자열을 봅니다. 처음부터 끝까지 소스에 대한 다음 비트는 맨 페이지 뒷부분에서 설명할 whois가 예상하는 구문입니다. 이제 우리는 단일 인수 또는 선택적 반복 인수를 취하는 선택적 플래그의 삼중항을 봅니다. 이것은 처음에 완전히 파악하기 매우 어려울 수 있는 일종의 복합 규칙입니다. 마지막으로 verbose 옵션과 객체(호스트/도메인)가 있습니다.

이것이 매뉴얼 페이지 시놉시스를 읽는 방법입니다. 몇 가지 다른 규칙이 있지만 이 문서에서 다루기에는 너무 모호합니다.

설명
이것은 일반적으로 프로그램이나 유틸리티의 용도가 설명되는 곳입니다. 일부 설명서는 이 제목 아래에서 다른 설명서보다 훨씬 더 장황합니다.

옵션
선택 또는 필수가 될 수 있는 모든 플래그와 다른 인수를 기억하십니까? 이것은 그들이 모두 설명되는 곳입니다. 여기에는 일반적으로 좋은 정보가 있으며 주어진 플래그에 해당 인수가 필요함을 나타내는 <argument> 규칙을 찾는 경우가 많습니다. 매뉴얼 페이지를 정의하는 엄격한 규칙이 없고 관례와 표준을 준수하려는 의지만 있기 때문에 옵션이 설명 부분에 있는 경우가 있습니다.

예
이것은 불행히도 모든 설명서에 포함되어 있지 않은 가장 편리한 부분 중 하나입니다. 또한 정보의 양과 예의 수가 크게 다르며 모든 예가 실제로 명령 사용에 도움이 되는 것은 아닙니다.

이 외에도 공식적으로 정의된 매뉴얼 페이지 섹션 이 아래에 정의되어 있습니다.

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

많은 명령에는 두 개 이상의 섹션에 매뉴얼이 없지만, 매뉴얼이 있는 명령이나 이름이 모호할 수 있는 명령의 경우 아래 예와 같이 섹션을 지정할 수 있습니다.

남자 5 주제

사용 가능한 섹션에서 볼 수 있듯이 명령만이 매뉴얼이 있는 것은 아닙니다. 시스템 호출, 구성 파일 및 특수 장치에는 해당 매뉴얼 페이지가 있을 수 있습니다. 매뉴얼 페이지에 있는 일반적인 Linux 설치에 대한 정보의 양은 놀랍고 다른 오픈 소스 UNIX 계열 운영 체제에도 동일하게 적용됩니다.

매뉴얼 페이지가 충분하지 않고 여전히 명령을 이해하지 못한다면 많은 사람들이 특정 도구에 대한 더 자세한 설명을 제공하기 때문에 항상 온라인으로 확인하십시오. 또한 많은 배포판에는 다양한 소프트웨어 패키지에 대한 자체 매뉴얼 페이지가 있습니다. 소프트웨어에 익숙하지만 여전히 매뉴얼이 부족하다고 생각되면 언제든지 직접 작성하여 해당 프로젝트에 제출하여 기여할 수 있습니다. 문서화는 종종 소프트웨어 프로젝트에서 가장 무시되는 부분이므로 코드를 작성할 수 없더라도 매뉴얼, Wiki 기사 및 자습서를 작성하여 다른 사람을 도울 수 있습니다.

이제 매뉴얼 페이지의 구조를 알았으니 RTFM 외에는 변명의 여지가 없습니다 .

또한 읽기: Linux 사전: Watch 명령을 사용하여 X초마다 명령 실행