native_client_sdk/doc_generated/sdk/download.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2
   3 <section id="download-the-native-client-sdk">
   4 <span id="download"></span><h1 id="download-the-native-client-sdk"><span id="download"></span>Download the Native Client SDK</h1>
   5 <p>This page provides an overview of the Native Client SDK, and instructions for
   6 downloading and installing the SDK.</p>
   7 <div id="home">
   8 <a class="button-nacl button-download" href="https://storage.googleapis.com/nativeclient-mirror/nacl/nacl_sdk/nacl_sdk.zip">Download SDK Zip File</a>
   9 </div><h2 id="overview"><span id="sdk-overview"></span>Overview</h2>
  10 <p>The Native Client SDK includes:</p>
  11 <ul class="small-gap">
  12 <li><strong>Support for multiple Pepper versions</strong> to compile for specific minimum
  13 versions of Chrome.</li>
  14 <li><strong>Update utility</strong> to download new bundles and updates to existing bundles.</li>
  15 <li><strong>Toolchains</strong> to compile for Portable Native Client (PNaCl), traditional
  16 Native Client (NaCl), and for compiling architecture-specific Native Client
  17 applications with glibc.</li>
  18 <li><strong>Examples</strong> Including C or C++ source files and header files illustrating
  19 how to use NaCl and Pepper, and Makefiles to build the example with each of
  20 the toolchains.</li>
  21 <li><strong>Tools</strong> for validating Native Client modules and running modules from the
  22 command line.</li>
  23 </ul>
  24 <p>Follow the steps below to download and install the Native Client SDK.</p>
  25 <h2 id="prerequisites"><span id="id1"></span>Prerequisites</h2>
  26 <h3 id="python-2-7"><span id="python27"></span>Python 2.7</h3>
  27 <p>Make sure that the Python executable is in your <code>PATH</code> variable. Python 3.x is
  28 not yet supported.</p>
  29 <ul class="small-gap">
  30 <li>On Mac and Linux, Python is likely preinstalled. Run the command <code>python -V</code>
  31 in a terminal window, and make sure that the version you have is 2.7.x.</li>
  32 <li>On Windows, you may need to install Python. Go to <a class="reference external" href="https://www.python.org/download/">https://www.python.org/
  33 download/</a> and select the latest 2.x
  34 version. In addition, be sure to add the Python directory (for example,
  35 <code>C:\python27</code>) to the <code>PATH</code> <a class="reference external" href="https://en.wikipedia.org/wiki/Environment_variable">environment variable</a>. Run <code>python -V</code> from a command line to
  36 verify that you properly configured the PATH variable.</li>
  37 </ul>
  38 <h3 id="make"><span id="id2"></span>Make</h3>
  39 <ul class="small-gap">
  40 <li>On the Mac, you need to install <code>make</code> on your system before you can build
  41 and run the examples in the SDK. One easy way to get <code>make</code>, along with
  42 several other useful tools, is to install <a class="reference external" href="https://developer.apple.com/technologies/tools/">Xcode Developer Tools</a>. After installing Xcode,
  43 go to the XCode menu, open the Preferences dialog box then select Downloads
  44 and Components. Verify that Command Line Tools are installed.</li>
  45 <li>On Windows, the Native Client SDK includes a copy of GNU Make.</li>
  46 </ul>
  47 <h2 id="platforms"><span id="id3"></span>Platforms</h2>
  48 <p>Native Client supports several operating systems, including Windows, Linux, OSX,
  49 and ChromeOS. It supports several architectures including on x86-32, x86-64,
  50 ARM, and MIPS.</p>
  51 <h2 id="versions"><span id="versioning"></span>Versions</h2>
  52 <p>Chrome is released on a six week cycle, and developer versions of Chrome are
  53 pushed to the public beta channel three weeks before each release. As with any
  54 software, each release of Chrome may include changes to Native Client and the
  55 Pepper interfaces that may require modification to existing applications.
  56 However, modules compiled for one version of Pepper/Chrome should work with
  57 subsequent versions of Pepper/Chrome. The SDK includes multiple versions of the
  58 Pepper APIs to help developers make adjustments to API changes and take
  59 advantage of new features: <a class="reference external" href="/native-client/pepper_stable">stable</a>, <a class="reference external" href="/native-client/pepper_beta">beta</a> and <a class="reference external" href="/native-client/pepper_dev">dev</a>.</p>
  60 <h2 id="installing-the-sdk"><span id="id4"></span>Installing the SDK</h2>
  61 <h3 id="downloading-and-unzipping"><span id="id5"></span>Downloading and Unzipping</h3>
  62 <ol class="arabic">
  63 <li><p class="first">Download the <a class="reference external" href="https://storage.googleapis.com/nativeclient-mirror/nacl/nacl_sdk/nacl_sdk.zip">SDK update zip file</a>.</p>
  64 </li>
  65 <li><p class="first">Unzip the file:</p>
  66 <ul class="small-gap">
  67 <li><p class="first">On Mac/Linux, run the command <code>unzip nacl_sdk.zip</code> in a terminal
  68 window.</p>
  69 </li>
  70 <li><p class="first">On Windows, right-click on the .zip file and select &#8220;Extract All...&#8221;. A
  71 dialog box opens; enter a location and click &#8220;Extract&#8221;.</p>
  72 </li>
  73 </ul>
  74 <p>A directory is created called <code>nacl_sdk</code> with the following files and
  75 directories:</p>
  76 <ul class="small-gap">
  77 <li><p class="first"><code>naclsdk</code> (and <code>naclsdk.bat</code> for Windows) &#8212; the update utility,
  78 which is the command you run to download and update bundles.</p>
  79 </li>
  80 <li><p class="first"><code>sdk_cache</code> &#8212; a directory with a manifest file that lists the bundles
  81 you have already downloaded.</p>
  82 </li>
  83 <li><p class="first"><code>sdk_tools</code> &#8212; the code run by the <code>naclsdk</code> command.</p>
  84 </li>
  85 </ul>
  86 </li>
  87 </ol>
  88 <h3 id="installing-the-stable-bundle"><span id="id6"></span>Installing the stable bundle</h3>
  89 <ol class="arabic">
  90 <li><p class="first">To see the SDK bundles that are available for download, go to the
  91 <code>nacl_sdk</code> directory and run <code>naclsdk</code> with the <code>list</code> command. The SDK
  92 includes a separate bundle for each version of Chrome/Pepper.</p>
  93 <p>On Mac/Linux:</p>
  94 <pre class="prettyprint">
  95 $ cd nacl_sdk
  96 $ ./naclsdk list
  97 </pre>
  98 <p>On Windows:</p>
  99 <pre class="prettyprint">
 100 &gt; cd nacl_sdk
 101 &gt; naclsdk list
 102 </pre>
 103 <p>You should see output similar to this:</p>
 104 <pre class="prettyprint">
 105 Bundles:
 106  I: installed
 107  *: update available
 108
 109   I  sdk_tools (stable)
 110      vs_addin (dev)
 111      pepper_31 (post_stable)
 112      pepper_32 (post_stable)
 113      pepper_33 (post_stable)
 114      pepper_34 (post_stable)
 115      pepper_35 (stable)
 116      pepper_36 (beta)
 117      pepper_37 (dev)
 118      pepper_canary (canary)
 119      bionic_canary (canary)
 120 </pre>
 121 <p>The sample output above shows that several bundles are available for
 122 download, and that you have already installed the latest revision of the
 123 <code>sdk_tools</code> bundle, which was included in the zip file. You never need to
 124 update the <code>sdk_tools</code> bundle. It is updated automatically (if necessary)
 125 whenever you run <code>naclsdk</code>.</p>
 126 <p>Bundles are labeled post-stable, stable, beta, dev, or canary. These labels
 127 usually correspond to the current versions of Chrome. We recommend that you
 128 develop against a &#8220;stable&#8221; bundle, because such bundles can be used by all
 129 current Chrome users. Native Client is designed to be backward-compatible.For
 130 example, applications developed with the <code>pepper_37</code> bundle can run in
 131 Chrome 37, Chrome 38, etc..</p>
 132 </li>
 133 <li><p class="first">Run <code>naclsdk</code> with the <code>update</code> command to download recommended bundles,
 134 including the current &#8220;stable&#8221; bundle.</p>
 135 <p>On Mac/Linux:</p>
 136 <pre class="prettyprint">
 137 $ ./naclsdk update
 138 </pre>
 139 <p>On Windows:</p>
 140 <pre class="prettyprint">
 141 &gt; naclsdk update
 142 </pre>
 143 <p>By default, <code>naclsdk</code> only downloads bundles that are recommended,
 144 generally those that are &#8220;stable.&#8221; For example, if the current &#8220;stable&#8221;
 145 bundle is <code>pepper_35</code>, then the <code>update</code> downloads that bundle. To
 146 download the <code>pepper_36</code> bundle you must ask for it explicitly:</p>
 147 <pre class="prettyprint">
 148 $ ./naclsdk update pepper_36
 149 </pre>
 150 </li>
 151 </ol>
 152 <h2 id="updating-bundles"><span id="id7"></span>Updating bundles</h2>
 153 <ol class="arabic">
 154 <li><p class="first">Run <code>naclsdk</code> with the <code>list</code> command. This shows you the list of available
 155 bundles and verifies which bundles you have installed.</p>
 156 <p>On Mac/Linux:</p>
 157 <pre class="prettyprint">
 158 $ ./naclsdk list
 159 </pre>
 160 <p>On Windows:</p>
 161 <pre class="prettyprint">
 162 &gt; naclsdk list
 163 </pre>
 164 <p>An asterisk (*) next to a bundle indicates that there is an update available
 165 it. For example:</p>
 166 <pre class="prettyprint">
 167 Bundles:
 168  I: installed
 169  *: update available
 170
 171   I  sdk_tools (stable)
 172      vs_addin (dev)
 173      pepper_31 (post_stable)
 174      pepper_32 (post_stable)
 175      pepper_33 (post_stable)
 176      pepper_34 (post_stable)
 177   I* pepper_35 (stable)
 178      pepper_36 (beta)
 179      pepper_37 (dev)
 180      pepper_canary (canary)
 181      bionic_canary (canary)
 182 </pre>
 183 <p>If you run <code>naclsdk update</code> now, it warns you with a message similar to
 184 this:</p>
 185 <pre class="prettyprint">
 186 WARNING: pepper_35 already exists, but has an update available. Run update
 187 with the --force option to overwrite the existing directory. Warning: This
 188 will overwrite any modifications you have made within this directory.
 189 </pre>
 190 </li>
 191 <li><p class="first">To download and install the new bundle, run:</p>
 192 <p>On Mac/Linux:</p>
 193 <pre class="prettyprint">
 194 $ ./naclsdk update --force
 195 </pre>
 196 <p>On Windows:</p>
 197 <pre class="prettyprint">
 198 &gt; naclsdk update --force
 199 </pre>
 200 </li>
 201 </ol>
 202 <h2 id="help-with-the-naclsdk-utility"><span id="id8"></span>Help with the <code>naclsdk</code> utility</h2>
 203 <ol class="arabic">
 204 <li><p class="first">For more information about the <code>naclsdk</code> utility, run:</p>
 205 <p>On Mac/Linux:</p>
 206 <pre class="prettyprint">
 207 $ ./naclsdk help
 208 </pre>
 209 <p>On Windows:</p>
 210 <pre class="prettyprint">
 211 &gt; naclsdk help
 212 </pre>
 213 </li>
 214 </ol>
 215 <h2 id="next-steps"><span id="id9"></span>Next steps</h2>
 216 <ul class="small-gap">
 217 <li>Browse the <a class="reference external" href="release-notes">Release Notes</a> for important
 218 information about the SDK and new bundles.</li>
 219 <li>If you&#8217;re just starting with Native Client, we recommend reading the
 220 <a class="reference external" href="../overview">Technical Overview</a> and walking through the
 221 <a class="reference external" href="devguide/tutorial/tutorial-part1">Getting Started Tutorial</a>.</li>
 222 <li>If you&#8217;d rather dive in, see
 223 <a class="reference external" href="devguide/devcycle/building">Building Native Client Modules</a>.</li>
 224 </ul>
 225 </section>
 226
 227 {{/partials.standard_nacl_article}}