Repository files navigation

Servo is a prototype web browser engine written in theRust language. It is currently developed on64-bit OS X, 64-bit Linux, 64-bit Windows, and Android.

Servo welcomes contribution from everyone. SeeCONTRIBUTING.md andHACKING_QUICKSTART.mdfor help getting started.

Visit theServo Project page for news and guides.

Building servo requiresrustup, version 1.8.0 or more recent.If you have an older version, runrustup self update.

To install on Windows, download and runrustup-init.exethen follow the onscreen instructions.

To install on other systems, run:

curl https://sh.rustup.rs -sSf| sh

This will also download the current stable version of Rust, which Servo won’t use.To skip that step, run instead:

curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain none

See alsoOther installation methods

Please select your operating system:

• OS X
• Debian-based Linuxes
• Fedora
• Arch Linux
• openSUSE
• Gentoo Linux
• Microsoft Windows
• Android

brew install automake pkg-config python cmake yasmpip install virtualenv

sudo port install python27 py27-virtualenv cmake yasm

brew install opensslexport OPENSSL_INCLUDE_DIR="$(brew --prefix openssl)/include"export OPENSSL_LIB_DIR="$(brew --prefix openssl)/lib"./mach build ...

If you've already partially compiled servo but forgot to do this step, run./mach clean, set the shell variables, and recompile.

sudo apt install git curl freeglut3-dev autoconf libx11-dev \    libfreetype6-dev libgl1-mesa-dri libglib2.0-dev xorg-dev \    gperf g++ build-essential cmake virtualenv python-pip \    libssl1.0-dev libbz2-dev libosmesa6-dev libxmu6 libxmu-dev \    libglu1-mesa-dev libgles2-mesa-dev libegl1-mesa-dev libdbus-1-dev \    libharfbuzz-dev ccache

If you using a version prior toUbuntu 17.04 orDebian Sid, replacelibssl1.0-dev withlibssl-dev.

If you are onUbuntu 14.04 and encountered errors on installing these dependencies involvinglibcheese, see#6158 for a workaround.

Ifvirtualenv does not exist, trypython-virtualenv.

sudo dnf install curl freeglut-devel libtool gcc-c++ libXi-devel \    freetype-devel mesa-libGL-devel mesa-libEGL-devel glib2-devel libX11-devel libXrandr-devel gperf \    fontconfig-devel cabextract ttmkfdir python python-virtualenv python-pip expat-devel \    rpm-build openssl-devel cmake bzip2-devel libXcursor-devel libXmu-devel mesa-libOSMesa-devel \    dbus-devel ncurses-devel harfbuzz-devel ccache

sudo yum install curl freeglut-devel libtool gcc-c++ libXi-devel \    freetype-devel mesa-libGL-devel mesa-libEGL-devel glib2-devel libX11-devel libXrandr-devel gperf \    fontconfig-devel cabextract ttmkfdir python python-virtualenv python-pip expat-devel \    rpm-build openssl-devel cmake3 bzip2-devel libXcursor-devel libXmu-devel mesa-libOSMesa-devel \    dbus-devel ncurses-devel python34 harfbuzz-devel ccache

sudo zypper install libX11-devel libexpat-devel libbz2-devel Mesa-libEGL-devel Mesa-libGL-devel cabextract cmake \    dbus-1-devel fontconfig-devel freetype-devel gcc-c++ git glib2-devel gperf \    harfbuzz-devel libOSMesa-devel libXcursor-devel libXi-devel libXmu-devel libXrandr-devel libopenssl-devel \    python-pip python-virtualenv rpm-build glu-devel ccache

sudo pacman -S --needed base-devel git python2 python2-virtualenv python2-pip mesa cmake bzip2 libxmu glu \    pkg-config ttf-fira-sans harfbuzz ccache

sudo emerge net-misc/curl media-libs/freeglut \    media-libs/freetype media-libs/mesa dev-util/gperf \    dev-python/virtualenv dev-python/pip dev-libs/openssl \    x11-libs/libXmu media-libs/glu x11-base/xorg-server \    media-libs/harfbuzz dev-util/ccache

1. Install Python for Windows (https://www.python.org/downloads/release/python-2714/). The Windows x86-64 MSI installer is fine.You should change the installation to install the "Add python.exe to Path" feature.

2. Install virtualenv.

In a normal Windows Shell (cmd.exe or "Command Prompt" from the start menu), do:

pip install virtualenv

If this does not work, you may need to reboot for the changed PATH settings (by the python installer) to take effect.

3. Install Git for Windows (https://git-scm.com/download/win). DO allow it to add git.exe to the PATH (defaultsettings for the installer are fine).

4. Install Visual Studio Community 2017 (https://www.visualstudio.com/vs/community/). You MUST add "Visual C++" to thelist of installed components. It is not on by default. Visual Studio 2017 MUST installed to the default location or mach.bat will not find it.

If you encountered errors with the environment above, do the following for a workaround:

1. Download and installBuild Tools for Visual Studio 2017
2. Installpython2.7 x86-x64 andvirtualenv
3. Runmach.bat build -d.

If you have troubles withx64 type prompt asmach.bat set by default:

1. you may need to choose and launch the type manually, such asx86_x64 Cross Tools Command Prompt for VS 2017 in the Windows menu.)
2. cd to/the/path/servo
3. python mach build -d

Pre-installed Android tools are needed. See wiki fordetails

Servo's build system uses rustup.rs to automatically download a Rust compiler.This is a specific version of Rust Nightly determined by therust-toolchain file.

Servo is built withCargo, the Rust package manager. We also use Mozilla'sMach tools to orchestrate the build and other tasks.

To build Servo in development mode. This is useful for development, butthe resulting binary is very slow.

git clone https://github.com/servo/servocd servo./mach build --dev./mach run tests/html/about-mozilla.html

Or on Windows MSVC, in a normal Command Prompt (cmd.exe):

git clone https://github.com/servo/servocd servomach.bat build --dev

For benchmarking, performance testing, orreal-world use, add the--release flag to create an optimized build:

./mach build --release./mach run --release tests/html/about-mozilla.html

If you’re making changes to one crate that cause build errors in another crate,consider this instead of a full build:

./mach check

It will runcargo check, which runs the analysis phase of the compiler(and so shows build errors if any) but skips the code generation phase.This can be a lot faster than a full build,though of course it doesn’t produce a binary you can run.

git clone https://github.com/servo/servocd servoexport ANDROID_SDK="/path/to/sdk"export ANDROID_NDK="/path/to/ndk"export ANDROID_TOOLCHAIN="/path/to/toolchain"export PATH="$PATH:/path/to/toolchain/bin"./mach build --release --android./mach package --release --android

Rather than setting theANDROID_* environment variables every time, you canalso create a.servobuild file and then edit it to contain the correct pathsto the Android SDK/NDK tools:

cp servobuild.example .servobuild# edit .servobuild

Run Servo with the command:

./servo [url] [arguments]# if you run with nightly build./mach run [url] [arguments]# if you run with mach# For example./mach run https://www.google.com

• -p INTERVAL turns on the profiler and dumps info to the console everyINTERVAL seconds
• -s SIZE sets the tile size for painting; defaults to 512
• -z disables all graphical output; useful for running JS / layout tests
• -Z help displays useful output to debug servo

• Ctrl+- zooms out
• Ctrl+= zooms in
• Alt+left arrow goes backwards in the history
• Alt+right arrow goes forwards in the history
• Esc exits servo

There are lots of mach commands you can use. You can list them with./mach --help.

The generated documentation can be found onhttp://doc.servo.org/servo/index.html