man_1_simple_shell

.TH hsh 1 "August 28, 2019" "1.0" "hsh General Commands Manual"

.SH NAME

.B simple_shell - hsh
- command line interpreter or shell


.SH SYNOPSIS

.B  ./hsh


.SH DESCRIPTION

simple_shell is a command line interpreter. It is a program that executes other programs, the user can run different commands or utilities/tools with some input data.


.SH OVERVIEW

simple_shell executes commands that the user puts on the terminal.

.B ls
- It is used to list information about files and directories within the file system. The ls utility is a part of the GNU core utilities which are installed on all Linux distributions.

.SH INVOCATION

Compile simple_shell with the GNU Compiler Collection:
.P
.RS
.B $ gcc -Wall -Werror -Wextra -pedantic *.c -o hsh
.P
.RE
This shell works in two modes:
.TP
.B Interactive Mode
.TP
The shell read the commands from the standard input and executes them.
.TP
.B Non-interactive Mode
.TP
Reads the commands from a file sent thru a pipe, the commands will be executed.


.SH BUILTINS

The following builtin commands are supported:

.IT
.B env
- prints the environment variables

.B exit
- exits the program

Example of builtin command:
.IP
.br
.\&
.RS
\&$ env
.br
\&TERM=xterm-256color
.br
\&SHELL=/bin/bash
.br
\&SSH_CLIENT=10.0.2.2 50610 22
.br
\&SSH_TTY=/dev/pts/0
.br
\&USER=vagrant
.br
\&MAIL=/var/mail/vagrant
.br
\&PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games
.br
\&PWD=/home/vagrant/simple_shell
.br
\&LANG=en_US.UTF-8
.br
\&SHLVL=1
.br
\&HOME=/home/vagrant
.br
\&LOGNAME=vagrant
.br
\&SSH_CONNECTION=10.0.2.2 50610 10.0.2.15 22
.br
\&LESSOPEN=| /usr/bin/lesspipe %s
.br
\&XDG_RUNTIME_DIR=/run/user/1000
.br
\&LESSCLOSE=/usr/bin/lesspipe %s %s
br.
\&OLDPWD=/home/vagrant
.br
\&_=./hsh


.SH BUGS
No known bugs.

.SH AUTHOR

Albéniz Martínez, Kelly Villa

.SH SEE ALSO
sh