Help files - 도움말 페이지

hyperskill - Help files 영어 원문

터미널에서 작업 할 때, 상당량의 명령어를 사용해야 합니다.

명령어들이 모두 어떻게 작동하며, 해당 명령어가 어떤 옵션을 가지고 있는지 기억하는 것은 어렵습니다.

지정된 명령어를 위해 도움을 얻는 곳을 기억하는 것이 훨씬 쉽습니다.

명령어와 해당 옵션을 모두 기억하는 것 보다, 명령어에 대한 가이드를 얻을 수 있는 명령어를 치는 게 더 쉽다는 뜻입니다.

따라서, 작업을 시작하기 전에, 당신은 관련된 문서를 읽고, 무슨 일이 일어나는지 명확한 생각을 가질 수 있습니다.

이러한 정보를 얻기 위해서, 당신은 따라오는 세 가지 명령어와 시작 할 겁니다 : man, whatis, tldr.

위의 세 명령어들은 다른 명령어들에 대한 정보를 나눠 주지만, 자세함의 정도가 다릅니다.

이 세가지 명령어에 대해서 더 가까이 보면서, man 명령어로 시작하겠습니다.

Man pages - 메뉴얼 페이지

---

Man 명령어는 Manual의 약자입니다.

이는 유닉스 명령어인데, 메뉴얼 페이지를 구성하고 표시하기 위함입니다.

Man 명령어는 UNIX-like 배포판들에 함께 제공되므로, 따로 추가적으로 설치 할 필요가 없습니다.

각각의 man 도움 페이지는 각각의 소프트웨어 개발자들에 의해 작성된 독립형 문서입니다.

help pages (도움 페이지) 는 8개의 표준 섹션과 하나의 추가적인 섹션으로 나누어져 있습니다.

각각의 섹션은 설치된 운영체제에 따라 특정 주제에 해당합니다.

우리는 어플리케이션과 shell 명령어들을 위한 첫 번째 페이지만 고려 할 겁니다.

또한 Linux Man 공식 홈페이지 에 들어가서 다른 섹션에 대해 읽을 수 있습니다.

우리는 밑에서 man 명령어를 사용해서 ls 명령을 위한 문서를 찾는 방법을 볼 수 있습니다.

Using man - man 명령어 사용하기

---

man을 사용하기 위해서, 터미널에 man <the command name>을 작성해야 하며, 엔터를 누르세요.

예를 들어 :

$ man ls
LS(1)                                                                                    General Commands Manual                                                                                    LS(1)

NAME
     ls – list directory contents

SYNOPSIS
     ls [-@ABCFGHILOPRSTUWabcdefghiklmnopqrstuvwxy1%,] [--color=when] [-D format] [file ...]

DESCRIPTION
     For each operand that names a file of a type other than directory, ls displays its name as well as any requested, associated information.  For each operand that names a file of type directory, ls
     displays the names of files contained within that directory, as well as any requested, associated information.

해당 명령어 도움 페이지에 입성하게 되면 VIM 의 페이지 이동 방법을 알아야 합니다.

• h : 왼쪽
• j : 아래
• k : 위쪽
• l : 오른쪽

이는 페이지의 한 부분입니다.

각 페이지는 여러 섹션으로 나누어져 있습니다.

당신은 여러 섹션 중 일부를 볼 수 있으며, 모든 리스트는 밑과 같습니다 :

• NAME (이름) - 프로그램 혹은 명령어의 이름과 이것에 대한 짧은 설명
• SYNOPSIS (개요) - 명령어 구문과 이 명령어에 전달되는 옵션 순서
• DESCRIPTION (설명) - 명령어에 대한 더 자세한 설명
• CONFIGURATION (구성) - 프로그램 세팅
• OPTIONS (옵션) - 명령어 옵션들
• EXAMPLE (예시) - 사용 예시들
• AUTHORS (저자) - 프로그램의 저자

지금 당신은 man 페이지가 무엇인지 압니다.

이러한 페이지들은 누구나 제작 할 수 있습니다.

그리고 당신의 여러 프로젝트의 man 페이지를 제작하기로 결정했다면, man page guide 를 사용할 겁니다.

정보를 보거나, help page를 관리하기 위해서, 위 / 아래 화살표 키를 사용 할 수 있습니다.

e 와 j 는 한 줄을 내려가며, z 는 한 페이지를 내려갑니다.

/ 는 당신이 현재 있는 줄에서 밑에 있는 컨텐츠 중 해당되는 글자를 찾습니다.

이러한 Help 시스템의 hotkey 그리고 명령어에 대한 빠른 참조를 원한다면, h 를 누르세요.

help system을 나가고자 한다면, q 를 누르세요.

man 명령어는 많은 정보를 줍니다. 특히 초보자들에게는, 한 번에 모든 것을 읽기에는 불편합니다.

그러므로, tldr 명령어가 있습니다.

tldr 명령어는 문서의 단축된 버전을 생성합니다.

밑에서 우리는 이를 어떻게 작동하며, 여러 예시를 공부하는지를 공부 할 겁니다.

TLDR command - TLDR 명령어

---

