summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDenis Vlasenko <vda.linux@googlemail.com>2007-01-11 17:20:00 +0000
committerDenis Vlasenko <vda.linux@googlemail.com>2007-01-11 17:20:00 +0000
commitf7996f3b700a22797565e9aa57e251e6e3ac1e4d (patch)
treeaf4e797eef0a65f4e3dba94b325da0ec08452d36 /docs
parent3821fb13ea404d243115ff8ec161273b62826513 (diff)
downloadbusybox-w32-f7996f3b700a22797565e9aa57e251e6e3ac1e4d.tar.gz
busybox-w32-f7996f3b700a22797565e9aa57e251e6e3ac1e4d.tar.bz2
busybox-w32-f7996f3b700a22797565e9aa57e251e6e3ac1e4d.zip
Trailing whitespace removal over entire tree
Diffstat (limited to 'docs')
-rw-r--r--docs/busybox.net/FAQ.html8
-rw-r--r--docs/busybox.net/news.html2
-rw-r--r--docs/sigint.htm14
-rw-r--r--docs/tar_pax.txt232
4 files changed, 128 insertions, 128 deletions
diff --git a/docs/busybox.net/FAQ.html b/docs/busybox.net/FAQ.html
index c751f7521..c07be9027 100644
--- a/docs/busybox.net/FAQ.html
+++ b/docs/busybox.net/FAQ.html
@@ -82,7 +82,7 @@ have additions to this FAQ document, we would love to add them,
82 to determine which applet to run, as shown above. 82 to determine which applet to run, as shown above.
83</p> 83</p>
84<p> 84<p>
85 BusyBox also has a feature called the 85 BusyBox also has a feature called the
86 <a name="standalone_shell">"standalone shell"</a>, where the busybox 86 <a name="standalone_shell">"standalone shell"</a>, where the busybox
87 shell runs any built-in applets before checking the command path. This 87 shell runs any built-in applets before checking the command path. This
88 feature is also enabled by "make allyesconfig", and to try it out run 88 feature is also enabled by "make allyesconfig", and to try it out run
@@ -261,7 +261,7 @@ within each applet. More build coverage testing.</p></li>
261 261
262<hr /> 262<hr />
263<p> 263<p>
264<h2><a name="external">where can i find other small utilities since busybox 264<h2><a name="external">where can i find other small utilities since busybox
265 does not include the features i want?</a></h2> 265 does not include the features i want?</a></h2>
266<p> 266<p>
267 we maintain such a <a href="tinyutils.html">list</a> on this site! 267 we maintain such a <a href="tinyutils.html">list</a> on this site!
@@ -941,7 +941,7 @@ text console scrolling...)</p>
941 941
942<p>So will data always be read from the far end of a pipe at the 942<p>So will data always be read from the far end of a pipe at the
943same chunk sizes it was written in? Nope. Don't rely on that. For one 943same chunk sizes it was written in? Nope. Don't rely on that. For one
944counterexample, see <a href="http://www.faqs.org/rfcs/rfc896.html">rfc 896 944counterexample, see <a href="http://www.faqs.org/rfcs/rfc896.html">rfc 896
945for Nagle's algorithm</a>, which waits a fraction of a second or so before 945for Nagle's algorithm</a>, which waits a fraction of a second or so before
946sending out small amounts of data through a TCP/IP connection in case more 946sending out small amounts of data through a TCP/IP connection in case more
947data comes in that can be merged into the same packet. (In case you were 947data comes in that can be merged into the same packet. (In case you were
@@ -1089,7 +1089,7 @@ aaronl :Aaron Lehmann
1089beppu :John Beppu 1089beppu :John Beppu
1090dwhedon :David Whedon 1090dwhedon :David Whedon
1091erik :Erik Andersen 1091erik :Erik Andersen
1092gfeldman :Gennady Feldman 1092gfeldman :Gennady Feldman
1093jimg :Jim Gleason 1093jimg :Jim Gleason
1094kraai :Matt Kraai 1094kraai :Matt Kraai
1095markw :Mark Whitley 1095markw :Mark Whitley
diff --git a/docs/busybox.net/news.html b/docs/busybox.net/news.html
index 5492d6767..cdffd48eb 100644
--- a/docs/busybox.net/news.html
+++ b/docs/busybox.net/news.html
@@ -28,7 +28,7 @@
28 <li>grep: added -r, fixed -h 28 <li>grep: added -r, fixed -h
29 <li>watch: make it exec child like standard one does (was totally 29 <li>watch: make it exec child like standard one does (was totally
30 incompatible) 30 incompatible)
31 <li>tar: fix limitations which were preventing bbox tar usage 31 <li>tar: fix limitations which were preventing bbox tar usage
32 on big directories: long names and linknames, pax headers 32 on big directories: long names and linknames, pax headers
33 (Linux kernel tarballs have that). Fixed a number of obscure bugs. 33 (Linux kernel tarballs have that). Fixed a number of obscure bugs.
34 Raised max file limit (now 64Gb). Security fixes (/../ attacks). 34 Raised max file limit (now 64Gb). Security fixes (/../ attacks).
diff --git a/docs/sigint.htm b/docs/sigint.htm
index 6fe76bbef..e230f4df7 100644
--- a/docs/sigint.htm
+++ b/docs/sigint.htm
@@ -40,7 +40,7 @@ scripts using <code>Control-C</code>. Or have interactive applications
40that don't behave right when sending SIGINT. Examples are emacs'es 40that don't behave right when sending SIGINT. Examples are emacs'es
41that die on Control-g or shellscript statements that sometimes are 41that die on Control-g or shellscript statements that sometimes are
42executed and sometimes not, apparently not determined by the user's 42executed and sometimes not, apparently not determined by the user's
43intention. 43intention.
44 44
45 45
46</td></tr><tr><th valign=top align=left>Required knowledge: </th> 46</td></tr><tr><th valign=top align=left>Required knowledge: </th>
@@ -101,7 +101,7 @@ just exit.
101 101
102<p>Now imagine the user hits C-c while a shellscript is executing its 102<p>Now imagine the user hits C-c while a shellscript is executing its
103first program. The following programs receive SIGINT: program1 and 103first program. The following programs receive SIGINT: program1 and
104also the shell executing the script. program1 exits. 104also the shell executing the script. program1 exits.
105 105
106<p>But what should the shell do? If we say that it is only the 106<p>But what should the shell do? If we say that it is only the
107innermost's programs business to react on SIGINT, the shell will do 107innermost's programs business to react on SIGINT, the shell will do
@@ -351,7 +351,7 @@ that do not properly communicate the required information up to the
351calling program. 351calling program.
352 352
353<p>Unless a program messes with signal handling, the system does this 353<p>Unless a program messes with signal handling, the system does this
354automatically. 354automatically.
355 355
356<p>There are programs that want to exit on SIGINT, but they don't let 356<p>There are programs that want to exit on SIGINT, but they don't let
357the system do the automatic exit, because they want to do some 357the system do the automatic exit, because they want to do some
@@ -425,7 +425,7 @@ Notes:
425special numeric value. People often assume this since the manuals for 425special numeric value. People often assume this since the manuals for
426shells often list some return value for exactly this. But this is just 426shells often list some return value for exactly this. But this is just
427a convention for your shell script. It does not work from one UNIX API 427a convention for your shell script. It does not work from one UNIX API
428program to another. 428program to another.
429 429
430<P>All that happens is that the shell sets the "$?" variable to a 430<P>All that happens is that the shell sets the "$?" variable to a
431special numeric value for the convenience of your script, because your 431special numeric value for the convenience of your script, because your
@@ -571,7 +571,7 @@ comments the scripts echo.
571<tr valign=top align=left> 571<tr valign=top align=left>
572<td>IUE</td> 572<td>IUE</td>
573<td>The shell executing a script exits immediately if it receives 573<td>The shell executing a script exits immediately if it receives
574SIGINT.</td> 574SIGINT.</td>
575<td>4.4BSD ash (ash), NetBSD, FreeBSD prior to 3.0/22.8</td> 575<td>4.4BSD ash (ash), NetBSD, FreeBSD prior to 3.0/22.8</td>
576<td>The editor session is lost and subsequent commands are not 576<td>The editor session is lost and subsequent commands are not
577executed.</td> 577executed.</td>
@@ -605,7 +605,7 @@ will further commands from the script be executed. </td>
605signal (either it had the default handler for SIGINT or it killed 605signal (either it had the default handler for SIGINT or it killed
606itself). </td> 606itself). </td>
607<td>bash (Linux /bin/sh), most commercial /bin/sh, FreeBSD /bin/sh 607<td>bash (Linux /bin/sh), most commercial /bin/sh, FreeBSD /bin/sh
608from 3.0/2.2.8.</td> 608from 3.0/2.2.8.</td>
609<td>The editor continues as normal and subsequent commands are 609<td>The editor continues as normal and subsequent commands are
610executed. </td> 610executed. </td>
611<td>The editor continues as normal and subsequent commands are 611<td>The editor continues as normal and subsequent commands are
@@ -615,7 +615,7 @@ child exits, but only if the child exited with signal status. If
615the child did a normal exit (even if it received SIGINT, but catches 615the child did a normal exit (even if it received SIGINT, but catches
616it), the script will continue. </td> 616it), the script will continue. </td>
617<td>The child must be implemented right, or the user will not be able 617<td>The child must be implemented right, or the user will not be able
618to break shell scripts reliably.</td> 618to break shell scripts reliably.</td>
619</tr> 619</tr>
620 620
621</table> 621</table>
diff --git a/docs/tar_pax.txt b/docs/tar_pax.txt
index 8a3f1e755..e56c27b16 100644
--- a/docs/tar_pax.txt
+++ b/docs/tar_pax.txt
@@ -4,197 +4,197 @@ for everything (filename, uid, filesize etc) which can overflow.
4 4
5pax Header Block 5pax Header Block
6 6
7The pax header block shall be identical to the ustar header block 7The pax header block shall be identical to the ustar header block
8described in ustar Interchange Format, except that two additional 8described in ustar Interchange Format, except that two additional
9typeflag values are defined: 9typeflag values are defined:
10 10
11x 11x
12 Represents extended header records for the following file in 12 Represents extended header records for the following file in
13the archive (which shall have its own ustar header block). 13the archive (which shall have its own ustar header block).
14 14
15g 15g
16 Represents global extended header records for the following 16 Represents global extended header records for the following
17files in the archive. Each value shall affect all subsequent files 17files in the archive. Each value shall affect all subsequent files
18that do not override that value in their own extended header 18that do not override that value in their own extended header
19record and until another global extended header record is reached 19record and until another global extended header record is reached
20that provides another value for the same field. The typeflag g 20that provides another value for the same field. The typeflag g
21global headers should not be used with interchange media that 21global headers should not be used with interchange media that
22could suffer partial data loss in transporting the archive. 22could suffer partial data loss in transporting the archive.
23 23
24For both of these types, the size field shall be the size of the 24For both of these types, the size field shall be the size of the
25extended header records in octets. The other fields in the header 25extended header records in octets. The other fields in the header
26block are not meaningful to this version of the pax utility. 26block are not meaningful to this version of the pax utility.
27However, if this archive is read by a pax utility conforming to 27However, if this archive is read by a pax utility conforming to
28the ISO POSIX-2:1993 standard, the header block fields are used to 28the ISO POSIX-2:1993 standard, the header block fields are used to
29create a regular file that contains the extended header records as 29create a regular file that contains the extended header records as
30data. Therefore, header block field values should be selected to 30data. Therefore, header block field values should be selected to
31provide reasonable file access to this regular file. 31provide reasonable file access to this regular file.
32 32
33A further difference from the ustar header block is that data 33A further difference from the ustar header block is that data
34blocks for files of typeflag 1 (the digit one) (hard link) may be 34blocks for files of typeflag 1 (the digit one) (hard link) may be
35included, which means that the size field may be greater than 35included, which means that the size field may be greater than
36zero. 36zero.
37 37
38pax Extended Header 38pax Extended Header
39 39
40An extended header shall consist of one or more records, each 40An extended header shall consist of one or more records, each
41constructed as follows: 41constructed as follows:
42 42
43"%d %s=%s\n", <length>, <keyword>, <value> 43"%d %s=%s\n", <length>, <keyword>, <value>
44 44
45The <length> field shall be the decimal length of the extended 45The <length> field shall be the decimal length of the extended
46header record in octets, including length string itself and the 46header record in octets, including length string itself and the
47trailing <newline>. 47trailing <newline>.
48 48
49[skip] 49[skip]
50 50
51atime 51atime
52 The file access time for the following file(s), equivalent to 52 The file access time for the following file(s), equivalent to
53the value of the st_atime member of the stat structure for a file, 53the value of the st_atime member of the stat structure for a file,
54as described by the stat() function. The access time shall be 54as described by the stat() function. The access time shall be
55restored if the process has the appropriate privilege required to 55restored if the process has the appropriate privilege required to
56do so. The format of the <value> shall be as described in pax 56do so. The format of the <value> shall be as described in pax
57Extended Header File Times. 57Extended Header File Times.
58 58
59charset 59charset
60 The name of the character set used to encode the data in the 60 The name of the character set used to encode the data in the
61following file(s). 61following file(s).
62 62
63 The encoding is included in an extended header for information 63 The encoding is included in an extended header for information
64only; when pax is used as described in IEEE Std 1003.1-2001, it 64only; when pax is used as described in IEEE Std 1003.1-2001, it
65shall not translate the file data into any other encoding. The 65shall not translate the file data into any other encoding. The
66BINARY entry indicates unencoded binary data. 66BINARY entry indicates unencoded binary data.
67 67
68 When used in write or copy mode, it is implementation-defined 68 When used in write or copy mode, it is implementation-defined
69whether pax includes a charset extended header record for a file. 69whether pax includes a charset extended header record for a file.
70 70
71comment 71comment
72 A series of characters used as a comment. All characters in 72 A series of characters used as a comment. All characters in
73the <value> field shall be ignored by pax. 73the <value> field shall be ignored by pax.
74 74
75gid 75gid
76 The group ID of the group that owns the file, expressed as a 76 The group ID of the group that owns the file, expressed as a
77decimal number using digits from the ISO/IEC 646:1991 standard. 77decimal number using digits from the ISO/IEC 646:1991 standard.
78This record shall override the gid field in the following header 78This record shall override the gid field in the following header
79block(s). When used in write or copy mode, pax shall include a gid 79block(s). When used in write or copy mode, pax shall include a gid
80extended header record for each file whose group ID is greater 80extended header record for each file whose group ID is greater
81than 2097151 (octal 7777777). 81than 2097151 (octal 7777777).
82 82
83gname 83gname
84 The group of the file(s), formatted as a group name in the 84 The group of the file(s), formatted as a group name in the
85group database. This record shall override the gid and gname 85group database. This record shall override the gid and gname
86fields in the following header block(s), and any gid extended 86fields in the following header block(s), and any gid extended
87header record. When used in read, copy, or list mode, pax shall 87header record. When used in read, copy, or list mode, pax shall
88translate the name from the UTF-8 encoding in the header record to 88translate the name from the UTF-8 encoding in the header record to
89the character set appropriate for the group database on the 89the character set appropriate for the group database on the
90receiving system. If any of the UTF-8 characters cannot be 90receiving system. If any of the UTF-8 characters cannot be
91translated, and if the -o invalid= UTF-8 option is not specified, 91translated, and if the -o invalid= UTF-8 option is not specified,
92the results are implementation-defined. When used in write or copy 92the results are implementation-defined. When used in write or copy
93mode, pax shall include a gname extended header record for each 93mode, pax shall include a gname extended header record for each
94file whose group name cannot be represented entirely with the 94file whose group name cannot be represented entirely with the
95letters and digits of the portable character set. 95letters and digits of the portable character set.
96 96
97linkpath 97linkpath
98 The pathname of a link being created to another file, of any 98 The pathname of a link being created to another file, of any
99type, previously archived. This record shall override the linkname 99type, previously archived. This record shall override the linkname
100field in the following ustar header block(s). The following ustar 100field in the following ustar header block(s). The following ustar
101header block shall determine the type of link created. If typeflag 101header block shall determine the type of link created. If typeflag
102of the following header block is 1, it shall be a hard link. If 102of the following header block is 1, it shall be a hard link. If
103typeflag is 2, it shall be a symbolic link and the linkpath value 103typeflag is 2, it shall be a symbolic link and the linkpath value
104shall be the contents of the symbolic link. The pax utility shall 104shall be the contents of the symbolic link. The pax utility shall
105translate the name of the link (contents of the symbolic link) 105translate the name of the link (contents of the symbolic link)
106from the UTF-8 encoding to the character set appropriate for the 106from the UTF-8 encoding to the character set appropriate for the
107local file system. When used in write or copy mode, pax shall 107local file system. When used in write or copy mode, pax shall
108include a linkpath extended header record for each link whose 108include a linkpath extended header record for each link whose
109pathname cannot be represented entirely with the members of the 109pathname cannot be represented entirely with the members of the
110portable character set other than NUL. 110portable character set other than NUL.
111 111
112mtime 112mtime
113 The file modification time of the following file(s), 113 The file modification time of the following file(s),
114equivalent to the value of the st_mtime member of the stat 114equivalent to the value of the st_mtime member of the stat
115structure for a file, as described in the stat() function. This 115structure for a file, as described in the stat() function. This
116record shall override the mtime field in the following header 116record shall override the mtime field in the following header
117block(s). The modification time shall be restored if the process 117block(s). The modification time shall be restored if the process
118has the appropriate privilege required to do so. The format of the 118has the appropriate privilege required to do so. The format of the
119<value> shall be as described in pax Extended Header File Times. 119<value> shall be as described in pax Extended Header File Times.
120 120
121path 121path
122 The pathname of the following file(s). This record shall 122 The pathname of the following file(s). This record shall
123override the name and prefix fields in the following header 123override the name and prefix fields in the following header
124block(s). The pax utility shall translate the pathname of the file 124block(s). The pax utility shall translate the pathname of the file
125from the UTF-8 encoding to the character set appropriate for the 125from the UTF-8 encoding to the character set appropriate for the
126local file system. 126local file system.
127 127
128 When used in write or copy mode, pax shall include a path 128 When used in write or copy mode, pax shall include a path
129extended header record for each file whose pathname cannot be 129extended header record for each file whose pathname cannot be
130represented entirely with the members of the portable character 130represented entirely with the members of the portable character
131set other than NUL. 131set other than NUL.
132 132
133realtime.any 133realtime.any
134 The keywords prefixed by "realtime." are reserved for future 134 The keywords prefixed by "realtime." are reserved for future
135standardization. 135standardization.
136 136
137security.any 137security.any
138 The keywords prefixed by "security." are reserved for future 138 The keywords prefixed by "security." are reserved for future
139standardization. 139standardization.
140 140
141size 141size
142 The size of the file in octets, expressed as a decimal number 142 The size of the file in octets, expressed as a decimal number
143using digits from the ISO/IEC 646:1991 standard. This record shall 143using digits from the ISO/IEC 646:1991 standard. This record shall
144override the size field in the following header block(s). When 144override the size field in the following header block(s). When
145used in write or copy mode, pax shall include a size extended 145used in write or copy mode, pax shall include a size extended
146header record for each file with a size value greater than 146header record for each file with a size value greater than
1478589934591 (octal 77777777777). 1478589934591 (octal 77777777777).
148 148
149uid 149uid
150 The user ID of the file owner, expressed as a decimal number 150 The user ID of the file owner, expressed as a decimal number
151using digits from the ISO/IEC 646:1991 standard. This record shall 151using digits from the ISO/IEC 646:1991 standard. This record shall
152override the uid field in the following header block(s). When used 152override the uid field in the following header block(s). When used
153in write or copy mode, pax shall include a uid extended header 153in write or copy mode, pax shall include a uid extended header
154record for each file whose owner ID is greater than 2097151 (octal 154record for each file whose owner ID is greater than 2097151 (octal
1557777777). 1557777777).
156 156
157uname 157uname
158 The owner of the following file(s), formatted as a user name 158 The owner of the following file(s), formatted as a user name
159in the user database. This record shall override the uid and uname 159in the user database. This record shall override the uid and uname
160fields in the following header block(s), and any uid extended 160fields in the following header block(s), and any uid extended
161header record. When used in read, copy, or list mode, pax shall 161header record. When used in read, copy, or list mode, pax shall
162translate the name from the UTF-8 encoding in the header record to 162translate the name from the UTF-8 encoding in the header record to
163the character set appropriate for the user database on the 163the character set appropriate for the user database on the
164receiving system. If any of the UTF-8 characters cannot be 164receiving system. If any of the UTF-8 characters cannot be
165translated, and if the -o invalid= UTF-8 option is not specified, 165translated, and if the -o invalid= UTF-8 option is not specified,
166the results are implementation-defined. When used in write or copy 166the results are implementation-defined. When used in write or copy
167mode, pax shall include a uname extended header record for each 167mode, pax shall include a uname extended header record for each
168file whose user name cannot be represented entirely with the 168file whose user name cannot be represented entirely with the
169letters and digits of the portable character set. 169letters and digits of the portable character set.
170 170
171If the <value> field is zero length, it shall delete any header 171If the <value> field is zero length, it shall delete any header
172block field, previously entered extended header value, or global 172block field, previously entered extended header value, or global
173extended header value of the same name. 173extended header value of the same name.
174 174
175If a keyword in an extended header record (or in a -o 175If a keyword in an extended header record (or in a -o
176option-argument) overrides or deletes a corresponding field in the 176option-argument) overrides or deletes a corresponding field in the
177ustar header block, pax shall ignore the contents of that header 177ustar header block, pax shall ignore the contents of that header
178block field. 178block field.
179 179
180Unlike the ustar header block fields, NULs shall not delimit 180Unlike the ustar header block fields, NULs shall not delimit
181<value>s; all characters within the <value> field shall be 181<value>s; all characters within the <value> field shall be
182considered data for the field. None of the length limitations of 182considered data for the field. None of the length limitations of
183the ustar header block fields in ustar Header Block shall apply to 183the ustar header block fields in ustar Header Block shall apply to
184the extended header records. 184the extended header records.
185 185
186pax Extended Header File Times 186pax Extended Header File Times
187 187
188Time records shall be formatted as a decimal representation of the 188Time records shall be formatted as a decimal representation of the
189time in seconds since the Epoch. If a period ( '.' ) decimal point 189time in seconds since the Epoch. If a period ( '.' ) decimal point
190character is present, the digits to the right of the point shall 190character is present, the digits to the right of the point shall
191represent the units of a subsecond timing granularity. In read or 191represent the units of a subsecond timing granularity. In read or
192copy mode, the pax utility shall truncate the time of a file to 192copy mode, the pax utility shall truncate the time of a file to
193the greatest value that is not greater than the input header 193the greatest value that is not greater than the input header
194file time. In write or copy mode, the pax utility shall output a 194file time. In write or copy mode, the pax utility shall output a
195time exactly if it can be represented exactly as a decimal number, 195time exactly if it can be represented exactly as a decimal number,
196and otherwise shall generate only enough digits so that the same 196and otherwise shall generate only enough digits so that the same
197time shall be recovered if the file is extracted on a system whose 197time shall be recovered if the file is extracted on a system whose
198underlying implementation supports the same time granularity. 198underlying implementation supports the same time granularity.
199 199
200Example from Linux kernel archive tarball: 200Example from Linux kernel archive tarball: