Mendapatkan Bantuan

Membaca manual dengan man, opsi --help, dan apropos ketika lupa cara pakai perintah.

Daftar isi

Topik ini membahas cara mendapatkan bantuan langsung dari sistem tanpa membuka browser. Opsi --help memberikan ringkasan cepat, man menampilkan halaman manual, help menjelaskan perintah bawaan shell, dan apropos mencari perintah berdasarkan kata kunci. Keempatnya dipakai ketika sintaks sebuah perintah terlupa, ketika nama perintah yang tepat terlupa, atau ketika perilaku satu opsi perlu dipastikan. Setelah membacanya, jawaban atas pertanyaan dasar cara memakai sebuah perintah dapat dicari di terminal itu sendiri.

Opsi –help yang cepat#

Banyak perintah GNU menyediakan ringkasan cara pakai lewat opsi --help. Opsi ini mencetak baris pemakaian dan daftar opsinya, lalu berhenti tanpa menjalankan pekerjaan apa pun. Bentuknya paling cocok untuk mengingatkan sintaks yang pernah dikenal, bukan untuk mempelajari perintah yang benar-benar baru.

bash

# ringkasan ls dipotong 12 baris pertama
ls --help | head -n 12

text Keluaran

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.

Mandatory arguments to long options are mandatory for short options too.
  -a, --all                  do not ignore entries starting with .
  -A, --almost-all           do not list implied . and ..
      --author               with -l, print the author of each file
  -b, --escape               print C-style escapes for nongraphic characters
      --block-size=SIZE      with -l, scale sizes by SIZE when printing them;
                             e.g., '--block-size=M'; see SIZE format below

Baris pertama, Usage: ls [OPTION]... [FILE]..., mengikuti konvensi yang berlaku luas. Tulisan dalam kurung siku menandakan bagian yang tidak wajib, dan tanda ... menandakan bagian yang boleh diulang. Kalimat pertama dan kedua merangkum fungsi perintah, sedangkan daftar di bawahnya memuat opsi beserta penjelasan singkatnya.

Keluaran --help sering lebih panjang dari satu layar. Cara memotongnya adalah menyalurkan keluaran ke head -n 20 atau perintah serupa, seperti pada blok di atas. Kebiasaan ini menjaga baris yang dicari tetap terlihat tanpa menggulir layar.

Halaman manual dengan man#

Perintah man menampilkan halaman manual (manual page, biasa disingkat man page), yaitu dokumentasi lengkap satu perintah yang menjadi standar pada sistem Unix dan Linux. Sebuah halaman manual memuat deskripsi, sintaks lengkap, daftar opsi beserta artinya, contoh, dan rujukan ke halaman lain. Bila --help adalah pengingat singkat, man adalah rujukan yang menyeluruh.

Struktur halaman manual baku berurutan dari atas ke bawah. Bagian NAME memuat nama dan ringkasan satu kalimat, SYNOPSIS menampilkan pola pemanggilan, DESCRIPTION menjelaskan perilaku, OPTIONS merinci setiap opsi, lalu EXAMPLES dan SEE ALSO melengkapi. Setelah struktur ini dikenal, halaman manual baru lebih mudah diikuti.

bash

# tidak-dijalankan
# man membuka penampil interaktif; keluar dengan tombol q
man ls

Halaman manual dikelompokkan ke dalam bagian bernomor. Nomor yang paling sering dibutuhkan adalah 1 untuk perintah pengguna, 5 untuk format berkas, dan 8 untuk perintah administrasi. Nama halaman sering ditulis bersama nomornya, misalnya ls(1). Nomor ini penting ketika satu nama dipakai untuk dua hal, seperti crontab(1) yang berupa alat penyunting jadwal dan crontab(5) yang berupa format berkasnya. Halaman tertentu dipilih dengan menyebut nomornya, misalnya man 5 crontab.

help untuk perintah bawaan shell#

Perintah seperti cd, history, dan alias adalah builtin, yaitu bagian dari program bash itu sendiri, sehingga penjelasannya tidak selalu tersedia sebagai halaman manual terpisah. Untuk perintah semacam ini bash menyediakan perintah help, yang menampilkan ringkasan cara pakai satu builtin atau daftar seluruh builtin bila dipanggil tanpa argumen.

