क्या कमांड सिनोप्सिस लिखने के लिए कोई मानक है?

Question

यह मुझे प्रतीत होता है कि अंत उपयोगकर्ता के लिए कमांड के उपयोग का एक सारांश लिखने के तरीके पर सभी का अपना विचार है ।

उदाहरण के लिए, यह इस प्रकार है man grep:

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

अब इसके कुछ सिंटैक्स हैं जो अन्य मैनपेज़ में दिखाई देते हैं। []वैकल्पिक के रूप में मान्यता प्राप्त है, और ...एक ही इनपुट के कई के रूप में समझ में आता है।

लेकिन लोगों के लिए उपयोग |या /के लिए या और वहाँ दूसरों है कि क्या रिवर्स जाएगा []साधन। या वे कोई संकेत नहीं देते हैं कि वह कहां [OPTIONS]जाता है।

मैं जो लिखता हूं उसके लिए एक मानक का पालन करना चाहता हूं, लेकिन मैं जिस वेबसाइट को देखता हूं, वह मुझे कुछ अलग बताती है।

क्या सिनॉप्स लिखने का एक वास्तविक मानक तरीका है, या क्या सिर्फ समय के साथ लोग क्या कर रहे हैं?

Comments

एक उठाओ और इसके साथ रहना।

— केविन

किसी कारण से मुझे नहीं लगता कि इससे मदद मिलेगी। हर व्यक्ति का अपना मानक होता, और फिर उसके बारे में कभी कुछ नहीं किया जाता।

— टॉर्मीस्ट जूल 3'14

क्या यह मानक का मतलब है? pubs.opengroup.org/onlinepubs/009695399/basedefs/…

— मार्क प्लॉटनिक

हां, यह वही है जिसकी मुझे तलाश थी। धन्यवाद।

— टॉर्मीस्ट जूल 3'14

@MarkPlotnick - मैं ऐसा करूँगा कि एक ओपी इसे स्वीकार कर सके। अगर कभी एक था तो वह मानक है। उस लिंक का संदर्भ दें, जिसका संदर्भ प्रबुद्ध है।

— स्लम

Answer 1

इसके लिए क्लासिक मानक पोसिक्स, यूटिलिटी आर्ग्यूमेंट सिंटैक्स (अद्यतन लिंक के लिए @ इल्लुमिनÉ के लिए धन्यवाद) से है। यह उदाहरण के लिए, मैन पेज में सिंटैक्स का उपयोग करने का वर्णन करता है

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

क्लासिक होने के नाते, यह -Wविक्रेताओं द्वारा उपयोग के लिए अनुशंसित एकल-चरित्र विकल्पों का उपयोग करने की सिफारिश करता है, और यह है कि बहु-चरित्र विकल्पों को कैसे समायोजित किया जाता है (उदाहरण के लिए, gcc विकल्प सारांश देखें )।

GNU सॉफ्टवेयर ने बहु-चरित्र विकल्प पेश किए जो इसके साथ शुरू होते हैं --। उन विकल्पों के साथ मैन पेजों को प्रारूपित करने के लिए GNU के कुछ दिशानिर्देश हेल्प 2मैन संदर्भ में पाए जा सकते हैं ।