Re: scotty man page
Doug Hughes (Doug.Hughes@Eng.Auburn.EDU)
Tue, 6 Feb 1996 17:36:47 -0600
>
>Robert> Only the last one is the actual syntax, while in the preceding
>Robert> mib commands, the -exact option should be placed just after
>Robert> the mib key word, e.g. mib ?-exact? oid name.
>
>Fixed in my sources now.
>
>Robert> Also, I would recommend sticking to the style of the original
>Robert> Tcl man pages in the syntax of the scotty commands. For
>Robert> example, when describing optional parameters, it would be
>Robert> better to use ?-exact? instead of [-exact] because of the
>Robert> special meaning of characters [ and ] in Tcl.
>
>What do others think about this?
>
I'm afraid I disagree. All unix man pages are standard with regard to the
[ ] syntax. Just because tcl/tk is different doesn't make it correct. The
tcl/tk man pages are some of the most non-standard man pages in existence.
I prefer to see them conform to the man page format of the rest of the world
than that of tcl/tk despite its close associations.
--
____________________________________________________________________________
Doug Hughes Engineering Network Services
System/Net Admin Auburn University
doug@eng.auburn.edu
Pro is to Con as progress is to congress