aboutsummaryrefslogtreecommitdiff
path: root/docs/autodocifier.pl
AgeCommit message (Collapse)Author
2004-03-13Fix some doc generation problemsEric Andersen
2003-07-14Update a bunch of docs. Run a script to update my email addr.Eric Andersen
2001-10-31- fixed typosJohn Beppu
- thinking about how to generate Configure.help...
2001-10-24Major rework of the directory structure and the entire build system.Eric Andersen
-Erik
2001-04-17- usage.hJohn Beppu
o echo_example_usage needed to escape some backslashes in an inner quote o find_full_usage missing a \n at the end of the -name line ? getopt_full_usage the -o line has tab issues, but I didn't fix them. o length_example_usage removed some double-quotes that were within an inner quotes o printf_example_usage needed to escape a backslash in an inner quote o sort_example_usage needed to escape some backslashes and double quotes in an inner quote o tftp_full_usage s/nameing/naming/; o umount_full_usage remove colons after options for consistency w/ other full_usage messages o uniq_example_usage needed to escape some backslashes and double quotes in an inner quote - TODO xargs -l ? - docs/autodocifier.pl POD && comment updates - docs/busybox_footer.pod added Larry Doolittle and Sterling Huxley
2001-04-10Fix double quote handling.Matt Kraai
2001-04-05- autodocifier.pl :: continuation() was modified such that '#'John Beppu
is handled correctly.
2001-04-05- documentation updates and a minor tweak to POD generationJohn Beppu
2001-03-15- generated middle section of busybox.pod w/ autodocifier.plJohn Beppu
- updated autodocifier.pl to use tab to indent example section
2001-03-15- properly indent Examples section in pod generatorJohn Beppu
2001-03-15Update the documentation so examples are autoincluded in the output text.Eric Andersen
Fix up docs/busybox.pod with the latest autogenerated output. -Erik
2001-03-06minor cleanupJohn Beppu
2001-02-26- changed the way POD is generated such that the dashedJohn Beppu
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-24...John Beppu
2001-02-24refinementJohn Beppu
2001-02-23formatting ...John Beppu
2001-02-23Added some documentation and made --sgml use sgml_from_usage().John Beppu
pod_from_usage() is the default generator.
2001-02-23During POD generation, it inserts a blank line before linesJohn Beppu
that were intended to be indented.
2001-02-23forgot to remove some debugging noiseJohn Beppu
2001-02-23This one should be able to deal with the USAGE macros a littleJohn Beppu
more robustly. I also blow away any USAGE_NOT_\w+ macros.
2001-02-23forgot a comma.John Beppu
2001-02-23I can't leave it alone.John Beppu
2001-02-23minor cleanup... all that's left to do isJohn Beppu
* 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.
2001-02-23This is the remixed autodocufier.pl.John Beppu
2001-02-22First pass at making up an automagical usage message extractor, whichEric Andersen
will be used (when it works) to autogenerate documentation. Based on code written by Mark Whitley.