मैं मैन पेज कैसे लिखूं? [बन्द है]

Question

मैं एक आदमी पृष्ठ कैसे लिख सकता हूँ?

मुझे सभी प्रारूपण कोड का संदर्भ कहां मिल सकता है?

क्या मैन पेज लिखने पर कोई अच्छा ट्यूटोरियल है?

मैन पेज लिखने का सबसे सुविधाजनक तरीका क्या है? क्या मुझे इसे सीधे टेक्स्ट एडिटर में दर्ज करना चाहिए? क्या WYSIWYG संपादक हैं? या क्या मुझे इसे एक अलग प्रारूप में लिखना चाहिए और फिर परिवर्तित करना चाहिए?

एक अच्छे आदमी के पेज को किन नियमों का पालन करना चाहिए?

Comments

यह प्रश्न बहुत व्यापक प्रतीत होता है। यह केवल लिंक-केवल उत्तर और कुछ असमर्थित राय का एक गुच्छा आकर्षित करने में सफल रहा है।

— 200_success

man man, man groff।

— जेनी डी

Answer 1

यहाँ कुछ वेब पेज हैं जो आपको आरंभ करने में मदद करेंगे:

• मैन पेज बनाना और फॉर्मेट करना
• अपना खुद का आदमी पेज बनाना
• अपना खुद का मैन पेज बनाएं
• मैन पेज कैसे लिखें
• मैन पेज लिखने के लिए आपको क्या जानना होगा

उपयोगी उपकरणों की एक जोड़ी:

• txt2man
• help2man

Answer 2

मैन पेज लिखने के लिए टूल हैं जो ट्रॉफ फॉर्मेटिंग को बायपास करते हैं। manpages एक छोटी, अच्छी तरह से सीमांकित भाषा और लक्ष्य करने में आसान है।

दो लोकप्रिय उपकरण हैं:

• xmltoman , एक छोटी और अच्छी तरह से संरचित xml भाषा है जो मैनपेज़ और HTML उत्पन्न कर सकती है। इसका उपयोग Lennart Poettering की परियोजनाओं, syrep और pulseaudio द्वारा उदाहरण के लिए किया जाता है ।
• asciidoc , उदाहरण के लिए git द्वारा उपयोग किया जाता है ।

yodl और zoem इस स्पेस में अन्य अच्छे प्रारूप हैं।

सभी में मैं xmltoman की सलाह दूंगा क्योंकि यह एक बहुत ही मैनपेज विशिष्ट डीएसएल है जो आपको बारीकी से मार्गदर्शन करेगा।

Comments

"dsl" == "डोमेन विशिष्ट भाषा"?

— अगली सूचना तक रोक दिया गया।

हां (दा। सी। 15 वर्ण।)

— तोबू

एक और अच्छा विकल्प Ronn है , जो अधिक व्यापक रूप से उपयोग किए जाने वाले मार्कडाउन टेक्स्ट मार्कअप लैंग्वेज को पढ़ता है।

— पूली

Answer 3

मैंने इस विषय के बारे में एक व्यापक ब्लॉग लेख लिखा है, जिसे आप यहां पा सकते हैं:

http://2buntu.com/articles/1034/how-to-write-a-manpage/

Comments

यह उपयोगी होगा यदि आप कम से कम लेख को यहाँ संक्षेप में प्रस्तुत कर सकते हैं - एक बार लिंक किए गए पृष्ठ को अनिवार्य रूप से स्थानांतरित या गायब हो जाने पर अकेले लिंक बेकार होते हैं।

— कालेब

मैं कालेब से सहमत नहीं हूं। यह वेब है। वेब लिंक पर आधारित है, और स्टैकएक्सचेंज इसका कोई विशेष अपवाद नहीं करता है। सामग्री की प्रतिलिपि बनाना प्रतिसंबंधी है। उस पृष्ठ या दस्तावेज़ के लिए जो कुछ भी बुरा हो सकता है, वह इस से भी हो सकता है । हम सभी सामग्री की स्क्रैप की गई प्रतियों को केवल इसलिए नहीं निकाल सकते क्योंकि शेष वेब गायब हो सकते हैं। (उस काम को वेकबैक मशीन जैसी साइटों पर छोड़ दें)।

— काज

कज़, आप सहमत नहीं हो सकते हैं, लेकिन कालेब की टिप्पणी निश्चित रूप से सर्वरफॉल्ट सबसे अच्छा अभ्यास है।

— मैडहैटर

Answer 4

मुझे किसी आईडीई या ट्यूटोरियल का पता नहीं है, लेकिन आप किसी मौजूदा मैन पेज को कॉपी करके शुरू कर सकते हैं और अपनी आवश्यकताओं के अनुरूप इसे संशोधित कर सकते हैं।

आदमी मैक्रो के Groff भाषा का एक संदर्भ से परामर्श (जो क्या एक आदमी पृष्ठ द्वारा प्रयोग किया जाता है) के लिए groff_man आदमी पृष्ठ, या यह ऑनलाइन यहाँ पढ़

Answer 5

Ronn प्रोजेक्ट पर एक नजर । यह मैन पेज जनरेटर के लिए एक मार्कडाउन है। यह इस तरह html में मैन पेज भी जेनरेट कर सकता है ।

मुझे अपने सभी सॉफ्टवेयर प्रलेखन को एक प्रारूप में लिखने का विचार पसंद है। मार्कडाउन IMO एक अच्छा विकल्प है