Difference between revisions of "Linux"

From sigrok
Jump to navigation Jump to search
m (fixup link to Building for one FAQ item)
(81 intermediate revisions by 17 users not shown)
Line 1: Line 1:
[[File:sigrok linux.png|right|thumb|320px|sigrok-gui on Linux]]
This page describes how to build/install the sigrok subprojects on Linux.


This page describes how to build sigrok on Linux.
== Binaries ==


== Requirements ==
=== Distribution packages ===


* git (for cloning the source code repository)
Many Linux distributions ship with sigrok packages, see [[Downloads#Binaries_and_distribution_packages|Downloads]].
* gcc, g++, make, ...
* autoconf, automake, libtool, pkg-config
* [http://library.gnome.org/devel/glib/unstable/ libglib] >= 2.0
* [http://www.libusb.org libusb] >= 1.0.5
* [http://nih.at/libzip/ libzip] >= 0.8
* [http://www.intra2net.com/en/developer/libftdi/ libftdi] (optional, only required for some devices)
<!-- * [http://www.intra2net.com/en/developer/libftdi/ libftdi] >= 0.17 (optional, only required for some devices) -->
* [http://www.python.org Python] >= 2.5 (optional, only required for protocol decoders)
* [http://qt.nokia.com Qt + Qt Creator] >= 4.5 (optional, only required for building/editing the GUI)


== Installing the build-dependencies ==
If the sigrok packages in your distro are rather old, you can also use the AppImage we provide (see below).


On most Linux distributions there are pre-built packages for the sigrok dependencies (if not, you have to build the packages from source). The installation using a package manager is usually pretty simple.
=== AppImage ===


Debian/Ubuntu:
We provide AppImages (see [https://appimage.org appimage.org] for details) for [[sigrok-cli]] and [[PulseView]] which make it very easy and convenient to use sigrok on somewhat recent Linux distributions (most distros newer than Ubuntu 14.04 LTS (Trusty Tahr) from around 2014 should work fine).


$ '''sudo apt-get install git-core gcc g++ make autoconf automake libtool pkg-config \'''
After downloading the AppImage (see [[Downloads#Binaries_and_distribution_packages|Downloads]]) you can run it by simply making it executable and executing it, for example:
  '''libglib2.0-dev libftdi-dev libusb-1.0-0-dev libzip-dev python-dev qtcreator qt4-designer qt4-dev-tools libqt4-dev'''


Fedora:
$ '''chmod u+x PulseView-NIGHTLY-x86_64.AppImage'''
$ '''./PulseView-NIGHTLY-x86_64.AppImage'''


$ '''yum install gcc-c++ libtool glib2-devel libftdi-devel libusb1-devel libzip-devel qt-devel python-devel'''
You might need to install the libsigrok '''udev rules files''' to be able to access some devices, see [[Building#Cannot_access_USB_.2F_serial_.2F_other_device]] for details.


== Building ==
== Building (script, recommended) ==


  $ '''git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok'''
The most convenient method to build all of the sigrok subprojects from source is to use the '''sigrok-cross-linux''' script from the [https://sigrok.org/gitweb/?p=sigrok-util.git;a=tree;f=cross-compile/linux sigrok-util] repo. Despite the name, this script also does native builds out of the box.
  $ '''cd sigrok'''
 
The script assumes that you have installed all requirements of all sigrok subprojects, please check [[Building#Build_requirements]] for details.
 
$ '''git clone git://sigrok.org/sigrok-util'''
$ '''cd sigrok-util/cross-compile/linux'''
$ '''./sigrok-cross-linux'''
 
This will download the current git version of all required sigrok subprojects and build them, installing the results in '''$HOME/sr'''. You may want to check out the '''README''' and/or adapt the script to your needs (e.g. if you want to install elsewhere).
 
You can use the files from '''$HOME/sr''' using (for example) the [[Building#Installing_to_a_non-standard_directory_using_LD_LIBRARY_PATH|LD_LIBRARY_PATH method]].
 
== Building (manually) ==
 
<div style="background-color:#ff6666">
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the '''README'''/'''INSTALL''' file (of the subproject you want to build) for the full list of requirements.
</div>
 
=== libserialport ===
 
==== Installing the [[Building#Build_requirements|requirements]] ====
 
'''Debian/Ubuntu/Mint'''
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''
 
'''Arch'''
$ '''sudo pacman -S git gcc make autoconf automake libtool'''
 
==== Building ====
 
$ '''git clone git://sigrok.org/libserialport'''
$ '''cd libserialport'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''
 
=== libsigrok ===
 
==== Installing the [[Building#Build_requirements|requirements]] ====
 
'''Debian/Ubuntu/Mint'''
 
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''
  '''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''
  '''libusb-1.0-0-dev libftdi1-dev check doxygen python-numpy \'''
  '''python-dev python-gi-dev python-setuptools swig default-jdk'''
 
'''Fedora (18, 19, 20, 21, 22, 23)'''
 
$ '''sudo yum install git gcc make autoconf autoconf-archive automake libtool pkgconfig \'''
  ''' glib2-devel libzip-devel libusb1-devel libftdi-devel check-devel doxygen'''
 
:: For C++ bindings, add '''sudo yum install glibmm24-devel'''.
:: For Python bindings, add '''sudo yum install python-devel numpy pygobject3-devel swig'''.
:: For Fedora 23, you need as well: '''redhat-rpm-config''' and note that '''libusb1-devel''' is now '''libusbx-devel'''.
 
'''Arch'''
 
$ '''sudo pacman -S git gcc make autoconf autoconf-archive automake libtool \'''
  '''pkg-config glib2 glibmm libzip libusb libftdi check doxygen python-numpy \'''
  '''python-setuptools swig jdk8-openjdk'''
 
==== Building ====
 
  $ '''git clone git://sigrok.org/libsigrok'''
$ '''cd libsigrok'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''
 
==== Device access ====
 
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.
 
<div style="background-color:#ff6666">
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.
</div>
 
=== libsigrokdecode ===
 
==== Installing the [[Building#Build_requirements|requirements]] ====
 
'''Debian/Ubuntu/Mint'''
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''
 
'''Fedora (18, 19, 20)'''
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''
 
'''Arch'''
$ '''sudo pacman -S git gcc make autoconf automake libtool pkgconfig glib2 python check'''
 
==== Building ====
 
$ '''git clone git://sigrok.org/libsigrokdecode'''
$ '''cd libsigrokdecode'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''
 
=== sigrok-cli ===
 
==== Installing the [[Building#Build_requirements|requirements]] ====
 
'''Debian/Ubuntu/Mint'''
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''
 
'''Fedora (18, 19)'''
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''
 
'''OpenSuse'''
$ '''sudo zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''
 
'''Arch'''
$ '''sudo pacman -S git gcc make autoconf automake libtool pkgconfig glib2'''
 
==== Building ====
 
$ '''git clone git://sigrok.org/sigrok-cli'''
  $ '''cd sigrok-cli'''
  $ '''./autogen.sh'''
  $ '''./autogen.sh'''
  $ '''./configure'''
  $ '''./configure'''
Line 38: Line 149:
  $ '''sudo make install'''
  $ '''sudo make install'''


Then, for building the GUI:
=== PulseView ===


  $ '''cd gui'''
==== Installing the [[Building#Build_requirements|requirements]] ====
  $ '''qmake'''
 
'''Debian/Ubuntu/Mint'''
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''
  '''libglib2.0-dev libboost-test-dev libboost-serialization-dev \'''
  '''libboost-filesystem-dev libboost-system-dev libqt5svg5-dev qtbase5-dev'''
 
'''Fedora (18, 19, 23, 27)'''
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''
  '''boost-devel qt5-devel'''
 
'''Arch'''
$ '''sudo pacman -S git gcc make cmake libtool pkgconfig glib2 boost qt5 \'''
  '''qt5-base qt5-svg'''
 
==== Building ====
 
$ '''git clone git://sigrok.org/pulseview'''
  $ '''cd pulseview'''
  $ '''cmake .'''
  $ '''make'''
  $ '''make'''
$ '''sudo make install'''
==== Troubleshooting ====
See [[PulseView#Building]] for more tips and FAQs.
== FAQ ==
Make sure to also see the [[Building#FAQ|Building FAQ]] for subjects that are not specific to Linux.
=== Cannot open shared object file: No such file or directory ===
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].
=== Cannot access USB / serial / other device ===


If you get warnings claiming potential symbol conflicts when running qmake, you are likely invoking qt3. Try running qmake-qt4 to force the correct version.
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].


== Distribution packages ==
=== Required library not found ===


* Debian / Ubuntu: [[User:Uwe Hermann|Uwe Hermann]] will create [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=579600 packages for Debian unstable] (which will semi-automatically migrate to Ubuntu after a while).
See [[Building#Required_library_not_found|here]].
* Fedora: See [[Linux/Fedora]].

Revision as of 07:42, 1 October 2018

This page describes how to build/install the sigrok subprojects on Linux.

Binaries

Distribution packages

Many Linux distributions ship with sigrok packages, see Downloads.

If the sigrok packages in your distro are rather old, you can also use the AppImage we provide (see below).

AppImage

We provide AppImages (see appimage.org for details) for sigrok-cli and PulseView which make it very easy and convenient to use sigrok on somewhat recent Linux distributions (most distros newer than Ubuntu 14.04 LTS (Trusty Tahr) from around 2014 should work fine).

After downloading the AppImage (see Downloads) you can run it by simply making it executable and executing it, for example:

$ chmod u+x PulseView-NIGHTLY-x86_64.AppImage
$ ./PulseView-NIGHTLY-x86_64.AppImage

You might need to install the libsigrok udev rules files to be able to access some devices, see Building#Cannot_access_USB_.2F_serial_.2F_other_device for details.

Building (script, recommended)

The most convenient method to build all of the sigrok subprojects from source is to use the sigrok-cross-linux script from the sigrok-util repo. Despite the name, this script also does native builds out of the box.

The script assumes that you have installed all requirements of all sigrok subprojects, please check Building#Build_requirements for details.

$ git clone git://sigrok.org/sigrok-util
$ cd sigrok-util/cross-compile/linux
$ ./sigrok-cross-linux

This will download the current git version of all required sigrok subprojects and build them, installing the results in $HOME/sr. You may want to check out the README and/or adapt the script to your needs (e.g. if you want to install elsewhere).

You can use the files from $HOME/sr using (for example) the LD_LIBRARY_PATH method.

Building (manually)

IMPORTANT: The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the official build requirements list in the wiki or the README/INSTALL file (of the subproject you want to build) for the full list of requirements.

libserialport

Installing the requirements

Debian/Ubuntu/Mint

$ sudo apt-get install git-core gcc make autoconf automake libtool

Arch

$ sudo pacman -S git gcc make autoconf automake libtool

Building

$ git clone git://sigrok.org/libserialport
$ cd libserialport
$ ./autogen.sh
$ ./configure
$ make
$ sudo make install

libsigrok

Installing the requirements

Debian/Ubuntu/Mint

$ sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \
  automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \
  libusb-1.0-0-dev libftdi1-dev check doxygen python-numpy \
  python-dev python-gi-dev python-setuptools swig default-jdk

Fedora (18, 19, 20, 21, 22, 23)

$ sudo yum install git gcc make autoconf autoconf-archive automake libtool pkgconfig \
   glib2-devel libzip-devel libusb1-devel libftdi-devel check-devel doxygen
For C++ bindings, add sudo yum install glibmm24-devel.
For Python bindings, add sudo yum install python-devel numpy pygobject3-devel swig.
For Fedora 23, you need as well: redhat-rpm-config and note that libusb1-devel is now libusbx-devel.

Arch

$ sudo pacman -S git gcc make autoconf autoconf-archive automake libtool \
  pkg-config glib2 glibmm libzip libusb libftdi check doxygen python-numpy \
  python-setuptools swig jdk8-openjdk

Building

$ git clone git://sigrok.org/libsigrok
$ cd libsigrok
$ ./autogen.sh
$ ./configure
$ make
$ sudo make install

Device access

Please read this FAQ entry for any extra steps you may need to take to get your specific device working.

Please see Building#FAQ if you are sure that you installed all requirements properly but still encounter some issues.

libsigrokdecode

Installing the requirements

Debian/Ubuntu/Mint

$ sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev

Fedora (18, 19, 20)

$ sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel

Arch

$ sudo pacman -S git gcc make autoconf automake libtool pkgconfig glib2 python check

Building

$ git clone git://sigrok.org/libsigrokdecode
$ cd libsigrokdecode
$ ./autogen.sh
$ ./configure
$ make
$ sudo make install

sigrok-cli

Installing the requirements

Debian/Ubuntu/Mint

$ sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev

Fedora (18, 19)

$ sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel

OpenSuse

$ sudo zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel

Arch

$ sudo pacman -S git gcc make autoconf automake libtool pkgconfig glib2

Building

$ git clone git://sigrok.org/sigrok-cli
$ cd sigrok-cli
$ ./autogen.sh
$ ./configure
$ make
$ sudo make install

PulseView

Installing the requirements

Debian/Ubuntu/Mint

$ sudo apt-get install git-core g++ make cmake libtool pkg-config \
  libglib2.0-dev libboost-test-dev libboost-serialization-dev \
  libboost-filesystem-dev libboost-system-dev libqt5svg5-dev qtbase5-dev

Fedora (18, 19, 23, 27)

$ sudo yum install git gcc cmake libtool pkgconfig glib2-devel \
  boost-devel qt5-devel

Arch

$ sudo pacman -S git gcc make cmake libtool pkgconfig glib2 boost qt5 \
  qt5-base qt5-svg

Building

$ git clone git://sigrok.org/pulseview
$ cd pulseview
$ cmake .
$ make
$ sudo make install

Troubleshooting

See PulseView#Building for more tips and FAQs.

FAQ

Make sure to also see the Building FAQ for subjects that are not specific to Linux.

Cannot open shared object file: No such file or directory

See here.

TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files

See here.

Cannot access USB / serial / other device

See here.

Required library not found

See here.