Re: documenting Unix command lines; more than one line

Subject: Re: documenting Unix command lines; more than one line
From: "Stephen D. Martin" <smartin -at- RC -dot- GC -dot- CA>
Date: Tue, 9 Sep 1997 12:52:58 -0400

Alexia Prendergast wrote:

> Yes, I'm aware of that -- but that wasn't the original question.
> The question was how to format one line that the user enters
> at once, not break it up into several lines for the user to enter
> one-at-a-time. (At least, that was my understanding, but I could
> very well have misunderstood ;-)

Regardless of the question I think indenting is superior to the
backslash. The Unix "power user" (synonym for geek?), shouldn't need
the manual at all (grin), or at least should be able to recognize that
the second line of text is not a distinct command line (especially with
all that white space ahead of it).

One should also think of the non-power user, the poor smuck who'll end
up typing in that backslash, and who'll end up getting an
incomprehensible error message. Assuming that Jen and Eric User do try
to type the indented line as a distinct command, they are more likely to
get a helpful error message.

Cheers!

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: Stealing Technical Writing (Was: Using...)
Next by Author: Re: Stealing Technical Writing (Was: Using...)
Previous by Thread: Re: documenting Unix command lines; more than one line
Next by Thread: Re: documenting Unix command lines; more than one line


What this post helpful? Share it with friends and colleagues:


Sponsored Ads