Linux Lexicon — Anatomi Halaman Manusia
Diterbitkan: 2016-11-01
Byte Pendek: Halaman manual dan dokumentasi perangkat lunak bisa menjadi tebal dan cukup sulit untuk pemula mana pun tanpa konvensi samar yang dicampur dengan setiap jenis braket dan tanda kurung. Di sini, kami akan mencoba mengurangi kerumitan halaman manual Linux dan membuatnya lebih mudah untuk dipahami.
NAMA
Pertama adalah judul nama, dan itu tentang meringkasnya. Bagian ini mencakup nama utilitas, serta deskripsi singkat.
RINGKASAN
Ada berbagai tingkat keterbacaan dari halaman manual ke halaman manual, tetapi satu hal yang pasti, bagian tersulit biasanya menguraikan sinopsis berbulu. Ada beberapa konvensi untuk menunjukkan potongan informasi yang diperlukan untuk setiap perintah yang diberikan. Konvensi ini terdiri dari tanda kurung dan kurung yang berbeda, serta bentuk notasi lainnya. Semua konvensi yang berbeda ini bisa sangat membingungkan bagi seorang pemula, dan masih menakutkan bagi seseorang yang berpengalaman tetapi tidak berpengalaman dalam seni manual. Di bawah ini kami akan memecah omong kosong menjadi aturan yang mudah dicerna.
| berani | Ketik persis seperti yang ditunjukkan. |
| miring atau digarisbawahi | Ganti dengan argumen yang sesuai. |
| [-abcxyz] | Semua bendera dalam tanda kurung siku adalah opsional. |
| -a | -B | Opsi yang dipisahkan oleh pipa tidak dapat digunakan bersama-sama. |
| <wajib> | Argumen wajib, biasanya ditemukan dalam deskripsi opsi. |
| {ya Tidak} | Opsi terbatas, hanya yang ditentukan yang akan berfungsi. |
| … | Argumen yang diikuti oleh elips dapat diulang. |
Aturan-aturan ini cukup sederhana, tetapi menjadi lebih sulit, dan bahkan menakutkan, ketika digunakan dalam definisi fungsi yang panjang, terutama ketika bersarang. Jadi, kita akan melihat beberapa sarang di bawah ini untuk membangun apa yang telah kita pecahkan.
tar {A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ ARG …]
Perintah tar memiliki banyak opsi. Kami melihat nama perintah tar dicetak tebal karena harus diketik seperti yang ditunjukkan. Kemudian kita melihat kawat gigi terbuka dengan opsi yang dipisahkan pipa yang menunjukkan bahwa kita terbatas pada itu dan harus memilih hanya satu. Berikutnya adalah flag opsional, kita dapat menggunakan nomor apa pun, meskipun, mereka mungkin tidak semuanya bekerja sama, membaca lebih lanjut ke halaman manual akan menjelaskan potensi konflik opsi. Dan, terakhir, kami memiliki argumen yang dapat diulang, dalam kasus tar this untuk file yang Anda operasikan.
su [opsi] [-] [ pengguna [ argumen ...]]
Sekali lagi, kita melihat su tebal karena itu adalah nama dari perintah. Kedua, kita melihat bahwa tidak ada flag yang benar-benar ditentukan, hanya bahwa mereka opsional. Ketiga, ada satu bendera yang ditentukan, tetapi itu juga opsional. Terakhir, kita melihat argumen opsional yang dapat diulang di dalam argumen opsional. Sekarang, apa yang dulu terlihat sangat misterius menjadi lebih masuk akal.
whois [{-h|–host } HOST ] [{-p|–port} PORT ] [-abBcdGHKlLmMrRx] [-g SOURCE:FIRST-LAST ] [-i ATTR [, ATTR ]…] [-s SUMBER [, SUMBER ]…] [-T TYPE [, TYPE ]…] [–verbose] OBJEK
Ini adalah salah satu yang sangat padat. Salin ke editor teks favorit Anda dan tambahkan beberapa spasi tambahan di sana jika itu membantu Anda membacanya. Setelah memindai ini, Anda akan mulai melihat beberapa pola. Bagian host dan port menggunakan pemformatan yang sama untuk opsi bentuk pendek dan panjang diikuti dengan argumen untuk opsi itu, sementara keduanya opsional. Kemudian kita melihat string flag opsional. Bagian selanjutnya tentang sumber dari pertama hingga terakhir adalah sintaks yang diharapkan oleh whois yang dijelaskan nanti di halaman manual. Sekarang kita melihat triplet flag opsional ini yang mengambil argumen tunggal atau argumen berulang opsional, ini adalah jenis penggabungan konvensi yang bisa sangat sulit untuk dipahami sepenuhnya pada awalnya. Terakhir ada opsi verbose dan objek (host/domain).
Dan itulah cara membaca sinopsis halaman manual. Ada beberapa konvensi lain, tetapi terlalu tidak jelas untuk dibahas dalam artikel ini.
KETERANGAN
Ini umumnya di mana tujuan penggunaan program atau utilitas diuraikan. Beberapa manual akan jauh lebih bertele-tele di bawah judul ini daripada yang lain.
PILIHAN
Ingat semua tanda dan argumen berbeda yang bisa opsional atau wajib? Di sinilah mereka semua dijelaskan. Biasanya ada informasi bagus di sini dan sering kali Anda akan menemukan konvensi <argument>, yang menunjukkan bahwa flag yang diberikan memerlukan argumen yang sesuai. Kadang-kadang Anda akan menemukan bahwa pilihan akan berada di bagian deskripsi karena tidak ada aturan keras yang mendefinisikan halaman manual, hanya konvensi, dan keinginan untuk mematuhi standar.
CONTOH
Ini adalah salah satu bagian paling mudah yang sayangnya tidak disertakan dalam semua manual. Anda juga akan menemukan bahwa jumlah informasi dan jumlah contoh sangat bervariasi, dan tidak semua contoh benar-benar membantu penggunaan perintah.
Selain itu, Anda akan secara teratur menemukan bagian untuk penulis, informasi hak cipta, pelaporan bug, dan lihat juga (sesuai).
Di luar ini, ada bagian halaman manual yang didefinisikan secara formal seperti yang didefinisikan di bawah ini.
| 1 | Program yang dapat dieksekusi atau perintah shell |
| 2 | Panggilan sistem (fungsi yang disediakan oleh kernel) |
| 3 | Panggilan perpustakaan (fungsi dalam perpustakaan program) |
| 4 | File khusus (biasanya ditemukan di /dev) |
| 5 | Format file dan konvensi misalnya /etc/passwd |
| 6 | permainan |
| 7 | Lain-lain (termasuk paket makro dan konvensi), misalnya man(7), groff(7) |
| 8 | Perintah administrasi sistem (biasanya hanya untuk root) |
| 9 | Rutinitas kernel (biasanya tidak ditemukan di Linux) |
Banyak perintah tidak memiliki manual di lebih dari satu bagian, tetapi untuk perintah yang memiliki, atau untuk beberapa yang mungkin diberi nama yang ambigu, Anda dapat menentukan bagian seperti contoh di bawah ini.
Perintah bukan satu-satunya hal yang memiliki manual seperti yang Anda lihat dari bagian yang tersedia. Panggilan sistem, file konfigurasi, dan perangkat khusus mungkin juga memiliki halaman manual yang sesuai. Jumlah informasi tentang penginstalan Linux biasa hanya di halaman manual luar biasa, dan hal yang sama berlaku untuk sistem operasi mirip UNIX open source lainnya.
Jika Anda menemukan bahwa halaman manual tidak mencukupi dan Anda masih tidak memahami perintah, selalu periksa online karena banyak orang menawarkan penjelasan yang lebih menyeluruh tentang alat-alat tertentu, tetapi juga, banyak distribusi memiliki halaman manual sendiri untuk paket perangkat lunak yang berbeda. Setelah Anda merasa nyaman dengan perangkat lunak, tetapi masih merasa manualnya kurang, Anda selalu dapat berkontribusi dengan menulis sendiri dan mengirimkannya ke proyek terkait. Dokumentasi sering kali merupakan bagian proyek perangkat lunak yang paling diabaikan, jadi meskipun Anda tidak dapat menulis kode, Anda dapat menulis manual, artikel Wiki, dan tutorial untuk membantu orang lain.
Sekarang setelah Anda mengetahui anatomi halaman manual, Anda tidak punya alasan selain RTFM (dan itu membaca manual gratis untuk Anda yang berusia di bawah 18 tahun) ;)
Baca Juga: Linux Lexicon: Gunakan Perintah Tonton Untuk Menjalankan Perintah Setiap X Detik