htdocs/install/ style

David L. Nicol david@kasey.umkc.edu
Wed Jun 30 15:43:00 GMT 1999


Gerald Pfeifer wrote:

> Add backquotes "`" before and after all command-lines
> 
>   `<code>./some/command --with options --and -such</code>`
> 
> The rationale is that some web browsers like lynx do display <CODE>
> exactly like regular text, so it is impossible to spot where exactly
> a command-line starts resp. ends.
> 
> In my opinion this is not needed when referring to options, as in
>   "...use the <CODE>-super-optimizer</CODE> option to..."
> but if that's easier (to add automagically) and you prefer to have
> a single convention, we can always use quotes. -- After all, that's
> exactly the reason why I asked on this list! ;-)
> 
> Any comments?

I agree.  I've recently found myself bracketing things to type into
shells with backquotes rather than putting them on their own lines
after dollar signs.  Lets make it as wide a standard as possible,
it seems more likely to become a standard than trying to educate
the whole world about perlpod C<code here> syntax or insisting that
lynx and its interpreters add color and tone.

________________________________________________________________________
  David Nicol 816.235.1187 UMKC Network Operations david@news.umkc.edu
                          "unpersuasive and dubious"



More information about the Gcc mailing list