simple_shell/man_1_simple_shell at master · monroy8888/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
.TH SIMPLE_SHELL 1 "27 November 2019" "1.0" "Holberton Simple Shell Manual"
.SH NAME
.B  Simple_Shell
- A simple re-creation of a command language interpreter.
.SH SYNOPSIS
.sp
.B man_1_simple_shell
[options] [command_string] [file]
.ad

.SH COMPILE

.B Compile:
gcc -Wall -Werror -Wextra -pedantic *.c -o hsh

.B Execute:
.I ./hsh

.SH DESCRIPTION

The
.B Simple_Shell
command-line interpreter that communicate with the operating system.
translates commands typed and convert it, into a computer lenguage,
interface between a user and the operatin system.

.SH BUILTINS

.B exit:
The
.I Exit
of the program.
.RS 0

.B env:
Display the
.I Enviroment
variables.
.RS 0

.SH EXAMPLE


.B ls
- To list directory contents use:

.B BIGSHELL$
ls [OPTION]... [FILE]...


.B pwd
- To print name of current/working directory:

.B BIGSHELL$
pwd [OPTION]...


.B cat
- To concatenate files and print on the standard output

.B BIGSHELL$
cat [OPTION]... [FILE]...

.SH RETURN VALUE

Upon successful return, this function return the specific command typed.

.B BIGSHELL$
[known command]...

.B BIGSHELL$
[command requested]...

If the command typed its unknown it will display:

.B BIGSHELL$
[unknown command]

.B BIGSHELL$
[attempt number]... : [unknown command]... : not found.

.SH SEE ALSO
sh(1), bash(2)

.SH BUGS
No known bugs.
.SH AUTHORS
Sergio Quiroga - Alexander Urrego