path: root/include/applets.src.h (plain)
blob: 2ddf120ad4b9eb55cbe234a2e35216418cef31e0

1	/* vi: set sw=4 ts=4: */
2	/*
3	* applets.h - a listing of all busybox applets.
4	*
5	* If you write a new applet, you need to add an entry to this list to make
6	* busybox aware of it.
7	*/
8
9	/*
10	name - applet name as it is typed on command line
11	help - applet name, converted to C (ether-wake: help = ether_wake)
12	main - corresponding <applet>_main to call (bzcat: main = bunzip2)
13	l - location to install link to: [/usr]/[s]bin
14	s - suid type:
15	BB_SUID_REQUIRE: will complain if busybox isn't suid
16	and is run by non-root (applet_main() will not be called at all)
17	BB_SUID_DROP: will drop suid prior to applet_main()
18	BB_SUID_MAYBE: neither of the above
19	(every instance of BB_SUID_REQUIRE and BB_SUID_MAYBE
20	needs to be justified in comment)
21	NB: please update FEATURE_SUID help text whenever you add/remove
22	BB_SUID_REQUIRE or BB_SUID_MAYBE applet.
23	*/
24
25	#if defined(PROTOTYPES)
26	# define APPLET(name,l,s) int name##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
27	# define APPLET_ODDNAME(name,main,l,s,help) int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
28	# define APPLET_NOEXEC(name,main,l,s,help) int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
29	# define APPLET_NOFORK(name,main,l,s,help) int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
30
31	#elif defined(NAME_MAIN)
32	# define APPLET(name,l,s) name name##_main
33	# define APPLET_ODDNAME(name,main,l,s,help) name main##_main
34	# define APPLET_NOEXEC(name,main,l,s,help) name main##_main
35	# define APPLET_NOFORK(name,main,l,s,help) name main##_main
36
37	#elif defined(MAKE_USAGE) && ENABLE_FEATURE_VERBOSE_USAGE
38	# define APPLET(name,l,s) MAKE_USAGE(#name, name##_trivial_usage name##_full_usage)
39	# define APPLET_ODDNAME(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
40	# define APPLET_NOEXEC(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
41	# define APPLET_NOFORK(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
42
43	#elif defined(MAKE_USAGE) && !ENABLE_FEATURE_VERBOSE_USAGE
44	# define APPLET(name,l,s) MAKE_USAGE(#name, name##_trivial_usage)
45	# define APPLET_ODDNAME(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage)
46	# define APPLET_NOEXEC(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage)
47	# define APPLET_NOFORK(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage)
48
49	#elif defined(MAKE_LINKS)
50	# define APPLET(name,l,c) LINK l name
51	# define APPLET_ODDNAME(name,main,l,s,help) LINK l name
52	# define APPLET_NOEXEC(name,main,l,s,help) LINK l name
53	# define APPLET_NOFORK(name,main,l,s,help) LINK l name
54
55	#elif defined(MAKE_SUID)
56	# define APPLET(name,l,s) SUID s l name
57	# define APPLET_ODDNAME(name,main,l,s,help) SUID s l name
58	# define APPLET_NOEXEC(name,main,l,s,help) SUID s l name
59	# define APPLET_NOFORK(name,main,l,s,help) SUID s l name
60
61	#else
62	static struct bb_applet applets[] = { /* name, main, location, need_suid */
63	# define APPLET(name,l,s) { #name, #name, l, s },
64	# define APPLET_ODDNAME(name,main,l,s,help) { #name, #main, l, s },
65	# define APPLET_NOEXEC(name,main,l,s,help) { #name, #main, l, s, 1 },
66	# define APPLET_NOFORK(name,main,l,s,help) { #name, #main, l, s, 1, 1 },
67	#endif
68
69	#if ENABLE_INSTALL_NO_USR
70	# define BB_DIR_USR_BIN BB_DIR_BIN
71	# define BB_DIR_USR_SBIN BB_DIR_SBIN
72	#endif
73
74
75	INSERT
76
77
78	#if !defined(PROTOTYPES) && !defined(NAME_MAIN) && !defined(MAKE_USAGE) \
79	&& !defined(MAKE_LINKS) && !defined(MAKE_SUID)
80	};
81	#endif
82
83	#undef APPLET
84	#undef APPLET_ODDNAME
85	#undef APPLET_NOEXEC
86	#undef APPLET_NOFORK
87