BlackArch Linux
BlackArch Linux
BlackArch Linux
Contents
1 Introduction
1.1 What is BlackArch Linux? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2 Get involved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3
3
3
2 User Guide
2.1 Installation . . . . . . . . . . . . . . . . .
2.1.1 Setting up repository . . . . . . .
2.1.2 Installing packages . . . . . . . .
2.1.3 Installing packages from source . .
2.1.4 Installing from live-, netinstall- ISO
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
4
4
4
5
5
6
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
7
7
7
7
8
8
8
8
8
9
9
9
9
9
A Appendix
A.1 FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
A.2 AUTHORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
10
10
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
or ArchLinux
3 Developer Guide
3.1 Contributing to repository . . . . . . . . . . . . .
3.1.1 Required tutorials . . . . . . . . . . . . .
3.1.2 Steps for contributing . . . . . . . . . . .
3.1.3 Example . . . . . . . . . . . . . . . . . .
3.1.3.1 Fetch PKGBUILD . . . . . . . .
3.1.3.2 Clean up PKGBUILD . . . . . .
3.1.3.3 Adjust PKGBUILD . . . . . . .
3.1.3.4 Build the package . . . . . . . .
3.1.3.5 Install and test the package . .
3.1.3.6 Add, commit and push package
3.1.3.7 Create a pull request . . . . . .
3.1.4 Requests . . . . . . . . . . . . . . . . . .
3.1.5 General tips . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Chapter 1
Introduction
1.1
1.2
Get involved
You can get in touch with the BlackArch team. Just check out the following:
Web: http://www.blackarch.org/
Mail: blackarchlinux@gmail.com
IRC: irc://irc.freenode.net/blackarch
Chapter 2
User Guide
2.1
Installation
The following sections will show you how to setup the BlackArch repository and install packages.
BlackArch supports both, installing from repository using binary packages as well as compiling and
installing from sources.
BlackArch is compatible with normal Arch installations. It acts as an unofficial user repository. If you want an ISO instead, see the Live ISO section.
2.1.1
Setting up repository
There are 6 steps in order to setup and use the BlackArch repository successfully. You must follow
the instuctions in order. Do not add blackarch to your pacman.conf file without following steps 0
to 2 first.
1. If you have installed BlackArch before and there is an existing [blackarch] entry in
/etc/pacman.conf, remove or comment out the entry and run pacman -Syy.
2. Run the following as root. This is for package signing.
wget -q http://blackarch.org/keyring/blackarch-keyring.pkg.tar.xz{,.sig}
gpg --keyserver hkp://pgp.mit.edu --recv 4345771566D76038C7FEB43863EC0ADBEA87E4E3
gpg --keyserver-o no-auto-key-retrieve --with-f blackarch-keyring.pkg.tar.xz.sig
pacman-key --init
rm blackarch-keyring.pkg.tar.xz.sig
pacman --noc -U blackarch-keyring.pkg.tar.xz
3. If possible, please verify the signing keys fingerprint against as many sources as possible.
4. Append the following lines to your /etc/pacman.conf file:
[blackarch]
Server = <mirror_site>/$repo/os/$arch
Replace <mirror site> with a mirror site of your choosing. Please use one of our official mirrors.
5. Now run:
$ sudo pacman -Syyu
2.1.2
Installing packages
2.1.3
As part of an alternative method of installation, you can build the BlackArch packages from source.
You can find the PKGBUILDs on github. To build the entire repo, you can use the blackman tool.
First, you have to install blackman. If the BlackArch package repository is setup on your
machine, you can install blackman:
pacman -S blackman
2.1.4
You can install BlackArch Linux from one of our live- or netinstall-ISOs.
See http://www.blackarch.org/download.html#iso. The following steps are required after the
ISO boot up.
Install blackarch-install-scripts package:
$ sudo pacman -S blackarch-install-scripts
Run
$ sudo blackarch-install
Chapter 3
Developer Guide
3.1
Contributing to repository
This section shows you how to contribute to the BlackArch Linux project. We accept pull requests
of all sizes, from tiny typo fixes to new packages.
For help, suggestions, or questions feel free to contact us.
Everyone is welcome to contribute. All contributions are appreciated.
3.1.1
Required tutorials
3.1.2
In order to submit your changes to the BlackArchLinux project, follow these steps:
1. Fork the repository from https://github.com/BlackArchLinux/blackarchlinux
2. Hack the necessary files, (e.g. PKGBUILD, .patch files, etc).
3. Commit your changes.
4. Push your changes.
5. Ask us to merge in your changes, preferably through a pull request.
3.1.3
Example
The following example demonstrates submitting a new package to the BlackArch project. We use
yaourt (you can use pacaur as well) to fetch a pre-existing PKGBUILD file for nfsshell from the AUR
and adjust it according to our needs.
3.1.3.1
Fetch PKGBUILD
3.1.3.2
Clean up PKGBUILD
3.1.3.3
Adjust PKGBUILD
3.1.3.4
3.1.3.5
3.1.3.6
3.1.3.7
3.1.4
Requests
1. Dont add Maintainer or Contributor comments to PKGBUILD files. Add maintainer and
contributor names to the AUTHORS section of BlackArch guide.
2. For the sake of consistency, please follow the general style of the other PKGBUILD files in the
repo and use two-space indentation.
3.1.5
General tips
Appendix A
Appendix
A.1
FAQs
A.2
AUTHORS
20