aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rwxr-xr-xdocs/autodocifier.pl20
1 files changed, 12 insertions, 8 deletions
diff --git a/docs/autodocifier.pl b/docs/autodocifier.pl
index 3016e4022..377c8b55b 100755
--- a/docs/autodocifier.pl
+++ b/docs/autodocifier.pl
@@ -189,11 +189,15 @@ Example:
189 189
190The purpose of this script is to automagically generate documentation 190The purpose of this script is to automagically generate documentation
191for busybox using its usage.h as the original source for content. 191for busybox using its usage.h as the original source for content.
192Currently, the same content has to be duplicated in 3 places in 192It used to be that same content has to be duplicated in 3 places in
193slightly different formats -- F<usage.h>, F<docs/busybox.pod>, and 193slightly different formats -- F<usage.h>, F<docs/busybox.pod>, and
194F<docs/busybox.sgml>. This is tedious, so Perl has come to the rescue. 194F<docs/busybox.sgml>. This was tedious and error-prone, so it was
195decided that F<usage.h> would contain all the text in a
196machine-readable form, and scripts could be used to transform this
197text into other forms if necessary.
195 198
196This script was based on a script by Erik Andersen <andersen@lineo.com> 199F<autodocifier.pl> is one such script.
200It was based on a script by Erik Andersen <andersen@lineo.com>
197which was in turn based on a script by Mark Whitley <markw@lineo.com> 201which was in turn based on a script by Mark Whitley <markw@lineo.com>
198 202
199=head1 OPTIONS 203=head1 OPTIONS
@@ -258,13 +262,13 @@ is disabled. I<REQUIRED>
258 262
259This is documentation that is intended to go in the POD or SGML, but 263This is documentation that is intended to go in the POD or SGML, but
260not be printed when a B<-h> is given to a command. To see an example 264not be printed when a B<-h> is given to a command. To see an example
261of notes being used, see init_notes_usage. I<OPTIONAL> 265of notes being used, see init_notes_usage in F<usage.h>. I<OPTIONAL>
262 266
263=item B<example> 267=item B<example>
264 268
265This should be an example of how the command is acutally used. 269This should be an example of how the command is actually used.
266This will not be printed when a B<-h> is given to a command -- it 270This will not be printed when a B<-h> is given to a command -- it
267is inteded only for the POD or SGML documentation. I<OPTIONAL> 271will only be included in the POD or SGML documentation. I<OPTIONAL>
268 272
269=back 273=back
270 274
@@ -280,8 +284,8 @@ terms as Perl itself.
280 284
281=head1 AUTHOR 285=head1 AUTHOR
282 286
283John BEPPU <beppu@lineo.com> 287John BEPPU <b@ax9.org>
284 288
285=cut 289=cut
286 290
287# $Id: autodocifier.pl,v 1.22 2001/10/24 04:59:20 andersen Exp $ 291# $Id: autodocifier.pl,v 1.23 2001/10/31 04:29:18 beppu Exp $