2013-03-17 29 views
6

Khi đọc trang của người đàn ông, theo kinh nghiệm của tôi, luôn có phần synopsis. ví dụ.ký hiệu tóm tắt trang người đàn ông

MV(1)      BSD General Commands Manual     MV(1) 

NAME 
mv -- move files 

SYNOPSIS 
mv [-f | -i | -n] [-v] source target 
mv [-f | -i | -n] [-v] source ... directory 

Tôi quan tâm đến ký hiệu được sử dụng trong phần synopsis. Nó được gọi là gì và tôi có thể tìm thêm thông tin về nó ở đâu? Nói chung nó có vẻ khá thẳng về phía trước, và tôi thường có thể hiểu ý nghĩa của nó, nhưng tôi muốn bắt đầu sử dụng nó cho tài liệu của riêng tôi, vì vậy tôi nghĩ tôi nên tìm hiểu những gì tôi có thể về cú pháp trước đây Tôi bắt đầu viết những trang người đàn ông của riêng tôi.

+0

'man man' sẽ giúp bạn bắt đầu. cũng tìm kiếm 'groff'. –

+2

@MarcB Ở đâu trong trang 'man' hoặc' groff', nó giải thích những thứ như '[...]' chỉ ra các đối số tùy chọn, và '|' chỉ ra các lựa chọn thay thế? Tôi nghĩ rằng đây là một biến thể về cú pháp cú pháp Backus-Naur. – Barmar

Trả lời

4

Đây là qoute từ man man:

The following conventions apply to the SYNOPSIS section and 
    can be used as a guide in other sections. 

    bold text   type exactly as shown. 
    italic text  replace with appropriate argument. 
    [-abc]    any or all arguments within [ ] are optional. 
    -a|-b    options delimited by | cannot be used together. 
    argument ...  argument is repeatable. 
    [expression] ... entire expression within [ ] is repeatable. 

    Exact rendering may vary depending on the output device. For instance, man will 
    usually not be able to render italics when running in a terminal, and will 
    typically use underlined or coloured text instead. 

Vì vậy, tôi nghĩ rằng ký hiệu tóm tắt này đã được hình thành trong lịch sử.

Các vấn đề liên quan