dino-corry / simple_shell

simple_shell

Simple Shell Project

Table of Contents

• Description
• File Structure
• Requirements
• Quick Start
• Usage
• Man page
• Example of Use
• Bugs
• Authors

Description

This is collaborative project made by Dino & Temitope with the help of Nfon Andrew repository, students of Software Engineering at Alx School. It simply consists of us trying to develop and make our own UNIX command line interpreter (Shell).

It's a recreation of the sh shell a command line interpreter. This program has the exact same output as sh (/bin/sh) as well as the exact same error output

File Structure

These are the files with the custom funtions and system calls, each one contains a brief description:

File	*Description
main.h	Header file with the prototypes
man_1_simple_shell	Manual Page
README.md	Readme.md file
AUTHORS	AUTHORS file list of contributors
'free_list.c'	Frees LinkList
'linkpath.c'	-creates a singly linked list for PATH directories
	-adds a node in a singly linked list
	-creates a singly linked list for PATH directories
	-creates a singly linked list for PATH directories
'string.c'	prints a character,
prints a string,
gives the length of a string
copies a string in a newly allocated memory
concatenates 3 strings in a newly allocated memory
'line_exec.c'	splits a string into an array of words,
executes a command using execve,
reallocates a memory block,
frees a 2 dimensional array
'checkbuild.c'	checks if a command is a build-in command
'buildin.c' handles the exit buildin command
converts a string into an integer
prints the current environment
Initialize or modify and existinig global
remove a global variable
=============================================================================================

List of allowed functions and system calls for this project

• access (man 2 access)
• chdir (man 2 chdir)
• close (man 2 close)
• closedir (man 3 closedir)
• execve (man 2 execve)
• exit (man 3 exit)
• _exit (man 2 _exit)
• fflush (man 3 fflush)
• fork (man 2 fork)
• free (man 3 free)
• getcwd (man 3 getcwd)
• getline (man 3 getline)
• isatty (man 3 isatty)
• kill (man 2 kill)
• malloc (man 3 malloc)
• open (man 2 open)
• opendir (man 3 opendir)
• perror (man 3 perror)
• read (man 2 read)
• readdir (man 3 readdir)
• signal (man 2 signal)
• stat (__xstat) (man 2 stat)
• lstat (__lxstat) (man 2 lstat)
• fstat (__fxstat) (man 2 fstat)
• strtok (man 3 strtok)
• wait (man 2 wait)
• waitpid (man 2 waitpid)
• wait3 (man 2 wait3)
• wait4 (man 2 wait4)
• write (man 2 write)

---

USAGE

You can try our shell by following these steps:

Step 1: Clone our repository using this command, (you need to have git installed on your machine first)

git clone https://github.com/dino-corry/simple_shell

Step 2: Navigate into the simple-shell directory using:

cd simple_shell

Step 3: Compile the C files as follows:

gcc -Wall -Werror -Wextra -pedantic *.c -o hsh

Step 4: Run the shell

./hsh

Quitting To Exit the shell, you can use any of the following commands:

1: Type the command "exit"

exit

2: Press on Ctrl + D

Example of Usage

┌──(dino㉿work-spaces)-[~/alx/skk]
└─$ ./hsh
#Shell$ ls -;
/usr/bin/ls: invalid option -- ';'
Try '/usr/bin/ls --help' for more information.

#Shell$ pwd
/home/dino/alx/skk

Bugs

No known Bugs.

TEAM

Dino corry Temitope