From 9c3c38da5575b1eca8690855a2e4894d4cab34e2 Mon Sep 17 00:00:00 2001 From: Eric Andersen Date: Tue, 22 Jul 2003 09:59:34 +0000 Subject: Patch from Terje Kvernes adding quite a lot of missing documentation --- editors/Config.in | 24 +++++++++++------- loginutils/Config.in | 22 +++++++++++++--- modutils/Config.in | 15 +++++++---- networking/Config.in | 72 ++++++++++++++++++++++++++++++++-------------------- procps/Config.in | 2 +- shell/Config.in | 5 ++-- 6 files changed, 92 insertions(+), 48 deletions(-) diff --git a/editors/Config.in b/editors/Config.in index 22908de4d..14b698f5d 100644 --- a/editors/Config.in +++ b/editors/Config.in @@ -56,35 +56,40 @@ config CONFIG_FEATURE_VI_COLON 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 @@ config CONFIG_FEATURE_VI_SETOPTS 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 --git a/loginutils/Config.in b/loginutils/Config.in index 494ddbd6b..9b40871e6 100644 --- a/loginutils/Config.in +++ b/loginutils/Config.in @@ -55,7 +55,7 @@ config CONFIG_GETTY 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 @@ config CONFIG_VLOCK 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,28 @@ config CONFIG_FEATURE_SHADOWPASSWDS 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. + If you leave this disabled, busybox will use the system's shadow + password handling functions. And if you are using the GNU C library + (glibc), you will then need to install the /etc/nsswitch.conf + configuration file and the required /lib/libnss_* libraries in + order for the shadow password functions to work. This generally + makes your embedded system quite a bit larger. + + Enabling this option will cause busybox to directly access the + system's /etc/shadow file when handling shadow passwords. This + makes your system smaller and I will get fewer emails asking about + how glibc NSS works). When this option is enabled, you will not be + able to use PAM to access shadow passwords from remote LDAP + password servers and whatnot. endmenu diff --git a/modutils/Config.in b/modutils/Config.in index a635656e5..2006be00f 100644 --- a/modutils/Config.in +++ b/modutils/Config.in @@ -16,7 +16,7 @@ config CONFIG_FEATURE_OLD_MODULE_INTERFACE 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 @@ config CONFIG_FEATURE_NEW_MODULE_INTERFACE 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 @@ config CONFIG_FEATURE_INSMOD_VERSION_CHECKING 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 @@ config CONFIG_FEATURE_QUERY_MODULE_INTERFACE 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 @@ config CONFIG_FEATURE_CHECK_TAINTED_MODULE 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 --git a/networking/Config.in b/networking/Config.in index 4c5cb8526..d53dddcc1 100644 --- a/networking/Config.in +++ b/networking/Config.in @@ -9,7 +9,8 @@ config CONFIG_FEATURE_IPV6 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 @@ config CONFIG_FEATURE_IFCONFIG_SLIP 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 @@ config CONFIG_FEATURE_IFCONFIG_BROADCAST_PLUS 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 @@ config CONFIG_FEATURE_IFUPDOWN_IP 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 @@ config CONFIG_IP 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 @@ if ! (CONFIG_IP && CONFIG_IPADDR) 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 @@ if !(CONFIG_IP && CONFIG_IPLINK) 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 @@ if !(CONFIG_IP && CONFIG_IPROUTE) 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 @@ if !(CONFIG_IP && CONFIG_IPTUNNEL) 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 @@ config CONFIG_FEATURE_IPCALC_FANCY 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 @@ config CONFIG_NSLOOKUP 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 @@ config CONFIG_FEATURE_FANCY_PING 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 @@ config CONFIG_TELNET 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 @@ config CONFIG_FEATURE_TFTP_DEBUG 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 @@ config CONFIG_FEATURE_TRACEROUTE_VERBOSE 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 --git a/procps/Config.in b/procps/Config.in index 9458618b3..23f2f7f3d 100644 --- a/procps/Config.in +++ b/procps/Config.in @@ -62,7 +62,7 @@ config FEATURE_CPU_USAGE_PERCENTAGE 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 --git a/shell/Config.in b/shell/Config.in index 02d4851ec..57633eb30 100644 --- a/shell/Config.in +++ b/shell/Config.in @@ -201,14 +201,15 @@ config CONFIG_FEATURE_SH_FANCY_PROMPT 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 -- cgit v1.2.3