TLDR 명령어는 Too - Long - Didn't - Read 의 약자이며,

TLDR은 "간단한 것만 모았으며, 커뮤니티에 좌우되는 메뉴얼 페이지" 로 설명됩니다.

주요 프로덕트는 사실 Markdown 파일들의 라이브러리이며,

Markdown 은 유명한 콘솔 유틸리티들을 위해 메뉴얼 페이지들을 대체하고 있습니다.

현재 이를 번역하고 있는 저도 Markdown 을 사용해서 문서를 만듭니다.

이들 중 대부분은 일반적이거나, 리눅스 카테고리에 있습니다.

하지만, 심지어 macOS 와 Windows 를 위한 별도의 페이지도 있습니다.

명령어는 이미 설치되어 있지 않으며, 이를 사용하고자 한다면, 당신은 설치해야 합니다.

설치할 수 있는 여러 방법이 있습니다.

예를 들어, 당신은 밑의 명령어들 중 하나를 선택 할 겁니다 :

1. Node.js

TLDR 에 접근하는 첫 번째 방식은 Node.js 를 지원하고 있는 클라이언트 중 하나에 설치하는 겁니다.

다음으로, 밑의 명령어를 사용하여 NPM 으로부터 TLDR 을 설치 할 수 있습니다

$ sudo npm install -g tldr

2. snap

두 번째 방법은 snap 시스템을 사용하는 겁니다. 당신이 snap 이 설치되었는지 확인하는 것을 잊지 마세요!

macOS 에서는 brew 가 유명합니다.

$ sudo snap install tldr

3. apt

마지막은 apt 라는 패키지 매너저의 리스트에 설치하는 겁니다.

$ sudo apt install tldr

당신이 tldr을 설치하고 난 후, 이를 사용할 준비가 되었습니다!

TLDR 사용법

---

tldr 명령어를 사용하기 위해서, 당신은 tldr <command name> 을 치고, 엔터를 눌러야 합니다.

예를 들어 :

$ tldr ls
ls

List directory contents.
More information: <https://www.gnu.org/software/coreutils/ls>.

- List files one per line:
    ls -1

- List all files, including hidden files:
    ls -a

- List all files, with trailing `/` added to directory names:
    ls -F

- Long format list (permissions, ownership, size, and modification date) of all files:
    ls -la

- Long format list with size displayed using human-readable units (KiB, MiB, GiB):
    ls -lh

- Long format list sorted by size (descending) recursively:
    ls -lSR

- Long format list of all files, sorted by modification date (oldest first):
    ls -ltr

- Only list directories:
    ls -d */

결과를 보건대, 당신은 짧은 설명과 명령어의 기초적인 파라미터들을 받았을 겁니다.

이러한 지침들은 읽기엔 많이 빠를 수 있지만, man 보다는 자세함에 있어서는 멀리 떨어져 있습니다.

그리고 당신이 원한다면, 더 많은 정보가 있는 링크가 tldr의 결과 위쪽에 있습니다.

하지만, 파라미터들을 이해할 시간이 없거나, 혹은 그냥 불필요 할 경우, 유틸리티에 대한 간단한 설명으로 간소화 할 수 있습니다.

이 간소화 된 설명은 whatis 명령어로 주어집니다.

밑에서 이에 대해 간단히 다루겠습니다.

Whatis command - Whatis 명령어

---

whatis 명령어는 실제로 당신 앞에 어떤 유형의 유틸리티인지에 대해서 대답합니다.

whatis 를 설치 할 필요가 없습니다.

whatis 구문은 전의 명령어들의 구문과 비슷합니다.

당신은 그저 whatis <command name> 을 입력하고 엔터를 누르면 됩니다.

결과로, 당신은 질문한 명령어의 목적에 대한 짧은 메세지를 얻을 수 있습니다.

예를 들어 :

$ whatis ls
ls (1)               - list directory contents

macOS 에서는 왠지 모르겠는데, 위의 결과와 매우 다르게 나옵니다.

안 될 경우, man 혹은 tldr 를 설치하여 쓰는 것이 좋을 것 같습니다.

Conclusion - 결론

---

요약하자면, 지금 당신은 man, tldr, whatis

이 세 가지 명령어를 사용해서 어떠한 shell 명령어이던 정보를 찾을 수 있습니다.

모든 명령어들에 대해서 사용 할 수 있으며, 그냥 하나를 선택해서 사용할 수 있습니다.

명령어 선택은 당신이 필요로 하는 자세함의 정도에 의존합니다.

man 명령어는 완벽한 지침 메뉴얼을 주며,

tldr은 요약 된 버전이며,

whatis 명령어는 해당 명령어가 실제로 하는 것에 대해서 알게 해 줍니다.

세 명령어 비교하기

디테일

man >> tldr >> whatis

간단함

man << tldr << whatis

words to remember

---

What lies ahead : 앞에 무슨 일이..

give out : 나눠주다

differ : 다르다

stand-alone : 독립형, 고립하다, 고립되어 있다

as well as : 게다가, ~와 마찬가지로 잘

abridged : 요약된, 요약하다, 단축하다

instructions : 지침, 명령