[BusyBox] documentation patch and what's missing.
Terje Kvernes
terjekv at math.uio.no
Sun Jul 20 23:00:08 UTC 2003
right. this covers most of whats missing in the help texts. the
stuff that is left are the following tidbits that I was unable to
understand well enough to dare to document.
from miscutils/Config.in:
* CONFIG_DUTMP
* CONFIG_MAKEDEVS
* CONFIG_UPDATE
* CONFIG_WATCHDOG
(miscutils is a bit of a pain to try to understand, I'll have
another go some time soon if noone else feels like it.)
from shell/Config.in
* CONFIG_ASH_CMDCMD
from modutils/Config.in
* CONFIG_FEATURE_INSMOD_LOADINKMEM
from networking/Config.in
* CONFIG_FEATURE_TRACEROUTE_SO_DEBUG
now, without further ado, the patch itself:
diff -ur busybox/editors/Config.in busybox-patched/editors/Config.in
--- busybox/editors/Config.in 2003-07-14 21:36:55.000000000 +0200
+++ busybox-patched/editors/Config.in 2003-07-21 00:21:28.337885754 +0200
@@ -56,35 +56,40 @@
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ Enable a limited set of colon commands for vi. This does not
+ provide an "ex" mode.
config CONFIG_FEATURE_VI_YANKMARK
bool " Enable yank/put commands and mark cmds"
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ This will enable you to use yank and put, as well as mark in
+ busybox vi.
config CONFIG_FEATURE_VI_SEARCH
bool " Enable search and replace cmds"
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ Select this if you wish to be able to do search and replace in
+ busybox vi.
config CONFIG_FEATURE_VI_USE_SIGNALS
bool " Catch signals"
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ Selecting this option will make busybox vi signal aware. This will
+ make busybox vi support SIGWINCH to deal with Window Changes, catch
+ Ctrl-Z and Ctrl-C and alarms.
config CONFIG_FEATURE_VI_DOT_CMD
bool " Remember previous cmd and \".\" cmd"
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ Make busybox vi remember the last command and be able to repeat it.
config CONFIG_FEATURE_VI_READONLY
bool " Enable -R option and \"view\" mode"
@@ -99,28 +104,29 @@
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ Enable the editor to set some (ai, ic, showmatch) options.
config CONFIG_FEATURE_VI_SET
bool " Support for :set"
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ Support for ":set".
config CONFIG_FEATURE_VI_WIN_RESIZE
bool " Handle window resize"
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ Make busybox vi behave nicely with terminals that get resized.
config CONFIG_FEATURE_VI_OPTIMIZE_CURSOR
bool " Optimize cursor movement"
default y
depends on CONFIG_VI
help
- Please submit a patch to add help text for this item.
+ This will make the cursor movement faster, but requires more memory
+ and it makes the applet a tiny bit larger.
endmenu
diff -ur busybox/loginutils/Config.in busybox-patched/loginutils/Config.in
--- busybox/loginutils/Config.in 2003-07-15 09:15:03.000000000 +0200
+++ busybox-patched/loginutils/Config.in 2003-07-20 23:07:51.626573517 +0200
@@ -55,7 +55,7 @@
bool "getty"
default n
help
- Please submit a patch to add help text for this item.
+ Getty lets you log in on a tty, it is normally invoked by init.
config CONFIG_LOGIN
bool "login"
@@ -99,7 +99,7 @@
bool "vlock"
default n
help
- Please submit a patch to add help text for this item.
+ Build the "vlock" applet, that allows you to lock (virtual) terminals.
comment "Common options for adduser, deluser, login, su"
depends on CONFIG_ADDUSER || CONFIG_DELUSER || CONFIG_LOGIN || CONFIG_SU
@@ -109,14 +109,16 @@
default n
depends on CONFIG_ADDUSER || CONFIG_DELUSER || CONFIG_LOGIN || CONFIG_SU
help
- Please submit a patch to add help text for this item.
+ Build support for shadow password in /etc/shadow. This file is only
+ only readable by root and thus the encrypted passwords are no longer
+ publicly readable.
config CONFIG_USE_BB_SHADOW
bool " Use busybox shadow password functions"
default n
depends on CONFIG_USE_BB_PWD_GRP && CONFIG_FEATURE_SHADOWPASSWDS
help
- Please submit a patch to add help text for this item.
+ Build this if you want busybox to provide support for shadow passwords.
endmenu
diff -ur busybox/modutils/Config.in busybox-patched/modutils/Config.in
--- busybox/modutils/Config.in 2003-07-14 21:36:59.000000000 +0200
+++ busybox-patched/modutils/Config.in 2003-07-21 00:32:38.310969994 +0200
@@ -16,7 +16,7 @@
default n
depends on CONFIG_INSMOD
help
- Please submit a patch to add help text for this item.
+ Provide insmod support for older (pre 2.1) Linux kernels.
if CONFIG_INSMOD && !CONFIG_FEATURE_OLD_MODULE_INTERFACE
config CONFIG_FEATURE_NEW_MODULE_INTERFACE
@@ -30,7 +30,7 @@
default y
depends on CONFIG_INSMOD
help
- Please submit a patch to add help text for this item.
+ Support module loading for newer (post 2.1) Linux kernels.
endif
config CONFIG_FEATURE_INSMOD_VERSION_CHECKING
@@ -38,7 +38,8 @@
default n
depends on CONFIG_INSMOD
help
- Please submit a patch to add help text for this item.
+ Support checking of versions for modules. This is used to
+ ensure that the kernel and module are made for each other.
config CONFIG_FEATURE_INSMOD_KSYMOOPS_SYMBOLS
bool " Add module symbols to kernel symbol table"
@@ -90,7 +91,9 @@
default y
depends on CONFIG_LSMOD && CONFIG_FEATURE_NEW_MODULE_INTERFACE
help
- Please submit a patch to add help text for this item.
+ This will provide some extra information about each module when
+ running lsmod. The fields provided are address, size, flags and
+ usage count.
config CONFIG_MODPROBE
bool "modprobe"
@@ -110,7 +113,9 @@
default y
depends on CONFIG_INSMOD || CONFIG_LSMOD
help
- Please submit a patch to add help text for this item.
+ Support checking for tainted modules. These are usually binary
+ only modules that will make the linux-kernel list ignore your
+ support request.
endmenu
diff -ur busybox/networking/Config.in busybox-patched/networking/Config.in
--- busybox/networking/Config.in 2003-07-14 21:37:03.000000000 +0200
+++ busybox-patched/networking/Config.in 2003-07-21 00:02:28.524936003 +0200
@@ -9,7 +9,8 @@
bool "Enable IPv6 support"
default n
help
- Please submit a patch to add help text for this item.
+ Enable IPv6 support to busybox. This makes applets that talk IP
+ able to work with IPv6.
config CONFIG_ARPING
bool "arping"
@@ -143,7 +144,8 @@
default n
depends on CONFIG_IFCONFIG
help
- Please submit a patch to add help text for this item.
+ Allow "keepalive" and "outfill" support for SLIP. If you're not
+ planning on using serial lines, leave this unchecked.
config CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ
bool " Enable options \"mem_start\", \"io_addr\", and \"irq\""
@@ -167,7 +169,8 @@
default n
depends on CONFIG_IFCONFIG
help
- Please submit a patch to add help text for this item.
+ Setting this will make ifconfig attempt to find the broadcast
+ automatically if the value '+' is used.
config CONFIG_IFUPDOWN
bool "ifupdown"
@@ -180,28 +183,29 @@
default n
depends on CONFIG_IFUPDOWN && CONFIG_IP && CONFIG_FEATURE_IP_ADDRESS && CONFIG_FEATURE_IP_LINK && CONFIG_FEATURE_IP_ROUTE
help
- Please submit a patch to add help text for this item.
+ Use "ip" in "ifupdown".
config CONFIG_FEATURE_IFUPDOWN_IPV4
bool " Enable support for IPv4"
default y
depends on CONFIG_IFUPDOWN
help
- Please submit a patch to add help text for this item.
+ If you want busybox to talk IPv4, leave this on.
config CONFIG_FEATURE_IFUPDOWN_IPV6
bool " Enable support for IPv6"
default n
depends on CONFIG_IFUPDOWN
help
- Please submit a patch to add help text for this item.
+ If you need support for IPv6, turn this option on.
config CONFIG_FEATURE_IFUPDOWN_IPX
bool " Enable support for IPX"
default n
depends on CONFIG_IFUPDOWN
help
- Please submit a patch to add help text for this item.
+ If this option is selected you can use busybox to work with IPX
+ networks.
config CONFIG_FEATURE_IFUPDOWN_MAPPING
bool " Enable mapping support"
@@ -257,7 +261,9 @@
bool "ip"
default n
help
- Please submit a patch to add help text for this item.
+ The "ip" applet is a TCP/IP interface configuration and routing
+ utility. You generally don't need "ip" to use busybox with
+ TCP/IP.
if CONFIG_IP && CONFIG_IPADDR
config CONFIG_FEATURE_IP_ADDRESS
@@ -270,7 +276,7 @@
default y
depends on CONFIG_IP
help
- Please submit a patch to add help text for this item.
+ Address manipulation support for the "ip" applet.
endif
if CONFIG_IP && CONFIG_IPLINK
@@ -284,7 +290,7 @@
default y
depends on CONFIG_IP
help
- Please submit a patch to add help text for this item.
+ Configure network devices with "ip".
endif
if CONFIG_IP && CONFIG_IPROUTE
@@ -298,7 +304,7 @@
default y
depends on CONFIG_IP
help
- Please submit a patch to add help text for this item.
+ Add support for routing table management to "ip".
endif
if CONFIG_IP && CONFIG_IPTUNNEL
@@ -312,7 +318,7 @@
default n
depends on CONFIG_IP
help
- Please submit a patch to add help text for this item.
+ Add support for tunneling commands to "ip".
endif
config CONFIG_IPCALC
@@ -327,31 +333,31 @@
default y
depends on CONFIG_IPCALC
help
- Please submit a patch to add help text for this item.
+ Adds the fields hostname and silent to the output of "ipcalc".
config CONFIG_IPADDR
bool "ipaddr"
default n
help
- Please submit a patch to add help text for this item.
+ Equivalent to selecting address support to "ip", above.
config CONFIG_IPLINK
bool "iplink"
default n
help
- Please submit a patch to add help text for this item.
+ Equivalent to selecting link support to "ip", above.
config CONFIG_IPROUTE
bool "iproute"
default n
help
- Please submit a patch to add help text for this item.
+ Equivalent to selecting route support to "ip", above.
config CONFIG_IPTUNNEL
bool "iptunnel"
default n
help
- Please submit a patch to add help text for this item.
+ Equivalent to selecting tunnel support to "ip", above.
config CONFIG_NAMEIF
bool "nameif"
@@ -384,7 +390,7 @@
bool "nslookup"
default n
help
- Please submit a patch to add help text for this item.
+ Nslookup is a tool to query Internet name servers.
config CONFIG_PING
bool "ping"
@@ -398,21 +404,23 @@
default y
depends on CONFIG_PING
help
- Please submit a patch to add help text for this item.
+ Make the output from the ping applet include statistics, and at the
+ same time provide full support for ICMP packets.
config CONFIG_PING6
bool "ping6"
default n
depends on CONFIG_FEATURE_IPV6
help
- Please submit a patch to add help text for this item.
+ This will give you a ping that can talk IPv6.
config CONFIG_FEATURE_FANCY_PING6
bool " Enable fancy ping6 output"
default y
depends on CONFIG_PING6
help
- Please submit a patch to add help text for this item.
+ Make the output from the ping6 applet include statistics, and at the
+ same time provide full support for ICMP packets.
config CONFIG_ROUTE
bool "route"
@@ -424,27 +432,34 @@
bool "telnet"
default n
help
- Please submit a patch to add help text for this item.
+ Telnet is an interface to the TELNET protocol, but is also commonly
+ used to test other simple protocols.
config CONFIG_FEATURE_TELNET_TTYPE
bool " Pass TERM type to remote host"
default y
depends on CONFIG_TELNET
help
- Please submit a patch to add help text for this item.
+ Setting this option will forward the TERM environment variable to the
+ remote host you are connecting to. This is useful to make sure that
+ things like ANSI colors and other control sequences behave.
config CONFIG_TELNETD
bool "telnetd"
default n
help
- Please submit a patch to add help text for this item.
+ A daemon for the TELNET protocol, allowing you to log on to the host
+ running the daemon. Please keep in mind that the TELNET protocol
+ sends passwords in plain text. If you can't afford the space for
+ any SSH daemon and you trust your network, say 'y' here.
config CONFIG_FEATURE_TELNETD_INETD
bool " Support call from inetd only"
default n
depends on CONFIG_TELNETD
help
- Please submit a patch to add help text for this item.
+ Selecting this will make telnetd only callable from inetd, removing the
+ standalone support.
config CONFIG_TFTP
bool "tftp"
@@ -482,7 +497,9 @@
default n
depends on CONFIG_TFTP
help
- Please submit a patch to add help text for this item.
+ Enable debug settings for tftp. This is useful if you're running
+ into problems with tftp as the protocol doesn't help you much when
+ you run into problems.
config CONFIG_TRACEROUTE
bool "traceroute"
@@ -495,7 +512,8 @@
default n
depends on CONFIG_TRACEROUTE
help
- Please submit a patch to add help text for this item.
+ Add some verbosity to traceroute. This includes amongst other things
+ hostnames and ICMP response types.
config CONFIG_FEATURE_TRACEROUTE_SO_DEBUG
bool " Enable SO_DEBUG option"
diff -ur busybox/procps/Config.in busybox-patched/procps/Config.in
--- busybox/procps/Config.in 2003-07-14 21:37:02.000000000 +0200
+++ busybox-patched/procps/Config.in 2003-07-21 00:03:31.810048440 +0200
@@ -62,7 +62,7 @@
default y
depends on CONFIG_TOP
help
- Please submit a patch to add help text for this item.
+ Make top display CPU usage.
config CONFIG_UPTIME
bool "uptime"
diff -ur busybox/shell/Config.in busybox-patched/shell/Config.in
--- busybox/shell/Config.in 2003-07-14 21:37:00.000000000 +0200
+++ busybox-patched/shell/Config.in 2003-07-21 00:10:33.365168966 +0200
@@ -201,14 +201,15 @@
default n
depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
help
- Please submit a patch to add help text for this item.
+ Setting this option allows for prompts to use things like \w and
+ \$ and also using escape codes.
config CONFIG_FEATURE_SH_EXTRA_QUIET
bool "Hide message on interactive shell startup"
default n
depends on CONFIG_MSH || CONFIG_LASH || CONFIG_HUSH || CONFIG_ASH
help
- Please submit a patch to add help text for this item.
+ Remove the busybox introduction when starting a shell.
endmenu
diff -ur busybox/sysdeps/linux/Config.in busybox-patched/sysdeps/linux/Config.in
--- busybox/sysdeps/linux/Config.in 2003-07-14 21:37:01.000000000 +0200
+++ busybox-patched/sysdeps/linux/Config.in 2003-07-21 00:41:20.224168163 +0200
@@ -90,21 +90,39 @@
bool "Support for SUID/SGID handling"
default n
help
- Please submit a patch to add help text for this item.
+ Support SUID and SGID binaries.
config CONFIG_FEATURE_SUID_CONFIG
bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
default y if CONFIG_FEATURE_SUID
depends on CONFIG_FEATURE_SUID
help
- Please submit a patch to add help text for this item.
+ Allow the SUID / SGID state of an applet to be determinded runtime by
+ checking /etc/busybox.conf. The format of this file is as follows:
+
+ <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
+
+ An example might help:
+
+ [SUID]
+ su = ssx root.0 # applet su can be run by anyone and runs with euid=0/egid=0
+ su = ssx # exactly the same
+
+ mount = sx- root.disk # applet mount can be run by root and members of group disk
+ # and runs with euid=0
+
+ cp = --- # disable applet cp for everyone
+
+ Robert 'sandman' Griebl has more information here:
+ <url: http://www.softforge.de/bb/suid.html >.
config CONFIG_FEATURE_SUID_CONFIG_QUIET
bool "Suppress warning message if /etc/busybox.conf is not readable"
default n
depends on CONFIG_FEATURE_SUID_CONFIG
help
- Please submit a patch to add help text for this item.
+ /etc/busybox.conf should be readable by the user needing the SUID, check
+ this option to avoid users to be notified about missing permissions.
config CONFIG_SELINUX
bool "Support NSA Security Enhanced Linux"
--
Terje
More information about the busybox
mailing list