Có một tiêu chuẩn để viết tóm tắt lệnh?

Tôi nhận thấy rằng mọi người đều có ý tưởng riêng về cách viết tóm tắt mô tả việc sử dụng lệnh cho người dùng cuối.

Ví dụ: đây là định dạng từ man grep:

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

Bây giờ điều này có một số cú pháp xuất hiện trong các trang khác. []được công nhận là tùy chọn và ...có nghĩa là nhiều đầu vào giống nhau.

Nhưng mọi người sử dụng |hoặc /cho OR và có những người khác sẽ đảo ngược ý []nghĩa của nó. Hoặc họ không đưa ra bất kỳ dấu hiệu nào về nơi [OPTIONS]sẽ đi.

Tôi muốn tuân theo một tiêu chuẩn cho những gì tôi viết, nhưng mỗi trang web tôi nhìn vào đều cho tôi biết điều gì đó khác biệt.

Có một cách viết tiêu chuẩn thực sự của các bản tóm tắt, hay là quy ước chỉ là những gì mọi người đã và đang làm theo thời gian?

Tiêu chuẩn cổ điển cho điều này là từ POSIX, Cú pháp đối số tiện ích (nhờ @ illuminÉ cho liên kết được cập nhật). Nó mô tả cú pháp được sử dụng trong các trang man, ví dụ

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]

Là cổ điển, nó khuyến nghị sử dụng các tùy chọn một ký tự, -Wđược các nhà cung cấp khuyến nghị sử dụng và đó là cách các tùy chọn đa ký tự được cung cấp (xem, ví dụ, Tóm tắt Tùy chọn gcc ).

Phần mềm GNU giới thiệu các tùy chọn đa ký tự bắt đầu bằng --. Một số hướng dẫn từ GNU để định dạng trang man với các tùy chọn đó có thể được tìm thấy trong tài liệu tham khảo help2man .