maggicl/msh-console
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated README

Browse source
This commit is contained in:
Claudio Maggioni 2018-12-27 13:35:54 +01:00
parent 46bc7347a7
commit 624a838f1a
1 changed files with 38 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -1,19 +1,41 @@
# Msh-console
Library that provides a bash-like command line for C++ programs. Features included:
* included flag handling implemented with popt.h;
* creation of personalized commands in the same thread of the shell or in other threads;
* basic shell functionalities, such as execution of other programs in the system. This is implemented with execvp().
* piping, implemented with <unistd.h> pipe() function. Code based on http://stackoverflow.com/a/5207730.
<!-- vim: set et ts=2 sw=2 tw=80 : -->
# msh-console
Library that provides a bash-like command line interface for C++ programs.
## Abandoned
This was my first OOP project, so pardon the style and the conventions taken.
This project is currently unmantained.
## Features include:
* flag handling implemented with `popt.h`;
* creation of personalized commands in the same thread of the shell or in other
threads;
* basic shell functionalities, such as execution of other programs in the
system. This is implemented with `execvp()`.
* piping, implemented with `<unistd.h>` `pipe()` function. Code based on
https://stackoverflow.com/a/5207730.
## What is not actually included:
What is not actually included:
* advanced shell features, like:
* redirection,
* scripting,
* command history.
### Credits
Code based on "Write a Shell in C" tutorial by Stephen Brennan (http://brennan.io/2015/01/16/write-a-shell-in-c/).
The code has been slightly modified.
The code contains stringtoargcargv.cpp, a set of functions written by Bernhard Eder (http://web.archive.org/web/20121030075237/http://bbgen.net/blog/2011/06/string-to-argc-argv) for parsing a string into argc and argv.
### Compiling
The library can be compiled as shared library with the CMakeLists.txt file already in msh-console-library/.
## Credits
Code based on
["Write a Shell in C"](http://brennan.io/2015/01/16/write-a-shell-in-c/)
tutorial by Stephen Brennan. The code contains `stringtoargcargv.cpp`, a set of
functions written by Bernhard Eder
[here](http://web.archive.org/web/20121030075237/http://bbgen.net/blog/2011/06/string-to-argc-argv)
for parsing a string into `argc` and `argv`.
## Compiling
The library can be compiled as shared library with the CMakeLists.txt file
already in `msh-console-library/`.