aboutsummaryrefslogtreecommitdiff
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* - changed the way POD is generated such that the dashedbeppu2001-02-261-10/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | line appears at the bottom instead of the top. The indentation semantics of POD make the first item in the (=over,=back) block look weird the other way. - implemented a way to encode example usage into usage.h One would define a macro called "${applet}_example_usage" which would expand to the example text. - The example usage is considered optional, but trivial and full usage are not. Here's an example using chown. ---- before #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." #define chown_full_usage \ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." #define chown_example_usage \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root /tmp/foo\n" \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root.root /tmp/foo\n" \ "\tls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" ---- after =item I<chown> chown [OPTION]... OWNER[<.|:>[GROUP] FILE... Change the owner and/or group of each FILE to OWNER and/or GROUP. Options: -R Changes files and directories recursively. Example: $ ls -l /tmp/foo -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo $ chown root /tmp/foo $ ls -l /tmp/foo -r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo $ chown root.root /tmp/foo ls -l /tmp/foo -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo ------------------------------- git-svn-id: svn://busybox.net/trunk/busybox@1931 69ca8d6d-28ef-0310-b511-8ec308f3f277
* ...beppu2001-02-241-3/+1
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1925 69ca8d6d-28ef-0310-b511-8ec308f3f277
* refinementbeppu2001-02-241-12/+16
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1924 69ca8d6d-28ef-0310-b511-8ec308f3f277
* formatting ...beppu2001-02-231-2/+2
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1923 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Added some documentation and made --sgml use sgml_from_usage().beppu2001-02-231-9/+24
| | | | | | | pod_from_usage() is the default generator. git-svn-id: svn://busybox.net/trunk/busybox@1922 69ca8d6d-28ef-0310-b511-8ec308f3f277
* During POD generation, it inserts a blank line before linesbeppu2001-02-231-5/+17
| | | | | | | that were intended to be indented. git-svn-id: svn://busybox.net/trunk/busybox@1920 69ca8d6d-28ef-0310-b511-8ec308f3f277
* forgot to remove some debugging noisebeppu2001-02-231-3/+1
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1916 69ca8d6d-28ef-0310-b511-8ec308f3f277
* This one should be able to deal with the USAGE macros a littlebeppu2001-02-231-3/+6
| | | | | | | more robustly. I also blow away any USAGE_NOT_\w+ macros. git-svn-id: svn://busybox.net/trunk/busybox@1915 69ca8d6d-28ef-0310-b511-8ec308f3f277
* forgot a comma.beppu2001-02-231-2/+2
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1913 69ca8d6d-28ef-0310-b511-8ec308f3f277
* I can't leave it alone.beppu2001-02-231-8/+7
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1903 69ca8d6d-28ef-0310-b511-8ec308f3f277
* minor cleanup... all that's left to do isbeppu2001-02-231-5/+5
| | | | | | | | | | | | | | * make headers and footers for both the POD and SGML content * make an SGML generator * finish the command-line handling Also, some of the documentation in usage.h will have to be adjusted. expr needs some lines to be indented, and ls has a stray comma. I may have missed some things... but it looks OK for the most part. git-svn-id: svn://busybox.net/trunk/busybox@1902 69ca8d6d-28ef-0310-b511-8ec308f3f277
* This is the remixed autodocufier.pl.beppu2001-02-231-80/+175
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1901 69ca8d6d-28ef-0310-b511-8ec308f3f277
* First pass at making up an automagical usage message extractor, whichandersen2001-02-221-0/+88
| | | | | | | | will be used (when it works) to autogenerate documentation. Based on code written by Mark Whitley. git-svn-id: svn://busybox.net/trunk/busybox@1887 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Fix typo.kraai2001-02-091-1/+1
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1775 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Minor cleanups and clarifications.markw2001-02-091-8/+16
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1761 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Add listening support.kraai2001-02-071-1/+6
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1758 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Added documentation for new find options.kraai2001-02-071-1/+3
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1757 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Added some more on paren spacing and a section on testing guidelines.markw2001-02-031-2/+38
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1743 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Added floppyfw to list of known projects using BusyBox.markw2001-01-311-0/+1
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1731 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Wrap a table (bg set to black, width=80%) around the screenshotandersen2001-01-311-1/+5
| | | | | | | | | so it doesn't look like crap in Netscape. Should look fine in Mozilla either way. I think. -Erik git-svn-id: svn://busybox.net/trunk/busybox@1725 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Make it validate.kraai2001-01-311-12/+11
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1724 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Close IMG tag.kraai2001-01-311-1/+1
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1723 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Added a new screenshot of Busybox. :-)markw2001-01-302-0/+56
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1719 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Fix up copyright msgs. Bump version to 0.49 in preparation forandersen2001-01-272-21/+45
| | | | | | | | a release. Update the website with release details. -Erik git-svn-id: svn://busybox.net/trunk/busybox@1697 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Commit Larry Doolittle's buffers-on-stack/buffers-via-malloc patch.andersen2001-01-251-9/+9
| | | | | | | -Erik git-svn-id: svn://busybox.net/trunk/busybox@1674 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Add in spoon's watchdog timer app.andersen2001-01-252-5/+25
| | | | | | | -Erik git-svn-id: svn://busybox.net/trunk/busybox@1672 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Because you demanded it, source tree snapshots are made available daily.markw2001-01-251-2/+8
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1671 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Added Linux on nanoEngine to the list of known users.markw2001-01-251-1/+1
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1670 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Update contact info.andersen2001-01-251-1/+1
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1669 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Apply a patch from Brent Priddy <brent.priddy@adtran.com> to addandersen2001-01-252-1/+3
| | | | | | | | 'id -n' support. -Erik git-svn-id: svn://busybox.net/trunk/busybox@1666 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Fix up insmod usage info to mention -Landersen2001-01-242-1/+3
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1649 69ca8d6d-28ef-0310-b511-8ec308f3f277
* - Added a section on avoiding static buffers, per mailing list discussionsmarkw2001-01-241-4/+88
| | | | | | | | | | - Added a section on avoiding dangerous, overrun-prone string functions, per mailing list comment by David Douthitt - Added comment on how to search-and-replace in multiple files per (very old) mailing list comment by Larry Doolittle. git-svn-id: svn://busybox.net/trunk/busybox@1644 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Add dpkg-deb documentationbug12001-01-032-13/+77
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1524 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Update logger usage information.kraai2001-01-022-3/+3
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1516 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Some corrections, some additions, some embellishments.markw2000-12-201-14/+75
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1480 69ca8d6d-28ef-0310-b511-8ec308f3f277
* More spelling fixes from Larry Doolittle.markw2000-12-191-2/+2
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1473 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Added a paragraph from Larry Dolittle, made some more section headers.markw2000-12-191-3/+18
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1472 69ca8d6d-28ef-0310-b511-8ec308f3f277
* New applet HOWTO. Written by Matt Kraai with some formating and additions by me.markw2000-12-191-0/+128
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1471 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Doc update from Matt Kraai, better describing the init process.andersen2000-12-182-18/+18
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1468 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Only say mailing list once.kraai2000-12-151-1/+1
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1463 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Add in mkCDrec - make CD-ROM recovery project.andersen2000-12-141-36/+35
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1459 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Ran aspell.kraai2000-12-131-2/+2
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1455 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Website update for the releaseandersen2000-12-132-42/+62
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1452 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Document gzip -dandersen2000-12-132-1/+3
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1449 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Fix spelling error s/defaut/default/gandersen2000-12-112-3/+3
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1426 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Reverse logic so when network logging, it by default does not log locally.andersen2000-12-112-5/+5
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1418 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Patch from Matt Kraai to implement uniq -[cdu]andersen2000-12-092-1/+19
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1409 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Update inittab docsandersen2000-12-082-17/+73
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1404 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Make no local logging a runtime option for network logging...andersen2000-12-082-3/+5
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1403 69ca8d6d-28ef-0310-b511-8ec308f3f277
* Ignore the newdocs as wellandersen2000-12-061-0/+5
| | | | git-svn-id: svn://busybox.net/trunk/busybox@1388 69ca8d6d-28ef-0310-b511-8ec308f3f277