| <?xml version="1.0" encoding="UTF-8" standalone="no"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Preface</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta name="generator" content="publican 2.8" /><meta name="package" content="Apache_CloudStack-qig-4.1.1-en-US-0-0" /><script type="text/javascript" src="../../../../../toc.js"></script><script type="text/javascript"> |
| addID('Apache_CloudStack'); |
| |
| addID('Apache_CloudStack.4.1.1'); |
| |
| addID('Apache_CloudStack.4.1.1.books'); |
| addID('Apache_CloudStack.4.1.1.qig'); |
| </script><link rel="home" href="index.html" title="Quick Install Guide" /><link rel="up" href="index.html" title="Quick Install Guide" /><link rel="prev" href="index.html" title="Quick Install Guide" /><link rel="next" href="feedback.html" title="2. Submitting Feedback and Getting Help" /></head><body class="toc_embeded "><div id="tocdiv" class="toc"><iframe id="tocframe" class="toc" src="../../../../toc.html">This is an iframe, to view it upgrade your browser or enable iframe display.</iframe></div><p id="title"><a class="left" href="http://cloudstack.apache.org"><img src="Common_Content/images/image_left.png" alt="Product Site" /></a><a class="right" href="http://cloudstack.apache.org/docs"><img src="Common_Content/images/image_right.png" alt="Documentation Site" /></a></p><ul class="docnav"><li class="previous"><a accesskey="p" href="index.html"><strong>Prev</strong></a></li><li class="next"><a accesskey="n" href="feedback.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="preface" id="pref-qig-Preface" lang="en-US"><div class="titlepage"><div><div><h1 class="title">Preface</h1></div></div></div><div xml:lang="en-US" class="section" id="idp39256736" lang="en-US"><div class="titlepage"><div><div><h2 class="title" id="idp39256736">1. Document Conventions</h2></div></div></div><div class="para"> |
| This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. |
| </div><div class="para"> |
| In PDF and paper editions, this manual uses typefaces drawn from the <a href="https://fedorahosted.org/liberation-fonts/">Liberation Fonts</a> set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default. |
| </div><div class="section" id="idp37560096"><div class="titlepage"><div><div><h3 class="title" id="idp37560096">1.1. Typographic Conventions</h3></div></div></div><div class="para"> |
| Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows. |
| </div><div class="para"> |
| <code class="literal">Mono-spaced Bold</code> |
| </div><div class="para"> |
| Used to highlight system input, including shell commands, file names and paths. Also used to highlight keycaps and key combinations. For example: |
| </div><div class="blockquote"><blockquote class="blockquote"><div class="para"> |
| To see the contents of the file <code class="filename">my_next_bestselling_novel</code> in your current working directory, enter the <code class="command">cat my_next_bestselling_novel</code> command at the shell prompt and press <span class="keycap"><strong>Enter</strong></span> to execute the command. |
| </div></blockquote></div><div class="para"> |
| The above includes a file name, a shell command and a keycap, all presented in mono-spaced bold and all distinguishable thanks to context. |
| </div><div class="para"> |
| Key combinations can be distinguished from keycaps by the hyphen connecting each part of a key combination. For example: |
| </div><div class="blockquote"><blockquote class="blockquote"><div class="para"> |
| Press <span class="keycap"><strong>Enter</strong></span> to execute the command. |
| </div><div class="para"> |
| Press <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>Alt</strong></span>+<span class="keycap"><strong>F2</strong></span> to switch to the first virtual terminal. Press <span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>Alt</strong></span>+<span class="keycap"><strong>F1</strong></span> to return to your X-Windows session. |
| </div></blockquote></div><div class="para"> |
| The first paragraph highlights the particular keycap to press. The second highlights two key combinations (each a set of three keycaps with each set pressed simultaneously). |
| </div><div class="para"> |
| If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in <code class="literal">mono-spaced bold</code>. For example: |
| </div><div class="blockquote"><blockquote class="blockquote"><div class="para"> |
| File-related classes include <code class="classname">filesystem</code> for file systems, <code class="classname">file</code> for files, and <code class="classname">dir</code> for directories. Each class has its own associated set of permissions. |
| </div></blockquote></div><div class="para"> |
| <span class="application"><strong>Proportional Bold</strong></span> |
| </div><div class="para"> |
| This denotes words or phrases encountered on a system, including application names; dialog box text; labeled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example: |
| </div><div class="blockquote"><blockquote class="blockquote"><div class="para"> |
| Choose <span class="guimenu"><strong>System</strong></span> → <span class="guisubmenu"><strong>Preferences</strong></span> → <span class="guimenuitem"><strong>Mouse</strong></span> from the main menu bar to launch <span class="application"><strong>Mouse Preferences</strong></span>. In the <span class="guilabel"><strong>Buttons</strong></span> tab, click the <span class="guilabel"><strong>Left-handed mouse</strong></span> check box and click <span class="guibutton"><strong>Close</strong></span> to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand). |
| </div><div class="para"> |
| To insert a special character into a <span class="application"><strong>gedit</strong></span> file, choose <span class="guimenu"><strong>Applications</strong></span> → <span class="guisubmenu"><strong>Accessories</strong></span> → <span class="guimenuitem"><strong>Character Map</strong></span> from the main menu bar. Next, choose <span class="guimenu"><strong>Search</strong></span> → <span class="guimenuitem"><strong>Find…</strong></span> from the <span class="application"><strong>Character Map</strong></span> menu bar, type the name of the character in the <span class="guilabel"><strong>Search</strong></span> field and click <span class="guibutton"><strong>Next</strong></span>. The character you sought will be highlighted in the <span class="guilabel"><strong>Character Table</strong></span>. Double-click this highlighted character to place it in the <span class="guilabel"><strong>Text to copy</strong></span> field and then click the <span class="guibutton"><strong>Copy</strong></span> button. Now switch back to your document and choose <span class="guimenu"><strong>Edit</strong></span> → <span class="guimenuitem"><strong>Paste</strong></span> from the <span class="application"><strong>gedit</strong></span> menu bar. |
| </div></blockquote></div><div class="para"> |
| The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in proportional bold and all distinguishable by context. |
| </div><div class="para"> |
| <code class="command"><em class="replaceable"><code>Mono-spaced Bold Italic</code></em></code> or <span class="application"><strong><em class="replaceable"><code>Proportional Bold Italic</code></em></strong></span> |
| </div><div class="para"> |
| Whether mono-spaced bold or proportional bold, the addition of italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example: |
| </div><div class="blockquote"><blockquote class="blockquote"><div class="para"> |
| To connect to a remote machine using ssh, type <code class="command">ssh <em class="replaceable"><code>username</code></em>@<em class="replaceable"><code>domain.name</code></em></code> at a shell prompt. If the remote machine is <code class="filename">example.com</code> and your username on that machine is john, type <code class="command">ssh john@example.com</code>. |
| </div><div class="para"> |
| The <code class="command">mount -o remount <em class="replaceable"><code>file-system</code></em></code> command remounts the named file system. For example, to remount the <code class="filename">/home</code> file system, the command is <code class="command">mount -o remount /home</code>. |
| </div><div class="para"> |
| To see the version of a currently installed package, use the <code class="command">rpm -q <em class="replaceable"><code>package</code></em></code> command. It will return a result as follows: <code class="command"><em class="replaceable"><code>package-version-release</code></em></code>. |
| </div></blockquote></div><div class="para"> |
| Note the words in bold italics above — username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system. |
| </div><div class="para"> |
| Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example: |
| </div><div class="blockquote"><blockquote class="blockquote"><div class="para"> |
| Publican is a <em class="firstterm">DocBook</em> publishing system. |
| </div></blockquote></div></div><div class="section" id="idp35560080"><div class="titlepage"><div><div><h3 class="title" id="idp35560080">1.2. Pull-quote Conventions</h3></div></div></div><div class="para"> |
| Terminal output and source code listings are set off visually from the surrounding text. |
| </div><div class="para"> |
| Output sent to a terminal is set in <code class="computeroutput">mono-spaced roman</code> and presented thus: |
| </div><pre class="screen">books Desktop documentation drafts mss photos stuff svn |
| books_tests Desktop1 downloads images notes scripts svgs</pre><div class="para"> |
| Source-code listings are also set in <code class="computeroutput">mono-spaced roman</code> but add syntax highlighting as follows: |
| </div><pre class="programlisting">package org.<span class="perl_Function">jboss</span>.<span class="perl_Function">book</span>.<span class="perl_Function">jca</span>.<span class="perl_Function">ex1</span>; |
| |
| <span class="perl_Keyword">import</span> javax.naming.InitialContext; |
| |
| <span class="perl_Keyword">public</span> <span class="perl_Keyword">class</span> ExClient |
| { |
| <span class="perl_Keyword">public</span> <span class="perl_DataType">static</span> <span class="perl_DataType">void</span> <span class="perl_Function">main</span>(String args[]) |
| <span class="perl_Keyword">throws</span> Exception |
| { |
| InitialContext iniCtx = <span class="perl_Keyword">new</span> InitialContext(); |
| Object ref = iniCtx.<span class="perl_Function">lookup</span>(<span class="perl_String">"EchoBean"</span>); |
| EchoHome home = (EchoHome) ref; |
| Echo echo = home.<span class="perl_Function">create</span>(); |
| |
| System.<span class="perl_Function">out</span>.<span class="perl_Function">println</span>(<span class="perl_String">"Created Echo"</span>); |
| |
| System.<span class="perl_Function">out</span>.<span class="perl_Function">println</span>(<span class="perl_String">"Echo.echo('Hello') = "</span> + echo.<span class="perl_Function">echo</span>(<span class="perl_String">"Hello"</span>)); |
| } |
| }</pre></div><div class="section" id="idp39187520"><div class="titlepage"><div><div><h3 class="title" id="idp39187520">1.3. Notes and Warnings</h3></div></div></div><div class="para"> |
| Finally, we use three visual styles to draw attention to information that might otherwise be overlooked. |
| </div><div class="note"><div class="admonition_header"><h2>Note</h2></div><div class="admonition"><div class="para"> |
| Notes are tips, shortcuts or alternative approaches to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier. |
| </div></div></div><div class="important"><div class="admonition_header"><h2>Important</h2></div><div class="admonition"><div class="para"> |
| Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring a box labeled 'Important' will not cause data loss but may cause irritation and frustration. |
| </div></div></div><div class="warning"><div class="admonition_header"><h2>Warning</h2></div><div class="admonition"><div class="para"> |
| Warnings should not be ignored. Ignoring warnings will most likely cause data loss. |
| </div></div></div></div></div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="index.html"><strong>Prev</strong>Quick Install Guide</a></li><li class="up"><a accesskey="u" href="#"><strong>Up</strong></a></li><li class="home"><a accesskey="h" href="index.html"><strong>Home</strong></a></li><li class="next"><a accesskey="n" href="feedback.html"><strong>Next</strong>2. Submitting Feedback and Getting Help</a></li></ul></body></html> |
