TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
>>I've gotten into heated debates with co-workers over this one and
>>wanted some opinions.
>>For example, would you use:
>>a) rm <filename>
(using angle brackets that are not supposed to be typed as part of the
command)
>>b) rm *filename*
(where the asterisks here are denoting italicized text)
>>c) rm filename
(no special demarcation)
_________
According to a former professor and my fellow UNIX users around here, use
the angle braces <> to signify replacement when writing UNIX commands, and
use the square brackets [] to signify any optional part of the command. If
your audience doesn't know much about UNIX maybe you can include a key up
front...All our programmers and licensees use UNIX, so I can't comment on
other OS.
I hope this helps.
Martha
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
