sphinx/index.rst

   1 ***********************************************
   2  Welcome to the Debian Neuroscience Repository
   3 ***********************************************
   4
   5 This repository provides mostly neuroscience-related packages to be used on
   6 Debian systems (or Debian-derivatives like Ubuntu). It contains both unofficial
   7 or prospective packages which are not (yet) available from the main Debian
   8 archive, as well backported or simply rebuilt packages also available
   9 elsewhere. Please see the :ref:`faq` for more information about the goals of
  10 this project.
  11
  12 This service is provided "as is". There is no guarantee that a package
  13 works as expected, so use them at your own risk. They might kill your
  14 system (although that is rather unlikely). You've been warned!
  15
  16 The repository contains both neuroscience-related packages, as well as general
  17 purpose software which is necessary to resolve dependencies, or such that is
  18 simply useful in the neuroscience context. All featured neuroscience software
  19 packages are available from the :ref:`full package list <full_pkg_list>`.
  20
  21
  22 .. _repository_howto:
  23
  24 How to use this repository
  25 ==========================
  26
  27 The easiest way to use this repository is to download an APT-configuration file
  28 (`sources.list`). Simply choose your target distribution/release and download
  29 the configuration for a mirror close to you (depending on your browser, you
  30 might have to right-click and choose 'save as'). Once downloaded, put the file
  31 in the `/etc/apt/sources.list.d/` directory on your system. Moving files in
  32 this directory will require superuser privileges, therefore you should probably
  33 download the file into a temporary directory and subsequently move it into
  34 `/etc/apt/sources.list.d/`. APT-configurations are available for the following
  35 releases and repository mirrors:
  36
  37 .. include:: sources_lists
  38
  39 .. note::
  40   If your are interested in mirroring the repository, please see the :ref:`faq`.
  41
  42 Once this is done, you have to update the package index. Use your favorite
  43 package manager, e.g. synaptic, adept, or whatever you like. In the terminal
  44 you can use :command:`aptitude` to achieve the same::
  45
  46   sudo aptitude update
  47
  48 Now, you can proceed to install packages, e.g.::
  49
  50   sudo aptitude install lipsia
  51
  52 .. note::
  53   Not every package is available for all distributions/releases. For information
  54   about which package version is available for which release and architecture,
  55   please have a look at the corresponding package pages.
  56
  57
  58 Package authentication
  59 ----------------------
  60
  61 When you start using this repository, you probably get warning messages
  62 like this::
  63
  64   The following signatures couldn't be verified because
  65   the public key is not available.`
  66
  67 Or you will be asked questions like this over and over::
  68
  69   WARNING: The following packages cannot be authenticated!
  70   ...
  71   Install these packages without verification [y/N]?
  72
  73 This is because your APT installation initially does not know the GPG
  74 key that is used to sign the release files of this repository. Making
  75 APT happy again is easy:
  76
  77 1. Get the key. Either download the `repository key from here
  78    <_static/neuro.debian.net.asc>`_
  79    or fetch it from http://wwwkeys.pgp.net (2649A5A9).
  80
  81 2. Now feed the key into APT by invoking::
  82
  83      apt-key add #file#
  84
  85    Where `#file#` has to be replaced with the location of the key file you just
  86    downloaded. You need to have superuser-privileges to do this (either do it
  87    as root or use sudo).