User Tools

Site Tools


wiki:conventions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
wiki:conventions [2016/04/08 15:43] – [Interactive shell commands] Yann Pouillonwiki:conventions [2016/04/08 16:53] (current) – [General conventions] Yann Pouillon
Line 9: Line 9:
  
 <WRAP tip>To be found more easily, tips, tricks, advice, and notes, are written in yellow boxes with a light bulb on their left-hand side.</WRAP> <WRAP tip>To be found more easily, tips, tricks, advice, and notes, are written in yellow boxes with a light bulb on their left-hand side.</WRAP>
 +
 +<WRAP important>**IMPORTANT** \\ Essential information that you should read with good care is displayed in orange boxes with a warning sign on the left-hand side.</WRAP>
  
 ===== Interactive shell commands ===== ===== Interactive shell commands =====
  
-Many examples described on this wiki assume that the user is using a [[wp>Terminal_emulator|terminal]] to interact with Abinit. A terminal is a text window running a [[wp>Shell|shell]], which is a program executing commands entered by the user. Please click on the links within this section, look at your operating system documentation, and/or look on internet for "Opening a terminal" if you are not familiar with terminals and shells.+Many examples described on this wiki assume that the user is using a [[wp>Terminal_emulator|terminal]] to interact with Abinit. A terminal is a text window running a [[wp>Shell_(computing)|shell]], which is a program executing commands entered by the user. Please click on the links within this section, look at your operating system documentation, and/or look on internet for "Opening a terminal" if you are not familiar with terminals and shells.
  
-When describing interactive shell commands, we use the [[wp>Bourne_Shell|Bourne Shell]] conventions, since this is the most portable shell available and it is the one used by various components of Abinit. All commands entered by the user start with a dollar sign and a space character -- which should not be typed when you reproduce the examples on your own computer -- and their output is reproduced verbatim just below. In the following example:+When describing interactive shell commands, we use the [[wp>Bourne_shell|Bourne Shell]] conventions, since this is the most portable shell available and it is the one used by various components of Abinit. All commands entered by the user start with a dollar sign and a space character -- which should not be typed when you reproduce the examples on your own computer -- and their output is reproduced verbatim just below. In the following example:
 <code> <code>
 $ cat abinit.in $ cat abinit.in
wiki/conventions.1460123021.txt.gz · Last modified: 2016/04/08 15:43 by Yann Pouillon