Figure 6.5 Main page of a GitHub project
You can then browse (and search) the list of open issues. Once you are confident that your bug is
not yet filed, you can click on the New issue button (Figure
6.6
, “
Issues page of a GitHub project
”
[page 150]).
149
Chapter 6 — Helping Yourself and Getting Help
Figure 6.6 Issues page of a GitHub project
You are now on a page where you must describe your problem (Figure
6.7
, “
GitHub form to file
a new issue
” [page 150]). GitHub has a template feature allowing the owner of the repository to
define their own custom issue template, however it appears that this repository does not have one
setup. However, the bug reporting mechanism is fairly straight-forward, allowing you to attach
files, apply formatting to text, and much more. Of course, for best results, be sure to follow our
guidelines for creating a detailed and well-described report.
Figure 6.7 GitHub form to file a new issue
150
Kali Linux Revealed
6.4. Summary
In this section, we discussed various methods to help you find documentation and information
about programs and how to find help with problems you may encounter. We took a look at manual
and info pages and the
apropos
and
info
commands. We discussed bug trackers, provided some
tips on how to search for and submit good bug reports, and provided some tips to help you figure
out who owns the program or project in question.
Summary Tips:
• Before you can understand what is really going on when there is a problem, you need to
know the theoretical role played by each program involved in the problem. One of the best
ways to do this is to review the program’s documentation.
• To view a manual page, simply type
man manual-page
, filling in the name of the command
after an optional section number.
• The
apropos
command returns a list of manual pages whose summary mentions the re-
quested keywords, along with the one-line summary from the manual page.
• The GNU project has written manuals for most of its programs in the info format. This is
why many manual pages refer to corresponding info documentation.
• Each package includes its own documentation and even the least documented programs
generally have a
README
file containing some interesting and/or important information.
This documentation is installed in the
/usr/share/doc/
package
/
directory.
• In most cases, the FAQ or mailing list archives of a program’s official website may address
problems that you have encountered.
• The Kali project maintains a collection of useful documentation at
https://www.kali.org/
docs/
.
• The Kali Linux project uses the #kali-linux channel on the
Freenode
8
IRC network. You can
use chat.freenode.net as IRC server, on port 6667 for a TLS-encrypted connection or port
6666 for a clear-text connection. To join the discussions on IRC, you have to use an IRC
client such as
hexchat
(in graphical mode) or
irssi
(in console mode). There is also a web-
based client available on
webchat.freenode.net
9
.
• The official community forums for the Kali Linux project are located at
forums.kali.org
10
.
• If you uncover a bug in a program, you can search bug reports or file your own. Be sure
to follow the guidelines that we have outlined to ensure your report is clear, comprehen-
sive, and improves the chances that the bug will be addressed by the developers in a timely
fashion.
8
https://freenode.net/
9
https://webchat.freenode.net/
10
https://forums.kali.org/
151
Chapter 6 — Helping Yourself and Getting Help
• Some bug reports should be filed to Kali, while others may be filed on the Debian side. A
command like
|
