Hiểu tóm tắt trong manpage


27

Tôi chưa thể hiểu được phần SYNOPSIS trong trang chủ của một lệnh. Ví dụ: chúng ta hãy xem trang chủ của manchính nó. Bởi 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. Phần SYNOPSIS có mô tả cú pháp cho lệnh không?
  2. những gì [...][...]bên trong [...] có nghĩa là gì? Họ có nghĩa là một cái gì đó tùy chọn?
  3. |nghĩa là HAY?
  4. ,nghĩa là [-m system[,...]]gì?
  5. Phần SYNOPSIS có tuân theo các quy tắc được sử dụng cho Biểu thức chính quy không?

Liên quan: "Các quy ước về tiện ích" trong tiêu chuẩn POSIX: pubs.opengroup.org/onlinepub/9699919799/basingefs/ (
Kusalananda

Câu trả lời:


25
  1. Phần tóm tắt thường đưa ra một số trường hợp sử dụng ví dụ. Đôi khi các lệnh phụ có các tùy chọn khác nhau, vì vậy một số ví dụ có thể được hiển thị.
  2. Chân đế []luôn biểu thị các công tắc, đối số, tùy chọn, v.v.
  3. Có, đường ống |có nghĩa là, đặc biệt khi bên trong ngoặc hoặc dấu ngoặc đơn.
  4. Chân đế trong ngoặc chỉ có nghĩa là phần thứ hai phụ thuộc vào phần thứ nhất và bản thân nó cũng là tùy chọn. Một số công tắc bạn có thể tự sử dụng hoặc thêm giá trị cho chúng. Dấu phẩy khi bắt đầu dấu ngoặc sẽ cho biết có thể có nhiều giá trị được phân tách bằng dấu phẩy.
  5. Họ dựa vào các khái niệm Regex, nhưng có nghĩa là con người có thể đọc được vì vậy đừng tuân theo tất cả các quy tắc thoát, v.v.

Cảm ơn! Có một số tài liệu tham khảo giải thích cú pháp tóm tắt?
Tim

@Tim: Đó là một trong những thứ điên rồ nhất tôi từng thấy, tôi nghĩ rằng nếu bạn đọc thêm một vài lần nữa bạn sẽ hiểu được. Đó chỉ là quy ước, không phải phép thuật.
Caleb

9

Nếu bạn muốn có một tài liệu tham khảo, họ dựa trên EBNF một cách lỏng lẻo .


3

Từ mantrang nam:


Các quy ước sau áp dụng cho phần SYNOPSIS và có thể được sử dụng làm hướng dẫn trong các phần khác. tóm tắt mô tả người đàn ông

Kết xuất chính xác có thể thay đổi tùy thuộc vào thiết bị đầu ra. Chẳng hạn, con người thường sẽ không thể hiển thị chữ nghiêng khi chạy trong thiết bị đầu cuối và thường sẽ sử dụng văn bản được gạch chân hoặc tô màu thay thế.

Lệnh hoặc chức năng minh họa là một mẫu phù hợp với tất cả các yêu cầu có thể. Trong một số trường hợp, nên minh họa một số yêu cầu độc quyền như được hiển thị trong phần SYNOPSIS của trang hướng dẫn này.


3

Một nguồn khác để hiểu ý nghĩa của cú pháp đối số tiện ích dòng lệnh sẽ là các quy ước Cú pháp đối số tiện ích được ghi lại trong Chương 12 và Biểu thức chính quy được ghi trong Chương 9 của tiêu chuẩn POSIX.1-2008 (Phiên bản 2013).

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.