shell.h File Reference

    Main header file for the Contiki shell

More...

#include "sys/process.h"
#include "shell-base64.h"
#include "shell-blink.h"
#include "shell-collect-view.h"
#include "shell-coffee.h"
#include "shell-download.h"
#include "shell-exec.h"
#include "shell-file.h"
#include "shell-httpd.h"
#include "shell-irc.h"
#include "shell-memdebug.h"
#include "shell-netfile.h"
#include "shell-netperf.h"
#include "shell-netstat.h"
#include "shell-ping.h"
#include "shell-power.h"
#include "shell-powertrace.h"
#include "shell-ps.h"
#include "shell-reboot.h"
#include "shell-rime-debug.h"
#include "shell-rime-debug-runicast.h"
#include "shell-rime-neighbors.h"
#include "shell-rime-netcmd.h"
#include "shell-rime-ping.h"
#include "shell-rime-sendcmd.h"
#include "shell-rime-sniff.h"
#include "shell-rime-unicast.h"
#include "shell-rime.h"
#include "shell-rsh.h"
#include "shell-run.h"
#include "shell-sendtest.h"
#include "shell-sky.h"
#include "shell-tcpsend.h"
#include "shell-text.h"
#include "shell-time.h"
#include "shell-udpsend.h"
#include "shell-vars.h"
#include "shell-wget.h"

Go to the source code of this file.

Data Structures
struct	shell_command
	Holds a information about a shell command. More...
struct	shell_input
	Structure for shell input data. More...

Functions
Shell back-end API
The shell back-end API contains functions that are used by shell back-ends.
void	shell_init (void)
	Initialize the shell. More...
void	shell_start (void)
	Start the shell. More...
void	shell_input (char *commandline, int commandline_len)
	Send a line of input to the shell. More...
void	shell_stop (void)
	Stop the shell. More...
void	shell_quit (void)
	Quit the shell. More...
Shell back-end callback functions
These callback functions are called from the shell to the shell back-end. The shell back-end must implement all back-end callback functions.
void	shell_prompt (char *prompt)
	Print a prompt. More...
void	shell_default_output (const char *data1, int size1, const char *data2, int size2)
	Print a line of output from the shell. More...
void	shell_exit (void)
	Request shell exit. More...
Shell convenience functions
These functions assist shell commands in parsing command lines
unsigned long	shell_strtolong (const char *str, const char **retstr)
	Convert a string to a number. More...
unsigned long	shell_time (void)
void	shell_set_time (unsigned long seconds)

Shell command API
These functions are used by shell commands.
#define	SHELL_COMMAND(name, command, description, process)
	Define a shell command. More...
void	shell_output (struct shell_command *c, void *data1, int size1, const void *data2, int size2)
	Output data from a shell command. More...
void	shell_output_str (struct shell_command *c, char *str1, const char *str2)
	Output strings from a shell command. More...
void	shell_register_command (struct shell_command *c)
	Register a command with the shell. More...
void	shell_unregister_command (struct shell_command *c)
	Unregister a previously registered shell command. More...
int	shell_start_command (char *commandline, int commandline_len, struct shell_command *child, struct process **started_process)
	Start a shell command from another shell command. More...

Shell variables, definitions, and return values
enum	shell_retval
int	shell_event_input
	The event number for shell input data. More...

Detailed Description

    Main header file for the Contiki shell

Author

Adam Dunkels adam@.nosp@m.sics.nosp@m..se

Definition in file shell.h.