[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

prompts in command examples



Hi,

The Red Hat documentation team recently had a discussion about using
prompts (such as "$" and "#") in command examples.

Joshua "top-posting ftw" Wulf came up with the following, and everyone
agreed (I think...):

---

OK, here it is:

When it's a command that should (could) be cut and pasted, it should
have no prompt. Example:

ls -Z /tmp

When it's a record of an interactive session then the prompt should be
included to distinguish commands from output. Example:

# ls -Z /tmp

-rw-rw-r--  auser   auser   user_u:object_r:user_home_t   bar
-rw-rw-r--  auser   auser   user_u:object_r:user_home_t   foo

And when you want to make some commentary on that, you close the box
and then speak.

---

Does anyone have any suggestions or objections?

Cheers.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]