Welcome to the Slackware Documentation Project

Differences

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

Link to this comparison view

slackbook:conventions_used_in_this_book [2012/09/04 12:31 (UTC)] (current)
alienbob created
Line 1: Line 1:
 +===== Conventions Used in this Book =====
  
 +To provide a consistent and easy to read text, several conventions are followed throughout the book.
 +
 +==== Typographic Conventions ====
 +
 +//Italic//
 +
 +An //italic// font is used for commands, emphasized text, and the first usage of technical terms.
 +
 +''//​Monospace//''​
 +
 +A ''//​monospaced//''​ font is used for error messages, commands, environment variables, names of ports, hostnames, user names, group names, device names, variables, and code fragments.
 +
 +**Bold**
 +
 +A **bold** font is used for user input in examples.
 +
 +==== User Input ====
 +
 +Keys are shown in bold to stand out from other text. Key combinations that are meant to be typed simultaneously are shown with "''​+''"​ between the keys, such as:
 +
 +<​key>​Ctrl-Alt-Del</​key>​
 +
 +Meaning the user should type the <​key>​Ctrl</​key>,​ <​key>​Alt</​key>,​ and <​key>​Del</​key>​ keys at the same time.
 +
 +Keys that are meant to be typed in sequence will be separated with commas, for example:
 +
 +<​key>​Ctrl-X</​key>,​ <​key>​Ctrl-S</​key>​
 +
 +Would mean that the user is expected to type the <​key>​Ctrl</​key>​ and <​key>​X</​key>​ keys simultaneously and then to type the <​key>​Ctrl</​key>​ and <​key>​S</​key>​ keys simultaneously.
 +
 +==== Examples ====
 +
 +Examples starting with ''​E:​\>''​ indicate a MS-DOS® command. Unless otherwise noted, these commands may be executed from a “Command Prompt” window in a modern Microsoft® Windows® environment.
 +
 +  D:\> rawrite a: bare.i
 +
 +Examples starting with ''#''​ indicate a command that must be invoked as the superuser in Slackware. You can login as root to type the command, or login as your normal account and use ''​su(1)''​ to gain superuser privileges.
 +
 +  # dd if=bare.i of=/dev/fd0
 +
 +Examples starting with ''​%''​ indicate a command that should be invoked from a normal user account. Unless otherwise noted, C-shell syntax is used for setting environment variables and other shell commands.
 +
 +  % top
 +
 +
 +====== Sources ======
 +  * Original source: [[http://​slackbook.org/​]]
 +
 +<!-- Please do not modify anything below, except adding new tags.-->
 +{{tag>​slackbook}}

In Other Languages
QR Code
QR Code slackbook:conventions_used_in_this_book (generated for current page)