esp-idf-bootloader: where needed, add apeos copyright lines to /components/bootloader...
[apeos.git] / doc / shell.txt
blob7b862c129ffea10a117e43c8ca67e3ca10774b8a
1 Copyright 2018 apeos contributors
3 The boot process ends with apeos providing interactive text shell on
4 UART0.
6 The shell allows execution of programs. Programs accept parameters
7 through C-runtime-like argc/argv mechanism. For receiving input and
8 providing output to user running them, programs have access to
9 two C-runtime-like streams: stdin and stdout. These two streams are
10 the primary mean for interacting with user that ordered program
11 execution.
13 Programs are implemented as C-like functions, with program entry code
14 residing at address fixed when the esp-idf application providing them
15 is built. Thus, program execution is a matter of parsing the
16 command-line, converting the parse result to argc/argv and calling
17 a function with ABI fixed for all apeos programs.