Help:Style

From ArchWiki
Revision as of 17:38, 10 June 2011 by Pointone (talk | contribs) (Bot: Removing from Category:HOWTOs (English))
Jump to: navigation, search

Tango-document-new.pngThis article is a stub.Tango-document-new.png

Notes: please use the first argument of the template to provide more detailed indications. (Discuss in Help talk:Style#)

This page aims to provide a guide for the standardization of style in the articles of this wiki.

Note:
  • This guide is a draft, it has not been officialized yet, and its rules cannot be considered in a definitive status.
  • You are warmly invited to discuss your additions or modifications in the talk page, before submitting them; you can also start discussions in the forum, but you should add a link to the thread in the talk page anyway.

Commands: regular user or root

When writing CLI commands, always make distinction whether each should be issued as a regular user, or as root:

  • use $ for regular user commands:

Template:Cli

  • use # for root commands:

Template:Cli

Prefer using this method instead of writing $ sudo command unless it is really necessary. Do not assume the user uses sudo or other privilege escalation utilities (e.g. gksu, kdesu).

# sudo command is always wrong.

Note: Since # is also used to denote comments in text files, you should always make sure to avoid ambiguities, usually by explicitly writing to run the command or edit a text file (and ending the sentence with a colon, like in the examples above).