Re: documenting Unix command lines; more than one line

Subject: Re: documenting Unix command lines; more than one line
From: Alexia Prendergast <alexiap -at- SEAGATESOFTWARE -dot- COM>
Date: Tue, 9 Sep 1997 11:38:09 -0400

I wouldn't do this -- I'd end with a user trying to enter the backslash
as part of the command.

I usually indent the wrap-around lines.

A.

--
Alexia Prendergast
Senior Technical Writer
Seagate Software
mailto:alexiap -at- sems -dot- com

>-----Original Message-----
>To indicate that a UNIX command (or any other procedural command for that
>matter) is continued on the next line you use a backslash at the end of the
>line.
>
>Example:
>
>> Gds [-envf <GDS_ENV_FILE>] [-strmf <GDS_STREAM_FILE>] \
> [-strmlib <GDS_LIBRARY_NAME>]
>
>
>

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: How long does it take to review a document?
Next by Author: Re: documenting Unix command lines; more than one line
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