summaryrefslogtreecommitdiff
path: root/documentation/0.doxygen/finsh.h
blob: e451c89590b012172589ad8b0870a0634ed66e46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
 * This file is only used for doxygen document generation.
 */

/**
 * @defgroup group_finsh finsh shell
 *
 * @brief finsh shell is a user command shell in RT-Thread RTOS.
 *
 * finsh shell is a user command shell in RT-Thread RTOS, which is a shell can
 * accept C-expression like syntax in command. From finsh shell, user can access
 * system area, such as memory, variables and function by input C-expression in
 * command.
 *
 * @image html finsh.png "Figure 3: finsh shell architecture"
 * There is a shell thread, which named as "tshell", in the finsh shell, it read
 * user command from console device, and then invokes system function or access
 * system variable to output result (by rt_kprintf).
 */