native_client_sdk/src/doc/sdk/download.rst

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