6 # collect lines continued with a '\' into an array
16 last unless (/\\\s*$/);
21 # regex && eval away unwanted strings from documentation
24 $text =~ s/USAGE_NOT\w+\(.*?"\s*\)//sxg;
25 $text =~ s/USAGE_\w+\(\s*?(.*?)"\s*\)/$1"/sxg;
27 my @line = split("\n", $text);
34 eval qq[ sprintf(qq{$_}) ]
40 # generate POD for an applet
45 # Sigh. Fixup the known odd-name applets.
46 $name =~ s/dpkg_deb/dpkg-deb/g;
47 $name =~ s/fsck_minix/fsck.minix/g;
48 $name =~ s/mkfs_minix/mkfs.minix/g;
49 $name =~ s/run_parts/run-parts/g;
50 $name =~ s/start_stop_daemon/start-stop-daemon/g;
53 my $trivial = $usage->{trivial};
54 $trivial =~ s/(?<!\w)(-\w+)/B<$1>/sxg;
56 map { $_ !~ /^\s/ && s/(?<!\w)(-\w+)/B<$1>/g; $_ }
57 split("\n", $usage->{full});
59 # add "\n" prior to certain lines to make indented
63 for (my $i = 0; $i < $len; $i++) {
65 if (($i+1) != $len && $f0[$i] !~ /^\s/ && $f0[$i+1] =~ /^\s/) {
66 next if ($f0[$i] =~ /^$/);
67 push(@f1, "") unless ($f0[$i+1] =~ /^\s*$/s);
70 my $full = join("\n", @f1);
72 # prepare notes if they exist
73 my $notes = (defined $usage->{notes})
74 ? "$usage->{notes}\n\n"
77 # prepare examples if they exist
78 my $example = (defined $usage->{example})
83 split("\n", $usage->{example})) . "\n\n"
88 "\n\n$name $trivial\n\n".
92 "-------------------------------".
97 # the keys are applet names, and
98 # the values will contain hashrefs of the form:
109 # get command-line options
120 if (defined $opt{help}) {
122 "$0 [OPTION]... [FILE]...\n",
131 # collect documenation into %docs
134 open(USAGE, $_) || die("$0: $_: $!");
136 my ($applet, $type, @line);
138 if (/^#define (\w+)_(\w+)_usage/) {
141 @line = continuation($fh);
142 my $doc = $docs{$applet} ||= { };
143 my $text = join("\n", @line);
144 $doc->{$type} = beautify($text);
150 # generate structured documentation
152 my $generator = \&pod_for_usage;
153 foreach my $applet (sort keys %docs) {
154 print $generator->($applet, $docs{$applet});
163 autodocifier.pl - generate docs for busybox based on usage.h
167 autodocifier.pl [OPTION]... [FILE]...
171 ( cat docs/busybox_header.pod; \
172 docs/autodocifier.pl usage.h; \
173 cat docs/busybox_footer.pod ) > docs/busybox.pod
177 The purpose of this script is to automagically generate
178 documentation for busybox using its usage.h as the original source
179 for content. It used to be that same content has to be duplicated
180 in 3 places in slightly different formats -- F<usage.h>,
181 F<docs/busybox.pod>. This was tedious and error-prone, so it was
182 decided that F<usage.h> would contain all the text in a
183 machine-readable form, and scripts could be used to transform this
184 text into other forms if necessary.
186 F<autodocifier.pl> is one such script. It is based on a script by
187 Erik Andersen <andersen@codepoet.org> which was in turn based on a
188 script by Mark Whitley <markw@codepoet.org>
196 This displays the help message.
200 Generate POD (this is the default)
204 Be verbose (not implemented)
210 The following is an example of some data this script might parse.
212 #define length_trivial_usage \
214 #define length_full_usage \
215 "Prints out the length of the specified STRING."
216 #define length_example_usage \
220 Each entry is a cpp macro that defines a string. The macros are
221 named systematically in the form:
225 $name is the name of the applet. $type can be "trivial", "full", "notes",
226 or "example". Every documentation macro must end with "_usage".
228 The definition of the types is as follows:
234 This should be a brief, one-line description of parameters that
235 the command expects. This will be displayed when B<-h> is issued to
236 a command. I<REQUIRED>
240 This should contain descriptions of each option. This will also
241 be displayed along with the trivial help if CONFIG_FEATURE_TRIVIAL_HELP
242 is disabled. I<REQUIRED>
246 This is documentation that is intended to go in the POD or SGML, but
247 not be printed when a B<-h> is given to a command. To see an example
248 of notes being used, see init_notes_usage in F<usage.h>. I<OPTIONAL>
252 This should be an example of how the command is actually used.
253 This will not be printed when a B<-h> is given to a command -- it
254 will only be included in the POD or SGML documentation. I<OPTIONAL>
264 Copyright (c) 2001 John BEPPU. All rights reserved. This program is
265 free software; you can redistribute it and/or modify it under the same
266 terms as Perl itself.
270 John BEPPU <b@ax9.org>
274 # $Id: autodocifier.pl,v 1.26 2004/04/06 15:26:25 andersen Exp $