2010-05-01 18 views
7

मैन पेज लेखक लिखने का सबसे अच्छा तरीका क्या है? क्या मुझे मानक मैन मैक्रोज़ का उपयोग करके लिखना चाहिए, या क्या अब कुछ चालाक पैकेज उपलब्ध हैं जो किसी प्रकार का एक्सएमएल-इफिड स्रोत लेता है और मैन पेज, एचटीएमएल, एएससीआईआई आउटपुट कर सकता है और क्या नहीं?लेखक मैन पेज के लिए सबसे अच्छा तरीका?

धन्यवाद

+0

@ vy32: आखिरकार आप अंत में क्या समाप्त कर चुके थे? – Lazer

+0

मैं इसे nroff में कर समाप्त हो गया। – vy32

उत्तर

0

मेरे atinout प्रोग्राम के लिए मैं ronn का उपयोग कर रहा हूं जो आपको मैन पेज को सिंटैक्स जैसे बहुत ही पठनीय मार्कडाउन में लिखने देता है। मैं इसके साथ बेहद खुश हूं।

atinout(1) -- Send AT commands to modem, capturing the response 
=============================================================== 

## SYNOPSIS 

`atinout` <input_file>|`-` <modem_device> <output_file>|`-`<br> 
`atinout` `--version`<br> 
`atinout` `--usage`<br> 
`atinout` `--help`<br> 

## DESCRIPTION 

**Atinout** reads a list of AT commands. It sends those commands one by one 
to the modem, waiting for the final result code for the 
currently running command before continuing with the next command in 
the list. The output from the commands is saved. 
... 

see the whole page here

+0

यह बहुत अच्छा है! – vy32

+0

हालांकि, आप कॉन्फ़िगरेशन स्क्रिप्ट को कैसे वितरित करते हैं जो स्वचालित रूप से 'atinout' चलाता है? – vy32

+0

आपका मतलब है "... स्वचालित रूप से रन रन"? अच्छा मैं नहीं करता। दोनों टोपी एटिनआउट में कॉन्फ़िगर स्क्रिप्ट नहीं है और मैं एक premade atinout.1 वितरित करता हूं ताकि रोन एक कठिन निर्माण निर्भरता न हो (केवल तभी जब आप उस मैन पेज को संशोधित करना चाहते हैं, तो आपको इसकी आवश्यकता है)। – hlovdal

1

Doxygen आप के लिए क्या देख रहे है। ध्यान रखें कि यह स्रोत कोड दस्तावेज़ करने के लिए डिज़ाइन किया गया है लेकिन आप इसे आसानी से अनुकूलित कर सकते हैं।

यह एचटीएमएल, पीडीएफ, और लेटेक्स दस्तावेज भी उत्पन्न कर सकता है।

+0

डॉक्सिजन एक शक्तिशाली प्रणाली है, लेकिन यह मुझे स्पष्ट नहीं है कि मैं कमांड लाइन विकल्पों और ऐसे के लिए अच्छे मैन पेजों को कैसे निकालने के लिए इसे प्राप्त करता हूं। – vy32

+0

हां। शायद आपको कुछ और चाहिए। http://www.doxygen.nl/config.html#cfg_man_output : –

+0

आप GENERATE_MAN और फिर वैकल्पिक रूप से आदमी-निर्गम (आउटपुट का स्थान निर्धारित करने के लिए) Doxygen विन्यास फाइल में सेट करके उत्पादन आदमी प्रारूपित पृष्ठों के लिए Doxygen प्राप्त कर सकते हैं डॉक्स में उल्लिखित अनुसार, यदि आप मैन-आउटपुट वैल्यू को रिक्त छोड़ देते हैं तो यह मैन पेज को 'मैन' – DEzra

1

यदि आप एक बार लिखने और मैनपेज, एचटीएमएल, सादा txt, या यहां तक ​​कि पीडीएफ जैसे विभिन्न आउटपुट प्रारूपों को उत्पन्न करना चाहते हैं, तो docbook सर्वोत्तम काम करना चाहिए।

+0

नामक एक उपदिर के नीचे डालने के लिए डिफ़ॉल्ट होगा, डॉकबुक मैन पेज का उत्पादन नहीं करता है। यह उन्हें निगल सकता है, लेकिन उन्हें उत्पादन नहीं कर सकता है। – vy32

+0

मुझे लगता है कि छाया-यूटिल इसका सफलतापूर्वक उपयोग करते हैं, जैसे "xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/profile-docbook.xsl $ FILE" –

2

मैंने पहले मैन पेज लिखने के लिए ग्रॉफ नामक नाफॉफ़ के जीएनयू संस्करण का उपयोग किया है। इस पर

अच्छा परिचय लेख यहाँ:

http://www.linuxjournal.com/article/1158

+0

+1 भले ही यह वास्तव में नहीं है उन्हें लिखने के लिए * लेखन * के लिए उपकरण। –

+0

सच, अच्छा बिंदु :-) – DEzra

1

एक उपकरण है जो आमतौर पर Tcl समुदाय में प्रयोग किया जाता है doctools है जो मैनपेज प्रारूप की एक सीमित (लेकिन उपयोगी) सबसेट, प्रतिपादन के लिए उपयुक्त उत्पादन कर सकते हैं groff या nroff के साथ। यह सीधे सादा पाठ और एचटीएमएल दोनों उत्पन्न कर सकता है।

संबंधित मुद्दे