~droetker/ubuntu/saucy/bumblebee/fix-for-1250745

« back to all changes in this revision

Viewing changes to README.markdown

  • Committer: Package Import Robot
  • Author(s): Vincent Cheng
  • Date: 2013-05-03 03:04:38 UTC
  • Revision ID: package-import@ubuntu.com-20130503030438-uvmvja55iicztpxf
Tags: upstream-3.2.1
ImportĀ upstreamĀ versionĀ 3.2.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Bumblebee Daemon
 
2
=================
 
3
 
 
4
Bumblebee daemon is a rewrite of the original
 
5
[Bumblebee](https://github.com/Bumblebee-Project/Bumblebee-old)
 
6
service, providing an elegant and stable means of managing Optimus
 
7
hybrid graphics chipsets. A primary goal of this project is to not only
 
8
enable use of the discrete GPU for rendering, but also to enable
 
9
smart power management of the dGPU when it's not in use.
 
10
 
 
11
Build Requirements
 
12
-------------------
 
13
 
 
14
Source tarballs can be downloaded from
 
15
https://github.com/Bumblebee-Project/Bumblebee/downloads
 
16
 
 
17
The following packages are dependencies for the build process:
 
18
 
 
19
- pkg-config
 
20
- glib-2.0 and development headers
 
21
- libx11 and development headers
 
22
- libbsd and development headers (if pidfile support is enabled, default yes)
 
23
- help2man (optional, it is needed for building manual pages)
 
24
 
 
25
If you are building from git, you will also need:
 
26
 
 
27
- autotools (2.68+ recommended)
 
28
 
 
29
Runtime dependencies
 
30
--------------------
 
31
 
 
32
If you want to use `optirun` for running applications with the discrete nVidia
 
33
card, you will also need:
 
34
 
 
35
- At least one back-end for `optirun`:
 
36
  - [virtualgl](http://virtualgl.org/)
 
37
  - [primus](https://github.com/amonakov/primus) (beta)
 
38
- Driver for nvidia graphics card: [nouveau](http://nouveau.freedesktop.org/)
 
39
  or the proprietary nvidia driver. Don't install it directly from nvidia.com
 
40
  as it will break 3D capabilities on the Intel graphics card and therefore
 
41
  affect the display of frames from the nvidia card.
 
42
 
 
43
If you want to make use of Power Management, you will need:
 
44
 
 
45
- [bbswitch](https://github.com/Bumblebee-Project/bbswitch)
 
46
- If you're brave and want to try the `switcheroo` method, install at least the
 
47
  [optimus patch](http://lekensteyn.nl/files/nouveau-switcheroo-optimus.patch)
 
48
  (merged in Linux 3.3). Note that suspend is not yet supported by this
 
49
  method.
 
50
 
 
51
Building
 
52
---------
 
53
 
 
54
If you are building from git, you first need to run `autoreconf -fi` to generate
 
55
the `configure` script.
 
56
 
 
57
Next, run the configure script to check for dependencies and populate the
 
58
`Makefile`:
 
59
 
 
60
    ./configure
 
61
 
 
62
To set the default driver to `nvidia` and adjust the library and module paths
 
63
for it, use `./configure` like:
 
64
 
 
65
    ./configure CONF_DRIVER=nvidia CONF_DRIVER_MODULE_NVIDIA=nvidia-current \
 
66
      CONF_LDPATH_NVIDIA=/usr/lib/nvidia-current:/usr/lib32/nvidia-current \
 
67
      CONF_MODPATH_NVIDIA=/usr/lib/nvidia-current/xorg,/usr/lib/xorg/modules
 
68
 
 
69
For all available options, run:
 
70
 
 
71
    ./configure --help
 
72
 
 
73
After configuring, you can build the binaries with:
 
74
 
 
75
    make
 
76
 
 
77
Installing System-wide and Packaging
 
78
-------------------------------------
 
79
 
 
80
You can build the binaries and set the system wide paths at configure time
 
81
 
 
82
    ./configure --prefix=/usr --sysconfdir=/etc
 
83
    make
 
84
 
 
85
After building the binaries and bash completion script, it can be installed
 
86
together with an udev rule (unless `--without-udev-rules` was passed) using
 
87
`make`:
 
88
 
 
89
    sudo make install
 
90
 
 
91
For packagers you need to add DESTDIR=$pkgdir
 
92
 
 
93
    make install DESTDIR=$pkgdir
 
94
 
 
95
Example initscripts are available in the `scripts/` directory. Currently,
 
96
Upstart, systemd and Sys V initscripts are available.
 
97
 
 
98
Usage
 
99
------
 
100
 
 
101
The first time you install Bumblebee, the `bumblebee` group has to be created.
 
102
Users who are allowed to use Bumblebee need to be added to the group:
 
103
 
 
104
    sudo groupadd bumblebee
 
105
    sudo gpasswd -a $USER bumblebee
 
106
 
 
107
To run Bumblebee after installing it system-wide, run:
 
108
 
 
109
    sudo bumblebeed --daemon
 
110
    optirun -- <application>
 
111
 
 
112
For more information, try `--help` on either of the two binaries.
 
113
 
 
114
Interesting Links
 
115
------
 
116
- Facebook: http://www.bumblebee-project.org/facebook
 
117
- Twitter: http://www.bumblebee-project.org/twitter
 
118
- Google Plus: http://www.bumblebee-project.org/g+
 
119
- Ubuntu wiki: https://wiki.ubuntu.com/Bumblebee
 
120
- Arch wiki: https://wiki.archlinux.org/index.php/Bumblebee
 
121
- Mandriva wiki: http://wiki.mandriva.com/en/Bumblebee
 
122
- Debian wiki: http://wiki.debian.org/Bumblebee