7.1. Sumber-Sumber Dokumentasi
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. Ketik saja man manual-page
-- ganti manual-page dengan nama perintah yang ingin dipelajari dokumentasinya. Misalnya, untuk lebih memahami opsi dari penggunaan perintah cp
, ketik man cp
pada shell (lihat di samping).
Halaman manual tidak hanya mendokumentasikan program yang dapat diakses dari baris perintah, namun juga berkas konfigurasi, system call, fungsi pustaka C, 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 :
Perintah-perintah yang dapat dieksekusi dari shell;
system calls (fungsi yang disediakan oleh kernel)
fungsi pustaka (yang disediakan oleh pustaka-pustaka sistem)
perangkat (di sistem Unix, ini adalah berkas-berkas khusus, yang biasanya terletak pada direktori /dev/
;
berkas konfigurasi (bentuk dan kaidah);
permainan;
kumpulan makro dan standar
perintah administrasi sistem;
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
cpio (1) - copy files to and from archives
hcopy (1) - copy files from or to an HFS volume
install (1) - copy files and set attributes
Perintah
man
bukan satu-satunya yang bisa menyediakan halaman manual, Program
konqueror
> (pada destop KDE) dan
yelp
(pada destop GNOME) juga menyediakan kebutuhan yang sama. 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 :
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.
Proyek GNU 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 untuk menampilkan dokumen ini juga sedikit lebih kompleks.
Tentu saja, program itu sendiri disebut info
, dan menggunakan "node" sebagai argumen. Dokumen info mempunyai struktur hirarki. Jika anda menjalankan info
tanpa parameter, hasilnya akan menampilkan daftar node yang tersedia di tingkat pertama. Biasanya nama node mengambil nama-nama perintah dari proyek GNU.
Kendali navigasi dalam dokumentasi ini tidak terlalu intuitif. Cara terbaik untuk membiasakan diri anda dengan program ini barangkali dengan menjalankan programnya diikuti
h
(untuk "help", bantuan), dan ikuti petunjuk yang ada untuk dipraktekkan. Alternatif lain, anda bisa juga menggunakan peramban web, yang lebih ramah pengguna. Sekali lagi,
konqueror
dan
yelp
bisa digunakan untuk ini; paket
info2www
juga menyediakan antar muka web.
Sebagai catatan, dokumentasi info tidak menyediakan translasi bahasa, tidak seperti halaman man. Dokumentasi info hanya tersedia dalam bahasa Inggris. Bagaimana pun juga, jika anda meminta info
untuk menampilkan dokumentasi info yang tidak ada, info
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 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.
Biasanya, perangkat lunak bebas mempunyai website yang digunakan untuk mendistribusikan perangkat lunak itu sendiri dan untuk menyatukan komunitas pengembang dan penggunanya. Situs-situs ini secara berkala menyediakan informasi yang relevan dalam berbagai bentuk : dokumentasi resmi, FAQ (Frequently Asked Question / Tanya Jawab), arsip milis, dan lainnya. Seringkali, masalah yang anda miliki sudah pernah menjadi subjek banyak pertanyaan, Mungkin anda akan menemukannya di FAQ dan arsip milis. Penguasaan dan penggunaan efektif dari mesin pencari akan terbukti sangat berharga untuk menemukan halaman yang relevan dengan cepat (dengan membatasi pencarian ke domain atau sub-domain yang berkaitan dengan program). Jika hasil pencarian menampilkan terlalu banyak halaman atau hasilnya tidak sesuai dengan yang anda cari, anda bisa menambahkan kata kunci debian
untuk membatasi hasil pencarian dan menyasar informasi yang relevan.
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-cache show package
). Cara lain, deskripsi paket mungkin menyediakan tautan ke website resmi program itu. Jika tidak ada tautan URL terlihat, cari di
/usr/share/doc/package/copyright
. Pemaket Debian biasanya mencantumkan di berkas tersebut, dimana mereka mendapatkan sumber programnya, dan itu seharusnya adalah website yang anda cari. Jika sampai tingkat ini, usaha pencarian anda masih belum berbuah hasil, cari di direktori perangkat bebas, seperti Freecode.com (dulunya bernama freshmeat.net) atau Framasoft, atau cari langsung dengan menggunakan mesin pencari, seperti Google atau Yahoo.
Anda mungkin ingin melihat wiki Debian, sebuah website hasil kolaborasi dimana setiap orang, bahkan hanya seorang pengunjung, bisa memberikan masukan-masukan, langsung dari peramban web mereka, juga digunakan oleh para pengembang untuk merancang desain dan menetapkan proyek mereka, oleh para pengguna yang berbagi pengetahuan dan pengalaman mereka dengan menulis dokumentasi secara kolaborasi.
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.
Banyak tutorial-tutorial seperti ini dibuat oleh Linux Documentation Project (LDP), yang websitenya menyimpan semua dokumen tersebut:
Dokumen ini perlu diambil dengan sebutir garam. Mereka seringkali berusia beberapa tahun; konten informasi mereka terkadang usang. Fenomena ini bahkan sering terjadi pada terjemahan mereka, pembaharuannya pun tidak sistematis tidak pula instant setelah publikasi versi baru dokumen aslinya. Ini merupakan bagian dari lingkungan kerja pada sukarelawan dan tanpa kendala…