Sebelum anda dapat memahami apa yang sebenarnya terjadi ketika menemui masalah, anda perlu mengerti tentang teori dan aturan yang berlaku pada setiap program yang berkaitan dengan masalah tersebut. Caranya yang terbaik adalah merujuk pada dokumentasi dari program-program tersebut, namun karena dokumentasi-dokuentasi itu sangatlah banyak dan tersebar luas, anda perlu mengetahui dimana bisa menemukan dokumentasi tersebut.
Halaman manual, yang biasanya tidak terlalu panjang, berisi informasi penting yang dibutuhkan. Kita akan mencoba langsung perintah untuk menampilkannya, yang disediakan oleh paket
man-db. Ketik saja
man halaman-manual -- ganti halaman-manual dengan nama perintah yang ingin dipelajari dokumentasinya. Misalnya, untuk lebih memahami opsi dari penggunaan perintah
cp, ketik
man cp pada shell (lihat di bilah sisi
KEMBALI KE DASAR Shell, penafsir baris perintah).
Halaman manual tidak hanya mendokumentasikan perintah dan program yang dapat diakses dari baris perintah, namun juga berkas konfigurasi, system call, fungsi pustaka, dan banyak lagi. Kadang terdapat nama yang mirip. Misal, perintah shell read mempunyai nama yang sama dengan fungsi system call yaitu read. Itu sebabnya halaman manual disusun dan diurutkan dalam bagian yang diberi nomor:
- 1
Perintah-perintah yang dapat dieksekusi dari shell;
- 2
system call (fungsi yang disediakan oleh kernel);
- 3
fungsi pustaka (yang disediakan oleh pustaka-pustaka sistem);
- 4
perangkat (di sistem Unix, ini adalah berkas-berkas khusus, yang biasanya terletak pada direktori /dev/;
- 5
berkas konfigurasi (bentuk dan kaidah);
- 6
permainan;
- 7
kumpulan makro dan standar;
- 8
perintah administrasi sistem;
- 9
rutin kernel.
Anda bisa memilih bagian tertentu yang anda cari dari halaman manual : menampilkan dokumentasi untuk fungsi system call read, dengan mengetik perintah man 2 read. Jika tidak ada bagian yang dipilih, bagian pertama dari halaman manual yang diminta akan ditampilkan. Perintah man shadow menghasilkan shadow(5) karena tidak ada laman manual untuk shadow pada bab 1 ke 4.
Tentu saja, jika anda tidak mengetahui nama dari sebuah perintah, halaman manual tidak terlalu berguna untuk anda. Untuk kebutuhan ini, perintah apropos membantu anda mencari nama-nama perintah pada semua halaman manual atau lebih khususnya, deskripsi singkat dari perintah tersebut. Setiap halaman manual selalu diawali oleh deskripsi singkat. Perintah apropos menampilkan daftar halaman namual yang berisi kata kunci yang diminta. Jika anda memilih kata kunci dengan tepat, mungkin anda akan menemukan apa yang anda cari.
Contoh 7.1. Menemukan cp dengan apropos
$ apropos "copy file"
cp (1) - copy files and directories
cp (1posix) - copy files
cpio (1) - copy files to and from archives
exec (1posix) - execute commands and open, close, or copy file descriptors
install (1) - copy files and set attributes
ntfscp (8) - copy file to an NTFS volume.
Perintah
man bukan satu-satunya yang bisa menyediakan halaman manual, karena program
khelpcenter dan
konqueror> (dari KDE) dan
yelp (di bawah GNOME) juga menyediakan kemungkinan ini. Juga ada antar muka web, yang disediakan oleh paket
man2html, yang mengizinkan Anda menampilkan halaman manual di peramban web. Pada komputer yang telah terpasang paket man2html, gunakan URL berikut setelah mengikuti instruksi dalam
/usr/share/doc/man2html/README.Debian:
Utilitas ini membutuhkan sebuah web server. Tidak ada ruginya anda memasang paket ini pada salah satu server anda: semua pengguna dari jaringan lokal dapat mengambil keuntungan dari layanan ini (termasuk dari perangkat-perangkat non-Linux), dan anda tidak perlu membuat server HTTP di setiap workstation. Jika server anda bisa diakses dari jaringan lain, mungkin anda ingin membatasi akses layanan ini hanya untuk pengguna lokal.
Terakhir, namun bukan tidak penting, Anda dapat melihat semua halaman manual yang tersedia dalam Debian (bahkan yang tidak terpasang pada mesin Anda) pada layanan
manpages.debian.org. Itu menawarkan setiap halaman manual dalam berbagai versi, satu untuk setiap rilis Debian.
Proyek GNU telah membuat halaman manual untuk sebagian besar programnya dalam format info; itu sebabnya beberapa halaman manual merujuk ke dokumentasi berformat info. Format ini mempunyai beberapa kelebihan, namun program bawaan untuk menampilkan dokumen ini (bernama info) juga sedikit lebih kompleks. Anda disarankan untuk memakai pinfo sebagai pengganti (dari paket pinfo).
Dokumentasi info mempunyai struktur hirarkis, dan jika Anda menjalankan pinfo tanpa parameter, itu akan menampilkan daftar simpul yang tersedia di tingkat pertama. Biasanya, simpul mengambil nama perintah-perintah yang sesuai.
Dengan
pinfo navigasi antar simpul mudah dilakukan dengan tombol-tombol panah. Alternatif lain, Anda bisa juga menggunakan peramban web, yang jauh lebih ramah pengguna. Sekali lagi,
konqueror dan
yelp bisa dipakai; paket
info2www juga menyediakan antar muka web.
Sebagai catatan, dokumentasi info tidak cocok untuk penerjemahan, tidak seperti halaman man. Maka dokumen-dokumen info hampir selalu dalam bahasa Inggris. Namun, jika Anda meminta program pinfo untuk menampilkan halaman info yang tidak ada, itu akan mengalihkan ke halaman man dengan nama yang sama (jika ada), yang mungkin sudah diterjemahkan.
7.1.3. Dokumentasi Spesifik
Setiap paket mempunyai dokumentasi masing-masing. Bahkan dokumentasi program yang paling sedikit pun mempunyai berkas README yang berisi informasi penting/menarik. Dokumentasi ini terpasang di direktori /usr/share/doc/nama-paket/ (nama-paket merujuk ke nama paket). Jika dokumentasi terlalu besar, mungkin saja dokumentasi tidak dimasukkan ke dalam paket utama program, tapi mungkin tersedia dalam paket khusus yang biasanya memiliki nama package-doc. Paket utama biasanya merekomendasikan paket dokumentasi sehingga anda mudah menemukannya.
Direktori
/usr/share/doc/paket/ juga berisi beberapa berkas yang disediakan oleh Debian yang melengkapi dokumentasi dengan menunjukkan kehasan paket atau perbaikan dibandingkan instalasi tradisional sebuah perangkat lunak. Berkas
README.Debian juga menunjukkan seluruh adaptasi yang dibuat agar patuh terhadap Debian Policy. Berkas
changelog.Debian.gz memungkinkan pengguna untuk mengikuti modifikasi yang dibuat untuk paket sepanjang waktu: sangat berguna untuk mencoba memahami apa yang berubah antara dua versi terinstall yang tidak memiliki perilaku yang sama. Akhirnya, terkadang ada pula sebuah berkas
NEWS.Debian.gz yang mendokumentasikan perubahan besar pada program yang mungkin secara langsung diperhatikan administrator (lihat
Bagian 6.7.2, “Menangani Masalah setelah Pembaharuan”).
In most cases, free software programs have websites that are used to distribute it and to bring together the community of its developers and users. These sites are frequently loaded with relevant information in various forms: official documentation,
FAQ (Frequently Asked Questions), mailing list archives, etc. Problems that you may encounter have often already been the subject of many questions; the FAQ or mailing list archives may have a solution for it. A good mastery of search engines will prove immensely valuable to find relevant pages quickly (by restricting the search to the Internet domain or sub-domain dedicated to the program). If the search returns too many pages or if the results do not match what you seek, you can add the keyword
debian to limit results and target relevant information.
Jika Anda tidak tahu alamat website dari sebuah perangkat lunak, ada beberapa cara untuk mengetahuinya. Pertama, periksa apakah ada baris
Homepage di dalam informasi-meta paket (
apt show paket). Cara lain, deskripsi paket mungkin menyediakan tautan ke website resmi program itu. Jika tidak ada tautan URL terlihat, cari di
/usr/share/doc/paket/copyright. Maintainer Debian biasanya mencantumkan di berkas tersebut, di mana mereka mendapatkan sumber programnya, dan itu seharusnya adalah website yang Anda cari. Jika sampai tingkat ini, usaha pencarian Anda masih belum berbuah, cari di direktori perangkat lunak bebas, seperti Free Software Directory milik FSF, atau cari langsung dengan mesin pencari, seperti Google, DuckDuckGo, Yahoo, dsb.
You might also want to check the Debian wiki, a collaborative website where anybody, even new visitors, can make suggestions directly from their browsers. It is used equally by developers who design and specify their projects, and by users who share their knowledge by writing documents collaboratively.
HOWTO adalah dokumen yang mendiskripsikan, secara konkret dan langkah demi langkah, bagaimana mencapai tujuan yang sudah ditetapkan. Capaian relatif bervariasi, namun lebih sering bersifat teknis: contohnya, mengatur IP Marquerading, mengkonfigurasi perangkat lunak RAID, memasang server Samba, dan lainnya. Dokumentasi seperti ini biasanya menyediakan penyelesaian atas masalah yang mungkin muncul saat implementasi teknologi terkait.
Many such tutorials are managed by the Linux Documentation Project (
LDP), whose website hosts all of these documents:
Debian juga menyediakan tutorial untuk para penggunanya:
All these documents should be taken with a grain of salt. They are often several years old; the information they contain is sometimes obsolete. This phenomenon is even more frequent for their translations, since updates are neither systematic nor instant after the publication of a new version of the original documents. Further many tutorials nowadays are provided by bloggers, sharing their individual solution with the interested reader. They often lack important information, i.e. the reason why some configuration has been chosen over another, or why some option has been enabled or disabled. Because blogging and creating personal websites made it so easy to share, many of these often short tutorials exist, but only a few are actively maintained and well-kept. This can make it hard to find the "right" one for you. This is all part of the joys of working in a volunteer environment and without constraints…
