क्या किसी पृष्ठ पृष्ठ के SYNOPSIS अनुभाग के लिए कोई विनिर्देश है?

Question

मैं कुछ विनिर्देशों लिखने के लिए कोशिश कर रहा हूँ एक छोटी टीम और प्रारूप मैं में कुछ आदेश लिस्टिंग डाल बारे में चयन हो रही के बीच साझा किया जाना है। वहाँ किसी भी औपचारिक आदमी पृष्ठों का सारांश अनुभाग में प्रयोग किया जाता वाक्य रचना की परिभाषा है?

विकिमीडिया कॉमन्स से, यहां सिनोप्सिस अनुभाग के साथ एक मैन पेज का एक उदाहरण है जिसके बारे में मैं बात कर रहा हूं, जहां आदेश आवश्यक और वैकल्पिक तर्कों के साथ सूचीबद्ध है, यह समझता है।

Answer 1

कहीं भी एक मैनपेज का कोई औपचारिक परिभाषा, यहां तक ​​कि नहीं POSIX मानक में नहीं है। आपके उदाहरण में man(1) मैनपेज बहुत विशिष्ट है: आप []mdoc मैक्रोज़ के साथ वैकल्पिक, बोल्ड (या टाइपराइटर फ़ॉन्ट) को इंगित करते हुए विभिन्न तरीकों को लिखते हैं (अक्सर केवल एक) प्रोग्रामर कमांड लाइन इनपुट और वैरिएबल को इंगित करने वाले इटैलिक ।

मैनपेज man(7) और mdoc(7) सबसे महत्वपूर्ण सम्मेलनों की व्याख्या करेगा। man(7) पुरानी शैली यूनिक्स मैनपेज के लिए है और अभी भी लिनक्स पर लोकप्रिय है (man-pages(7) देखें); mdoc(7) 4.4BSD से आता है और इसके डेरिवेटिव में लोकप्रिय है। उत्तरार्द्ध सामग्री और प्रस्तुति के एक कठोर अलगाव को बनाए रखता है और उत्पादन कर सकता है (आईएमएचओ) सुंदर पीडीएफ/एचटीएमएल आउटपुट

Answer 2

उपयोगिता के लिए उपयोगिता सम्मेलन Chapter 12. Utility conventions of the IEEE Std 1003.1, 2004 Edition में दस्तावेज किए गए हैं।

इस दस्तावेज़ का एक नया संस्करण मौजूद है here

Answer 3

आदमी 7 आदमी:

संक्षिप्त आदेश या समारोह के इंटरफ़ेस वर्णन करता है। कमांड के लिए, यह कमांड और उसके तर्कों का सिंटैक्स दिखाता है ( विकल्प सहित); बोल्डफ़ेस का उपयोग टेक्स्ट के रूप में किया जाता है और इटालिक्स का उपयोग को बदलने योग्य तर्कों को इंगित करता है। ब्रैकेट्स ([]) वैकल्पिक तर्क, लंबवत सलाखों (|) अलग विकल्प, और इलिप्स (...) दोहराया जा सकता है। फ़ंक्शंस के लिए, यह फ़ंक्शन घोषणा के बाद, किसी भी आवश्यक डेटा घोषणा या # अंतर्निहित निर्देश दिखाता है।