xref: /aosp_15_r20/external/toybox/toys/example/README (revision cf5a6c84e2b8763fc1a7db14496fd4742913b199)
1*cf5a6c84SAndroid Build Coastguard WorkerExample commands
2*cf5a6c84SAndroid Build Coastguard Worker
3*cf5a6c84SAndroid Build Coastguard WorkerYou probably don't want to deploy any of this.
4*cf5a6c84SAndroid Build Coastguard Worker
5*cf5a6c84SAndroid Build Coastguard WorkerThe hello.c and skeleton.c commands provide templates for new commands. When
6*cf5a6c84SAndroid Build Coastguard Workerwriting a new command, copying hello.c or skeleton.c to the new name may provide
7*cf5a6c84SAndroid Build Coastguard Workera good starting point. (The minimal staring point is toys/posix/false.c)
8*cf5a6c84SAndroid Build Coastguard Worker
9*cf5a6c84SAndroid Build Coastguard Worker  - hello.c is clean and simple, and an easy way to check the behavior of
10*cf5a6c84SAndroid Build Coastguard Worker    toybox library functions running in command context.
11*cf5a6c84SAndroid Build Coastguard Worker
12*cf5a6c84SAndroid Build Coastguard Worker  - skeleton.c demonstrates the option parsing infrastructure and having
13*cf5a6c84SAndroid Build Coastguard Worker    multiple commands per file.
14*cf5a6c84SAndroid Build Coastguard Worker
15*cf5a6c84SAndroid Build Coastguard WorkerSome of the commands in here are test infrastructure:
16*cf5a6c84SAndroid Build Coastguard Worker
17*cf5a6c84SAndroid Build Coastguard Worker  - logpath.c is optionally used by mkroot.sh and scripts/record-commands
18*cf5a6c84SAndroid Build Coastguard Worker
19*cf5a6c84SAndroid Build Coastguard Worker  - demo_* demonstrates infrastructure, allowing tests/demo_*.test to
20*cf5a6c84SAndroid Build Coastguard Worker    regression test library functions directly.
21*cf5a6c84SAndroid Build Coastguard Worker
22*cf5a6c84SAndroid Build Coastguard Workerhostid.c is an obsolete command still in posix and present on some recent
23*cf5a6c84SAndroid Build Coastguard WorkerLinux systems, but not really useful on modern systems.
24