TINYSH: MINIMAL SHELL

The purpose of the tinysh library is to provide a fully fonctional shell support to a system as soon as we are able to read/write characters to/from a device. This suits particularly well to embedded systems when developers just made the uart work.

As embedded systems often do not have full libc support, the library is written without any use of external functions nor include of any system header.

The package contains a main.c file that can be used as an example to demonstrate tinysh usage.

INSTALLATION

Run the commands: ./configure make all

You just built the ./tinysh program. Run it and type "help" for further instructions.

USING TINYSH

The application must pass every single input character to function tinysh_char_in. In addition, the application must provide a tinysh_char_out function to write characters to output device

For example:

void tinysh_char_out(unsigned char c)
{
   put_char_to_uart(c);
}
...
while(1)
{
   unsigned char c;
   c=get_char_from_uart(); /* we assume this fnt is blocking */
   tinysh_char_in(c);
}
... 

The application must provide each command by instantiating a tinysh_cmd_t structure:

typedef struct tinysh_cmd_t { struct tinysh_cmd_t parent; / 0 if top level command */ char name; / command input name, not 0 */ char help; / help string, can be 0 */ char usage; / usage string, can be 0 / tinysh_fnt_t function; / function to launch on cmd, can be 0 */ void arg; / current argument when function called */ struct tinysh_cmd_t next; / must be set to 0 at init */ struct tinysh_cmd_t child; / must be set to 0 at init */ } tinysh_cmd_t;

and passing the pointer to this structure to function tinysh_add_command.

For example:

void hello_fnt(int argc, char **argv) { printf("hello world\n"); }

tinysh_cmd_t hello_cmd={0,"hello","display hello","", hello_fnt,0,0,0};

... tinysh_add_command(&hello_cmd); ...

Read file main.c for more advanced usage.

TINYSH SUPPORTS

-command registration: application adds commands dynamically

-sub-commands: allows any number of command level. For instance: "$ memory read bytes