अपडेट-योरिकडॉक - क्लाउड में ऑनलाइन

कार्यक्रम:

नाम

अपडेट-योरिकडॉक - योरिक के लिए HTML दस्तावेज़ बनाएँ

SYNOPSIS

अपडेट-योरिकडॉक [--conf=फ़ाइल] [--ऑटो] [--ऑटो-अभी] [--से =निर्देशिका] [--को =निर्देशिका]
[--xref-डीआईआर =निर्देशिका] [--src-डीआईआर =निर्देशिका] [--टेम्पलेट=फ़ाइल]

वर्णन

अपडेट-योरिकडॉक htmldoc.i के चारों ओर एक आवरण है, एक योरिक स्क्रिप्ट जो दस्तावेज़ निकालती है
योरिक स्रोत फ़ाइलों से टिप्पणियाँ और उन्हें HTML फ़ाइलों के एक सेट में बदल देता है।
अपडेट-योरिकडॉक "स्रोत निर्देशिका" से फ़ाइलों को मर्ज करता है (डिफ़ॉल्ट: /usr/share/yorick-doc,
कमांड-लाइन विकल्प: --src-dir), लक्ष्य निर्देशिका को हटा देता है (डिफ़ॉल्ट:
/usr/share/doc/yorick-doc/html_xref), और, यदि योरिक स्थापित है, तो "yorick -batch" कहता है
htmldoc.i" वर्तमान में स्थापित सभी फ़ंक्शंस (या तो) के लिए HTML दस्तावेज़ संकलित करने के लिए
मुख्य योरिक पैकेज से या ऐड-ऑन पैकेज से)।

जब भी कोई योरिक पैकेज होता है तो अपडेट-योरिकडॉक स्वचालित रूप से कॉल किया जाता है
स्थापित या हटा दिया गया। "ENABLE_AUTO" सेट करके स्वचालित अपडेट को रोकना संभव है
/etc/yorick-doc में 0 से. बनाने के लिए अपडेट-योरिकडॉक का मैन्युअल रूप से उपयोग करना भी संभव है
कस्टम निर्देशिकाओं से दस्तावेज़ीकरण (उदाहरण के लिए उपयोगकर्ता का अपना)। ~/योरिक/ निर्देशिका) या a
उदाहरण के लिए, कस्टम स्थान।

अपडेट-योरिकडॉक में कार्य करने के लिए डिफ़ॉल्ट पैरामीटर का एक सेट है। ये पैरामीटर हैं
सामग्री /etc/yorick-doc, $HOME/.yorick-doc, और द्वारा कालानुक्रमिक क्रम में अधिलेखित किया गया
कमांड लाइन।

इस स्क्रिप्ट को कार्य करने के लिए कुछ फ़ाइलों की आवश्यकता होती है। डिफ़ॉल्ट फ़ाइलें इसमें प्रदान की गई हैं
डिफ़ॉल्ट स्रोत निर्देशिका, और ऐड-ऑन पैकेज में अतिरिक्त जानकारी प्रदान करनी चाहिए
उसी जगह। देखना फ़ाइलें नीचे और साथ ही /usr/share/doc/yorick-dev/yorick-policy.gz।

विकल्प

--ऑटो | -a
डीपीकेजी में ट्रिगर्स के आगमन से इस ध्वज का अपमान किया जा रहा है। उन प्रणालियों पर जहां dpkg
ट्रिगर्स का समर्थन करता है, -ए अपडेट-योरिकडॉक को नो-ऑप में बदल देता है। पुराने सिस्टम पर, यह
नीचे -A जैसा व्यवहार करता है।

--ऑटो-अभी | -A
इस ध्वज का उपयोग केवल योरिक-डॉक पैकेज की पोस्टइंस्ट स्क्रिप्ट में किया जाना है,
यह माना जाता है कि हर बार योरिक ऐड-ऑन पैकेज चालू होने पर यह चालू हो जाता है
स्थापित, उन्नत, या हटाया गया। अपडेट-योरिकडॉक को नो-ऑप में बदलना संभव है
जब यह ध्वज /etc/yorick-doc में ENABLE_AUTO को 0 पर सेट करके सेट किया जाता है।

--conf=पट्टिका
इस फ़ाइल से कॉन्फ़िगरेशन पढ़ें. जैसे ही विकल्प मिलता है, इस फ़ाइल को पार्स किया जाता है
कमांड लाइन, पहले आने वाले विकल्पों को ओवरराइट करना।

--से =निर्देशिका1:निर्देशिका2...
योरिक फ़ाइलों को स्कैन करने के लिए निर्देशिकाओं की कोलन से अलग की गई सूची। गलती करना:
/usr/share/yorick/i:/usr/share/yorick/i0.

--शुद्ध करना | -p
केवल /usr/share/doc/yorick-doc/html_xref (या --to और का उपयोग करके सेट की गई निर्देशिका) को हटाएं
--xref-dir, या /etc/yorick-doc में समतुल्य चर), का पुनर्निर्माण न करें
बाद में दस्तावेज़ीकरण.

--शांत | -q
चुप रहो, केवल शीघ्र ही बताऊंगा कि अपडेट-योरिकडॉक क्या करता है। यह बिल्ट-इन है
डिफ़ॉल्ट लेकिन कॉन्फ़िगरेशन फ़ाइल में ओवरराइड किया गया हो सकता है।

--src-डीआईआर =डायरेक्टरी
निर्माण करते समय निर्देशिका जिसमें .packinfo, .keywords और .aliases फ़ाइलें होती हैं
दस्तावेज़ीकरण. इन तीन प्रकार की फ़ाइलों में से प्रत्येक को संयोजित किया जाएगा
शब्दकोषीय क्रम और --packinfo, --keywords, और का उपयोग करके htmldoc.i पर फ़ीड किया गया
--उपनाम विकल्प (htmldoc.i देखें)। डिफ़ॉल्ट: /usr/share/yorick-doc.

--टेम्पलेट=पट्टिका
htmldoc.i के लिए टेम्पलेट फ़ाइल। सही प्रारूप विस्तृत htmldoc.i है। गलती करना:
/usr/share/yorick-doc/template.html.

--को =डायरेक्टरी
अद्यतन करने के लिए योरिक HTML पदानुक्रम की शीर्ष-स्तरीय निर्देशिका। यह एक स्तर ऊपर है
वह निर्देशिका जिसे हटा दिया जाएगा और/या (पुनः) बनाया जाएगा। के लिए डिफ़ॉल्ट
/usr/share/doc/yorick-doc.

--शब्दशः | -v
क्रियात्मक बनें, ढेर सारी डिबगिंग जानकारी आउटपुट करें। अंतर्निहित डिफ़ॉल्ट होना है
शांत, बस शीघ्र ही बता रहा हूं कि अपडेट-योरिकडॉक क्या करता है।

--xref-डीआईआर =शब्द
"TO" निर्देशिका की उप-निर्देशिका जिसमें दस्तावेज़ संकलित करना है। निश्चित
दस्तावेज़ीकरण में हाइपरलिंक इस मान का उपयोग करेंगे। इसे a पर सेट नहीं किया जाना चाहिए
वह निर्देशिका जिसकी सामग्री को आप महत्व देते हैं, चूँकि यह निर्देशिका सबसे पहले मिटा दी जाएगी। गलती करना:
html_xरेफरी।

onworks.net सेवाओं का उपयोग करके ऑनलाइन अपडेट-योरिकडॉक का उपयोग करें