- changed the way POD is generated such that the dashed
authorJohn Beppu <beppu@lbox.org>
Mon, 26 Feb 2001 02:50:11 +0000 (02:50 -0000)
committerJohn Beppu <beppu@lbox.org>
Mon, 26 Feb 2001 02:50:11 +0000 (02:50 -0000)
commitd11578f9167a5bc10cf77544cc1d64965d3f8f2b
treed632015e9fd9c6cad4497a232f48b87e3ffd9e30
parent2bf658d5cd4460a0e0a8a8f3c8dc3b71be05d1ba
- 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

-------------------------------
docs/autodocifier.pl