매뉴얼 페이지 섹션의 형식

다음 참조 정보에서는 각 매뉴얼 페이지 섹션의 내용, 각 섹션에 있는 정보 및 모든 Oracle Solaris 매뉴얼 페이지에 사용되는 표준 레이아웃에 대해 설명합니다.

매뉴얼 페이지 섹션에 대한 설명

다음 표에서는 각 매뉴얼 페이지 섹션과 각 매뉴얼 페이지가 참조하는 정보에 대해 설명합니다.

표 1-1 매뉴얼 페이지 섹션에 대한 설명

매뉴얼 페이지 섹션
설명
1
운영 체제에서 사용할 수 있는 일반 명령을 설명합니다.
1M
주로 시스템 유지 보수 및 관리 목적에 사용되는 명령과 데몬을 설명합니다.
2
모든 시스템 호출을 설명합니다.
3
다양한 라이브러리 있는 함수를 설명합니다.
4
다양한 파일 형식 및 규칙에 대한 개요를 제공합니다.
5
표준, 환경, 매크로 등과 같은 기타 설명서를 포함합니다.
6
게임과 데모를 포함합니다. 이 섹션은 더 이상 존재하지 않습니다.
7
특정 하드웨어 주변 장치 및 장치 드라이버를 나타내는 특수한 파일을 설명합니다.
9
커널 환경에서 장치 드라이버를 기록하는 데 필요한 참조 정보를 제공합니다.

매뉴얼 페이지 형식

매뉴얼 페이지는 다음 하위 섹션 중 일부 또는 전부를 포함하는 표준 형식을 사용합니다. 여기에 나온 하위 섹션의 순서는 개별 매뉴얼 페이지 섹션에서 정보가 표시되는 순서와 일치합니다.

NAME

구문이 수행하는 작업에 대한 간략한 설명과 함께 명령, 라이브러리 함수, 파일 또는 장치 드라이버의 이름을 제공합니다.

SYNOPSIS

명령, 라이브러리 함수, 파일 또는 장치 드라이버의 구문을 보여줍니다.

DESCRIPTION

서비스의 기능과 동작을 정의합니다.

IOCTL

끝 부분이 io로 되어 있는 장치의 특수한 장치 클래스에 사용됩니다(예: mtio(7I)). 이 섹션은 섹션 7의 페이지에만 표시됩니다.

OPTIONS

각 옵션이 수행하는 작업에 대한 간략한 요약과 함께 명령 옵션을 나열합니다.

OPERANDS

명령 피연산자를 나열하고 피연산자가 명령의 작업에 끼치는 영향을 설명합니다.

OUTPUT

명령, 라이브러리 함수, 파일 또는 장치 드라이버가 생성하는 출력, 표준 출력, 표준 오류 또는 출력 파일을 설명합니다.

RETURN VALUES

반환되는 값을 나열하고 값이 반환되는 조건을 설명합니다(값을 반환하는 함수를 설명하는 매뉴얼 페이지에만 적용됨).

ERRORS

함수 라이브러리가 생성할 수 있는 모든 오류 코드를 알파벳 순으로 나열하고 각 오류가 발생하는 조건을 설명합니다.

USAGE

자세한 설명이 필요한 특수한 규칙, 기능 및 명령을 나열합니다.

EXAMPLES

사용 예와 명령, 라이브러리 함수, 파일 또는 장치 드라이버의 사용 방법을 제공합니다.

ENVIRONMENT VARIABLES

명령, 라이브러리 함수, 파일 또는 장치 드라이버가 영향을 끼치는 환경 변수를 간략한 설명과 함께 나열합니다.

EXIT STATUS

명령이 호출 프로그램 또는 셸에 반환하는 값과 이러한 값이 반환되는 조건을 나열합니다.

FILES

관련 파일 및 명령이 만들거나 명령에 필요한 파일을 비롯하여 매뉴얼 페이지에서 참조하는 모든 파일 이름을 나열합니다.

ATTRIBUTES

속성 유형 및 해당 값을 정의하여 명령, 유틸리티 및 장치 드라이버의 특성을 나열합니다. attributes(5) 매뉴얼 페이지를 참조하십시오.

SEE ALSO

모든 관련 명령 또는 라이브러리 함수를 포함합니다.

DIAGNOSTICS

오류를 발생시킨 조건에 대한 간략한 설명이 있는 진단 메시지를 나열합니다.

WARNINGS

작업 조건에 심각한 영향을 줄 수 있는 특수한 조건에 대한 경고를 나열합니다. 진단 목록은 아닙니다.

NOTES

페이지의 다른 곳에 속해 있지 않은 추가 정보를 나열합니다.

BUGS

알려진 버그를 설명하고 가능한 경우 해결 방법을 제안합니다.


출처 -  http://docs.oracle.com/cd/E26925_01/html/E25811/gladp.html

'System > Common' 카테고리의 다른 글

WBEM (Web-Based Enterprise Management)  (0) 2012.02.09
이식 또는 포팅(porting)  (0) 2012.02.07
매뉴얼 페이지 섹션의 형식  (0) 2012.01.29
SCSI & SAS  (0) 2012.01.27
UNIX  (0) 2012.01.27
System V (시스템 파이브)  (0) 2012.01.27
Posted by linuxism

댓글을 달아 주세요