Help, Man Pages, dan Documentation

Tidak ada pengguna Linux yang menghafal seluruh opsi seluruh perintah, dan tidak perlu: dokumentasi tersedia tepat di tempat perintah itu dijalankan. Lapisan pertamanya adalah opsi --help yang hampir selalu tersedia, lapisan kedua adalah man page yang menjadi manual resmi sistem, dan lapisan ketiga adalah alat pencari seperti apropos. Pada Chapter ini kita akan memakai ketiganya secara berurutan, mulai dari bantuan tercepat hingga cara membaca manual yang lengkap.

Referensi Cepat dengan –help #

Hampir semua perintah eksternal menerima opsi --help dan membalasnya dengan ringkasan cara pakai beserta daftar opsi. Output-nya bisa panjang, jadi kita batasi barisnya dengan head:

ls --help | head -3

Output yang Dihasilkan:

Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.

Baris pertama disebut usage line: format pemanggilan ls dengan bagian opsional dalam kurung siku, sementara ... berarti argumen bisa diulang. Dua baris berikutnya merangkum apa yang dilakukan perintah tersebut tanpa harus membuka manual lengkap. Karena --help mencetak daftar opsi yang panjang, pola yang lebih praktis adalah menyaringnya dengan grep — misalnya saat kita lupa opsi untuk mengurutkan terbalik:

ls --help | grep -- '--reverse'

Output yang Dihasilkan:

  -r, --reverse              reverse order while sorting

Tanda -- sebelum pola memberi tahu grep bahwa --reverse adalah argumen pencarian, bukan opsi grep sendiri. Teknik menyaring --help dengan grep ini akan sering kita pakai sepanjang Course.

Bantuan untuk Builtin dengan type dan help #

Sebagian perintah bukan program terpisah, melainkan builtin yang hidup di dalam bash itu sendiri. Perintah type mengungkapkan di mana sebuah nama sebenarnya tinggal:

type -a echo

Output yang Dihasilkan:

echo is a shell builtin
echo is /usr/bin/echo
echo is /bin/echo

Baris pertama menunjukkan echo ditemukan sebagai shell builtin, dan dua baris berikutnya menunjukkan program /usr/bin/echo yang juga ada di sistem — saat kita mengetik echo, bash memakai yang pertama ditemukan, yaitu builtin. Builtin seperti cd tidak punya program terpisah, sehingga opsi --help tidak tersedia untuknya; gantinya, bash menyediakan perintah help khusus untuk builtin:

help cd | head -2

Output yang Dihasilkan:

cd: cd [-L|[-P [-e]] [-@]] [dir]
    Change the shell working directory.

Sama seperti --help, help mencetak usage line diikuti ringkasan singkat — tetapi isinya khusus untuk perilaku cd versi bash. Jadi rumus praktisnya: perintah eksternal memakai --help, builtin memakai help.

Man Pages dan Nomor Sectionnya #

Lapisan dokumentasi yang paling lengkap adalah man page — manual yang dibaca lewat perintah man, misalnya man ls. Karena program man tidak selalu terpasang di lingkungan minimal seperti container, kita bedah strukturnya lewat contoh tampilan bagian awal man ls berikut:

LS(1)                        User Commands                       LS(1)

NAME
       ls - list directory contents

SYNOPSIS
       ls [OPTION]... [FILE]...

DESCRIPTION
       List information about the FILEs (the current directory by
       default). Sort entries alphabetically if none of -cftuvSUX
       nor --sort is specified.

Bagian NAME merangkum tujuan perintah dalam satu baris, SYNOPSIS menunjukkan bentuk pemanggilannya, dan DESCRIPTION menjelaskan setiap opsi satu per satu. Angka (1) di pojok kiri atas adalah nomor section: 1 untuk perintah pengguna biasa, 5 untuk format file konfigurasi, dan 8 untuk perintah administrasi sistem. Nomor ini penting karena satu nama bisa memiliki beberapa halaman — passwd(1) membahas perintah mengganti kata sandi, sedangkan passwd(5) membahas format file /etc/passwd. Perintah man 5 passwd memaksa pembacaan section 5 secara eksplisit.

Di dalam man, navigasi dilakukan dengan tombol panah dan Spasi untuk menggulir, /pola untuk mencari, dan q untuk keluar. Kumpulan man page terlengkap daring dapat dibaca di man7.org , termasuk halaman ls(1) .

Mencari Dokumentasi dengan apropos dan whatis #

Dua masalah tersisa: kita lupa nama perintahnya, atau kita hanya ingin satu baris ringkasan. Perintah apropos (sama dengan man -k) mencari kata kunci di seluruh baris NAME man page — misalnya apropos password menampilkan semua halaman yang menyebut kata tersebut — sedangkan whatis menampilkan baris NAME dari satu halaman yang disebutkan. Ringkasan lapisan dokumentasi yang telah kita bahas:

Selain man page, ada pula halaman info dari proyek GNU yang kadang lebih rinci untuk perintah coreutils, serta koleksi tldr dari komunitas yang menyajikan contoh pemakaian paling umum dalam bentuk ringkas.

Dokumentasi memberi kita semua detail sebuah perintah; lalu bagaimana bila perintah favorit itu terlalu panjang untuk diketik berulang kali? Kita bisa memberinya nama panggilan — materi Chapter Command Aliases.