명령어 설명 규칙

설명할 명령어들에 대한 간단한 규칙들에 대해 설명한다. 모든 명령어들에 대해 각 절 제목으로 명령어의 이름과 간략한 내용을 기술하고, 본문에서 설명, alias, 사용법, 파라미터, 사용 예로 나누어 설명한다.

  • 설명 : 명령어의 기능에 대해 설명한다.

  • 관련 스키마 : 해당 명령어가 관련되어 있는 스키마 항목을 표기한다.

  • alias : 명령어에 대한 별칭(alias name)을 표기한다.

  • 사용법 : 명령어의 문법에 대해 설명한다. jeusadmin에서 help를 실행했을 때 usage 라인에 출력되는 문법과 동일하다.

    • 명령어 : 명령어는 굵은 글씨체를 사용한다.

    • 파라미터 : 명령어의 옵션을 비롯한 파라미터들에 대해 각각이 어떤 의미를 가지고 있으며, 어떤 경우에 어떻게 사용하는지를 설명한다.

      파라미터는 일반 글씨체와 이탤릭체를 사용한다.

      구분 설명

      일반 글씨체

      옵션을 표현한다. 사용자는 안내서에 기술된 그대로를 사용한다.

      이탤릭체

      사용자가 입력할 파라미터를 나타낸다. 해당하는 값을 사용자가 직접 입력한다.

      [ ]

      생략가능한 항목을 나타낸다. []로 묶여있지 않은 항목은 필수 항목이다.

      | 또는 /

      'or’를 나타내는 것으로 이것으로 구분된 파라미터들은 그 중에 하나만을 사용할 수 있다.

  • 파라미터 : 명령어에 사용할 수 있는 옵션, 인자 등 파라미터에 대해 설명한다.

  • 사용 예 : jeuadmin에서의 실제 사용 예와 출력되는 결과에 대해 간략하게 설명한다.