man_1_simple_shell

Simple Shell man page.
.TH man 1

.TH "Shell's Bells - Simple Shell Project" 1 "14 April 2019" "1.0" 

.SH NAME
hsh - Shell's Bells - Simple Shell

.SH SYNOPSIS
hsh -the prototype of our main function is as follows: int main(int argc __attribute__((unused)), char **argv, char **env);
            
The header file is called holberton.h where all the prototypes, structures and libraries used in our shell are referenced.

.SH DESCRIPTION
Welcome to the Robert-Martin Simple Shell Project this shell can be compiled and run from the command line, it includes basic features, as well as some advanced features found in most shell programs.

.SH OVERVIEW
The Robert-Martin Shell's Bells - Simple Shell project is a team project carried out by Robert Castellanos and Andres Martin, students at Holberton School Colombia, for educational purposes. Its main purpose is to develop our own clone of a shell version based on the ones found in Ubuntu Linux distributions. The main goal for us was to learn, develop, deploy and work collaboratively on our own Shell.

.SH RETURN VALUE
The shell returns the error code given by the last run command, also either ctrl-d or exit, by default the main function returns 0.

.SH SYNTAX
†Shell's Bells† <command> <flags>
.SS
OR NON-INTERACTIVE MODE:
$ echo "<command>" | ./hsh

.SS Interactive mode:


.SS
EXAMPLES:
.SS
ls command:
†Shell's Bells† ls -1
.SS
pwd command:
†Shell's Bells† pwd
.SS
cd command:
†Shell's Bells† cd ..
.SS
help command:
†Shell's Bells† help <builtin command>
.SS
# comments
†Shell's Bells† echo Hello # World
Hello

.SH BUILTIN COMMANDS
Our Shell supports a variety of builtin commands:

.SS exit
- exits the Shell

.SS env
- prints the environment variables.

.SS setenv
- sets an environment variable.

.SS unsetenv
- unsets an environment variable.

.SS cd
- changes directory.

.SS help
- displays help for builtin commands.

.SS Bonus

.SS welcome
- displays a welcome message
.SS bart
- shows Bart Simpson 

.SH SEE ALSO
BASH(1)

.SH BUGS
No known bugs

.SH AUTHORS
Robert Castellanos
    770@holbertonschool.com
    https://github.com/sebascastel

Andres Martin
    786@holbertonschool.com
    https://github.com/andres-martin