man_1_simple_shell

.TH man 1 "18 May 2022" "0.20" "HSH man page"
.SH NAME
.B hsh 
- Simple Shell Studying purpose Alx School of Software Engineering
.SH SYNOPSIS
.B ./hsh 
[command] [options] [FILE]
.SH COPYRIGHT
.B hsh 
is Copyright (C) Mendie Uwemedimo  and licensed under the MIT license.
.SH DESCRIPTION
.B hsh 
(Simple Shell) is an end of semester project for students at Alx School of Software Engineering where we explore, 
understand and build a working functional simple shell program.
.B Overview

The simple shell is a simplified iteration of a command line interpreter, similar to 
.B bash or 
.B dash. 
.I FORMAT [ARGUMENT]...
.SH OPTIONS
.B hsh
operates in both 
.I interactive 
and 
.I non-interactive
 mode. The user may initiate 
.B simple shell
and begin working or initate 
.B simple shell
using commands meant to be run by the program.
.SH ARGUMENTS
The first argument, argument 0 is understood to be the command to be run by 
.B simple shell
and arguments following as modifiers or options.
.SH INVOCATION
.B hsh
may be invoked with the same functionality in 
.I interactive 
or 
.I non-interactive 
mode.  The user may quit the program by typing "exit", "Ctrl + D",  on the command line.
When the program quits or a command has been executed, 
.B simple shell 
returns with a new prompt: "$ "

.B Example
.IP

$./hsh

($) pwd

Username@your-regular-prompt:~$

($)

($) /bin/pwd

Username@your-regular-prompt:~$
($)

.SH RESERVED WORDS
.B exit: 
quits the program, exits the shell.

.B env: 
prints the environment variables

.B setenv:
sets an environment variable

.B unsetenv:
unsets an environment variable

.SH SHELL BUILTIN COMMANDS
Environment Commands
.B setenv
,
.B unsetenv
The commands 
.B exit
,
.B env
,
.B cd
and
.B echo
is handled automatically by 
.B hsh

.SH SEE ALSO
.I sh(1)
,
.I bash(1)
,
.I _printf(3)

.SH BUGS
No Known bugs at the moment
Report 
.B hsh
bugs to https://github.com/Slamchillz/simple_shell/issues
.SH AUTHOR
Mendie Uwemedimo