bash

# ringkasan cd dari help bash
help cd | head -n 8

text Keluaran

cd: cd [-L|[-P [-e]] [-@]] [dir]
    Change the shell working directory.
    
    Change the current directory to DIR.  The default DIR is the value of the
    HOME shell variable. If DIR is "-", it is converted to $OLDPWD.
    
    The variable CDPATH defines the search path for the directory containing
    DIR.  Alternative directory names in CDPATH are separated by a colon (:).

Format keluaran help mengikuti konvensi yang sama dengan SYNOPSIS pada man page. Tanda -L dan -P pada baris pertama adalah opsi yang mengatur apakah jalur simbolik (symbolic link), yaitu berkas penunjuk menuju lokasi lain, diikuti atau tidak. Penjelasan lengkap keduanya tersedia pada bagian opsi di bawah baris pertama. Ketika man tidak menemukan halaman untuk sebuah perintah, periksa dahulu apakah perintah itu builtin dan gunakan help.

Mencari dengan apropos#

Perintah apropos dipakai ketika nama perintahnya justru yang terlupa, tetapi fungsinya masih diingat. Perintah ini mencari kata kunci pada bagian NAME seluruh halaman manual yang terpasang, lalu mencantumkan kecocokan beserta deskripsi singkatnya. Pencarian yang sama juga dapat dipanggil sebagai man -k.

bash

# tidak-dijalankan
# apropos membutuhkan database man yang tidak terpasang di sandbox
apropos compress

Keluaran apropos berupa daftar, satu halaman manual per baris, dengan pola nama halaman, nomor bagian dalam tanda kurung, dan deskripsi singkatnya. Pencarian kata compress, misalnya, menampilkan halaman untuk gzip dan zip beserta deskripsi keduanya. Halaman yang paling cocok kemudian dibuka dengan man nama, atau dengan man nomor nama apabila nama itu muncul di lebih dari satu bagian.

Apabila apropos tidak mengembalikan apa pun, periksa ejaan kata kunci, coba sinonim yang lebih umum, atau perbarui basis data manual dengan mandb. Pembaruan basis data biasanya berjalan otomatis pada sistem desktop, tetapi pada server yang baru dipasang, menjalankannya secara manual sesekali berguna.

Kesalahan umum#

Membaca --help tanpa memotong keluarannya. Keluaran yang panjang menggulir layar dengan cepat dan baris yang dicari ikut terlewat. Salurkan keluarannya ke head atau ke less agar pembacaan tenang, dan ingat bahwa --help memang ringkasan, bukan dokumentasi lengkap.

Lupa nomor bagian pada man. Mengetik man crontab menampilkan halaman pertama yang cocok, yaitu crontab(1), padahal yang dicari bisa jadi format berkasnya di bagian 5. Kejadian serupa terjadi pada passwd yang memiliki halaman perintah dan halaman format berkas. Kebiasaan menyebut nomor bagian, misalnya man 5 crontab, menghilangkan kebingungan ini.

apropos kosong atau keliru. Basis data manual belum terbentuk pada sistem yang baru dipasang, sehingga pencarian mengembalikan hasil kosong meskipun halamannya ada. Jalankan sudo mandb untuk membangun basis data, lalu ulangi pencariannya.

Ringkasan#

Opsi --help mencetak ringkasan cara pakai dan langsung berhenti, cocok untuk memastikan sintaks perintah yang sudah dikenal.
man menampilkan halaman manual lengkap dalam penampil interaktif yang dikeluarkan dengan q, dengan bagian bernomor seperti 1 untuk perintah pengguna dan 5 untuk format berkas.
Perintah bawaan shell dijelaskan oleh help, karena perintah semacam itu tidak selalu punya halaman manual sendiri.
apropos mencari perintah berdasarkan kata kunci pada bagian NAME seluruh halaman manual ketika nama perintahnya terlupa.

Referensi#

man(1) — Linux man pages — Manual perintah man, mencakup struktur halaman dan pemilihan bagian bernomor.
apropos(1) — Linux man pages — Manual apropos, mencakup opsi -s dan relasinya dengan man -k.