이 섹션은 자동으로 생성됩니다. 여기에는 명령 이름과 해당 기능에 대한 반문장 요약이 포함되어 있습니다.

이 섹션에는 명령의 구문 다이어그램이 포함되어 있습니다. 개요에는 일반적으로 각 명령줄 옵션이 나열되어서는 안 됩니다. 그건 아래에서 이루어집니다. 대신 입력 및 출력 파일의 위치와 같은 명령줄의 주요 구성 요소를 나열하세요.

명령어의 기능을 설명하는 여러 단락.

각 명령줄 옵션을 설명하는 목록입니다. 옵션이 많으면 하위 섹션을 사용할 수 있습니다.

프로그램이 성공을 위해 0을 사용하고 실패를 위해 0이 아닌 값을 사용한다면 이를 문서화할 필요가 없습니다. 0이 아닌 다양한 종료 코드 뒤에 의미가 있는 경우 여기에 나열하세요.

프로그램의 하위 언어 또는 런타임 인터페이스를 설명하십시오. 프로그램이 대화형이 아닌 경우 일반적으로 이 섹션을 생략할 수 있습니다. 그렇지 않은 경우 이 섹션은 런타임 기능을 설명하기 위한 포괄적인 섹션입니다. 해당하는 경우 하위 섹션을 사용하세요.

프로그램이 사용할 수 있는 모든 환경 변수를 나열합니다. 완전해지려고 노력하세요. 심지어는 겉보기에 사소해 보이는 변수도쉘사용자가 관심을 가질 수 있습니다.

프로그램이 암시적으로 접근할 수 있는 모든 파일을 나열합니다. 즉, 명령줄에 지정된 입력 및 출력 파일을 나열하지 않고 구성 파일 등을 나열합니다.

프로그램이 생성할 수 있는 비정상적인 출력을 설명하십시오. 가능한 모든 오류 메시지를 나열하지 마십시오. 이것은 많은 작업이며 실제로는 거의 사용되지 않습니다. 그러나 오류 메시지가 사용자가 구문 분석할 수 있는 표준 형식을 가지고 있다면 여기에서 이를 설명할 수 있습니다.

다른 곳에 맞지 않는 모든 것, 특히 버그, 구현 결함, 보안 고려 사항, 호환성 문제.

예

프로그램 역사에 몇 가지 중요한 이정표가 있었다면 여기에 나열될 수 있습니다. 일반적으로 이 섹션은 생략될 수 있습니다.

저자 (기고 섹션에서만 사용됨)

상호 참조, 다음 순서로 나열됨: 기타PostgreSQL명령 참조 범퍼카 토토,PostgreSQLSQL 명령 참조 범퍼카 토토, 인용PostgreSQL설명서, 기타 참조 페이지(예: 운영 체제, 기타 패키지), 기타 문서. 같은 그룹에 있는 항목은 알파벳순으로 나열됩니다.