hush/docs
John Beppu d11578f916 - changed the way POD is generated such that the dashed
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


-------------------------------
2001-02-26 02:50:11 +00:00
..
busybox.net Added floppyfw to list of known projects using BusyBox. 2001-01-31 18:33:20 +00:00
.cvsignore Ignore the newdocs as well 2000-12-06 23:12:43 +00:00
autodocifier.pl - changed the way POD is generated such that the dashed 2001-02-26 02:50:11 +00:00
busybox.pod Add in spoon's watchdog timer app. 2001-01-25 23:40:32 +00:00
busybox.sgml Add listening support. 2001-02-07 04:09:23 +00:00
new-applet-HOWTO.txt More spelling fixes from Larry Doolittle. 2000-12-19 19:44:35 +00:00
style-guide.txt Fix typo. 2001-02-09 18:10:53 +00:00