Komut özetini yazmak için bir standart var mı?

Bana öyle geliyor ki herkesin son kullanıcı için komut kullanımını açıklayan bir özet yazma konusunda kendi fikri var .

Örneğin, bu şu biçimdedir man grep:

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

Şimdi bu, diğer sayfalarda görünen bazı sözdizimine sahip. []isteğe bağlı olarak tanınır ...ve aynı girdinin katları olarak anlamlıdır.

Ama insanlar OR için |veya kullanırlar /ve ne []anlama geldiğini tersine çevirecek başkaları da vardır . Ya da nereye [OPTIONS]gittiğine dair herhangi bir gösterge vermiyorlar .

Yazdıklarım için bir standart izlemek istiyorum, ancak baktığım her web sitesi bana farklı bir şey söylüyor.

Sinopsis yazmak için gerçek bir standart yol var mı , yoksa konvansiyon sadece insanların zaman içinde yaptıklarını mı?

command-line man

— Tormyst
kaynak

Birini seçip ona sadık kalın.

— Kevin

Nedense bunun yardımcı olacağını düşünmüyorum. Her insanın kendi standardı olurdu ve sonra bu konuda hiçbir şey yapılmazdı.

— Tormyst

Bu demek istediğin bir standart mı? pubs.opengroup.org/onlinepubs/009695399/basedefs/…

— Mark Plotnick

Evet, tam da aradığım şey buydu. Teşekkür ederim.

— Tormyst

@ MarkPlotnick - OP'nin kabul edebilmesi için bunu A yapardım. Eğer varsa, bu standarttır. İlluminÉ'nin başvurduğu bağlantıya bakın.

— slm

Bunun için klasik standart POSIX, Utility Argument Syntax'tan (güncellenmiş bağlantı için @ illuminÉ sayesinde). Örneğin, man sayfalarında kullanılacak sözdizimini açıklar, örneğin

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

Klasik olmak, -Wsatıcılar tarafından kullanılması tavsiye edilen tek karakterli seçeneklerin kullanılmasını ve çok karakterli seçeneklerin bu şekilde barındırılmasını önerir (örneğin, gcc Seçenek Özeti ).

GNU yazılımı ile başlayan çok karakterli seçenekler sundu --. Kılavuz sayfalarını bu seçeneklerle biçimlendirmek için GNU'dan bazı yönergeler help2man referansında bulunabilir .

— Mark Plotnick
kaynak