Memahami sinopsis di halaman manual

27

Saya belum dapat memahami bagian SYNOPSIS di halaman perintah. Sebagai contoh, mari kita lihat halaman manual manitu sendiri. Oleh man man:

SYNOPSIS
       man  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R encoding] [-L
       locale] [-m system[,...]] [-M path] [-S list]  [-e  extension]  [-i|-I]
       [--regex|--wildcard]   [--names-only]  [-a]  [-u]  [--no-subpages]  [-P
       pager] [-r prompt] [-7] [-E encoding] [--no-hyphenation] [--no-justifi‐
       cation]  [-p  string]  [-t]  [-T[device]]  [-H[browser]] [-X[dpi]] [-Z]
       [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man -l [-C file] [-d] [-D] [--warnings[=warnings]]  [-R  encoding]  [-L
       locale]  [-P  pager]  [-r  prompt]  [-7] [-E encoding] [-p string] [-t]
       [-T[device]] [-H[browser]] [-X[dpi]] [-Z] file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-hV]
  1. Apakah bagian SYNOPSIS menggambarkan sintaks untuk perintah?
  2. apa artinya itu [...]dan [...]di dalam [...] ? Apakah itu berarti sesuatu yang opsional?
  3. Apakah |artinya ATAU?
  4. Apa ,artinya ini [-m system[,...]]?
  5. Apakah bagian SYNOPSIS mengikuti aturan yang digunakan untuk Ekspresi Reguler?
Tim
sumber
Terkait: "Konvensi Utilitas" dalam standar POSIX: pubs.opengroup.org/onlinepubs/9699919799/basedefs/…
Kusalananda

Jawaban:

25
  1. Bagian sinopsis biasanya memberikan beberapa contoh kasus penggunaan. Kadang-kadang sub-perintah memiliki opsi yang berbeda, sehingga beberapa contoh mungkin ditampilkan.
  2. Tanda kurung []selalu menunjukkan sakelar opsional, argumen, opsi, dll.
  3. Ya, pipa |berarti atau, khususnya ketika di dalam kurung atau kurung.
  4. Tanda kurung dalam tanda kurung hanya berarti bahwa bagian kedua tergantung pada yang pertama, dan juga itu sendiri opsional. Beberapa sakelar yang bisa Anda gunakan sendiri atau tambahkan nilainya. Koma di awal braket akan menunjukkan ada beberapa nilai yang dipisahkan koma.
  5. Mereka bersandar pada konsep Regex, tetapi dimaksudkan agar dapat dibaca oleh manusia jadi jangan ikuti semua aturan pelarian dll
Caleb
sumber
Terima kasih! Apakah ada beberapa referensi yang menjelaskan sintaksis sinopsis?
Tim
@ Tim: Itu salah satu yang paling gila yang pernah saya lihat, saya pikir jika Anda membaca beberapa lagi Anda akan terbiasa. Itu hanya konvensi, bukan sihir.
Caleb
9

Jika Anda ingin referensi, mereka secara longgar didasarkan pada EBNF .

Kim
sumber
3

Dari manhalaman manual:


Konvensi berikut berlaku untuk bagian SYNOPSIS dan dapat digunakan sebagai panduan di bagian lain. deskripsi sinopsis pria

Render yang tepat dapat bervariasi tergantung pada perangkat output. Sebagai contoh, manusia biasanya tidak dapat membuat huruf miring ketika berjalan di terminal, dan biasanya akan menggunakan teks yang digarisbawahi atau berwarna.

Ilustrasi perintah atau fungsi adalah pola yang harus cocok dengan semua doa yang mungkin. Dalam beberapa kasus, disarankan untuk mengilustrasikan beberapa pemanggilan eksklusif seperti yang diperlihatkan di bagian SYNOPSIS pada halaman buku panduan ini.

Jules Randolph
sumber
3

Sumber lain untuk memahami arti sintaks argumen utilitas baris perintah adalah konvensi Sintaks Argumen Utilitas yang didokumentasikan dalam Bab 12 dan Ekspresi Reguler yang didokumentasikan dalam Bab 9 standar POSIX.1-2008 (Edisi 2013).

Slothworks
sumber