[WritingConvention]명령어 설명 규칙

Philip Sung·2022년 11월 23일
0

[WritingConvention]

목록 보기
2/4
post-thumbnail

01 개요

다루게 될 여러가지 함수나 명령어를 표기하기 위한 규칙이다. 가급적 표준을 따르려 하였으나, 정확한 표준을 찾지는 못한 관계로 가장 흔히 발견되는 규칙들을 사용하였다.

최종 수정일 : 2022.11.26



02 항목 설명

git branch option1 [option2] FILENAME ...

02.01 명령어

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


02.02 파라미터

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

02.02.01 일반 글씨체

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

02.02.02 이탤릭체

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

02.02.03 [ ]

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

02.02.04 | 또는 /

'or'를 나타내는 것으로 이것으로 구분된 파라미터들은 그 중에 하나만을 사용할 수 있다. 중괄호 {}와 함께 사용될 수 있다.

02.02.05 줄임표('...')

표현이 반복될 수 있음을 의미한다.



02.03 alias

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



02.04 기호

02.04.01 $

루트 권한이 없는 보통 사용자의 셸 프롬프트를 의미한다.

02.04.02 #

루트 사용자의 셸 프롬프트이다.

02.04.03 별표(*)

0개 이상의 문자들에 매치된다.

02.04.04 물음표(?)

한 개의 문자에 매치된다.

02.04.05 물결표(~)

현재 사용자의 홈 디렉터리를 의미한다. ~user는 user의 홈 디렉터리를 의미한다.

profile
Philip Sung

0개의 댓글