simple_shell/man_1_simple_shell at master · danielcinome/simple_shell · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
.Dd 11/27/2019
.Dt _Simple_Shell
.Os HolbertonSchool
.Sh NAME
.Nm _Simple_Shell - Our own Command interpreter for holberton
.Sh SYNOPSIS
.Xr ./hsh [command] [arguments] [options]
.Sh DESCRIPTION
This is a command interpreter that will read command from the standard input and perform actions.

.LP
.IP How to use
The shell can be used by typing the ./hsh in the terminal and then it will be executed and the user will be able to enter commands. When the shell is used this way it is called an interactive mode of use. The shell can also be executed by entering something from another terminal and pass that stdout to the stdin from the custom shell.


.LP
.IP Commands
The custom shell is able to interpret the line the user enters depending on the way the user enters it. These are some examples of available commands:

- pwd: Shows the current path

	pwd [OPTION]...

- ls: List files and directories

	ls [OPTION]... [FILE]...

- echo: Prints in the standard output

	echo LONG-OPTION

- mkdir: Creates directories

	mkdir [OPTION]... DIRECTORY...

- vim: Text editor

	vim [options] [file ..]

- rm: Remove files

	rm [OPTION]... FILE...

- cp: Copy files

	cp [OPTION]... SOURCE... DIRECTORY

- mv: Move or rename files

	mv [OPTION]... SOURCE... DIRECTORY

	Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.

- touch: Create files

	touch [OPTION]... FILE...

- exit: causes normal process termination

- env: run a program in a modified environment

.LP
.Sh EXAMPLES
.RE
#cisfun$ ls
.LP


01_simple_shell_0.1    AUTHORS			hsh
02_simple_shell_0.1.1  README.md		ls
03_simple_shell_0.2    check_simple_shell.bash	simple_shell
05_simple_shell_0.3    config

.LP
#cisfun$ echo "Hola Mundo"
.LS


Hola Mundo

.LP
.SH EXIT STATUS
When the shell is executed correctly it will return a zero status. Otherwise it is because a failure.

.Sh AUTHORS
Written by
.Bl -tag -width -indent
.It Pa Camilo Andres Morales
.It Pa Daniel Angarita Chinome