how about a standard for online docs as well?

Rob Landley rob at landley.net
Sat Mar 25 20:33:58 UTC 2006


On Saturday 25 March 2006 11:23 am, Robert P. J. Day wrote:
>   and while i'm in the throes of nitpickery, is there a standard for
> command synopses at:
>
> 	http://busybox.net/downloads/BusyBox.html

Not yet. :)

> as an example, scroll down to the consecutive commands "mke2fs" and
> "mkfifo".  note that mke2fs's synopsis lists out *all* of its options,
> and follows that with the list all over again with an explanation for
> each option.
>
>   conversely, mkfifo, with only a single option, simply
> lists "[OPTIONS]" in the synopsis and expands on the option(s) below,
> which seems to be a more reasonable approach.
>
>   is there a basic template for command synopses that could/should be
> used?

Care to suggest one, and possibly fixup the existing ones (one at a time, 
preferably)?

> rday

Rob
-- 
Never bet against the cheap plastic solution.



More information about the busybox mailing list