cxref - क्लाउड में ऑनलाइन

कार्यक्रम:

नाम

cxref - सी क्रॉस रेफरेंसिंग और डॉक्यूमेंटिंग टूल।

SYNOPSIS

सीएक्सरेफ फ़ाइल का नाम [ ... फ़ाइल का नाम] [-ओदिरनाम] [-एनबेसनाम] [-आरबेसनाम] [-सभी-टिप्पणियाँ]
[-कोई टिप्पणी नहीं] [-शब्दशः-टिप्पणियाँ] [-ब्लॉक-टिप्पणियाँ]
[-xref[-all][-फ़ाइल][-func][-var][-type]] [-चेतावनी[-सभी][-टिप्पणी][-xref]]
[-सूचकांक[-सभी][-फ़ाइल][-func][-var][-प्रकार]] [-कच्चा] [-लेटेक्स] [-html[-src]] [-आरटीएफ] [-एसजीएमएल]
[-मैंदिरनाम] [-डीपरिभाषित] [-यूपरिभाषित] [-सीपीपी cpp_प्रोग्राम] [-- cpp_args ... cpp_args]

सीएक्सरेफ फ़ाइल का नाम [ ... फ़ाइल का नाम] -डेली [-ओदिरनाम] [-एनबेसनाम] [-आरबेसनाम]

वर्णन

एक प्रोग्राम जो स्वचालित रूप से सी के लिए दस्तावेज़ीकरण और क्रॉस संदर्भ उत्पन्न कर सकता है
कार्यक्रम.

इनपुट उपयुक्त टिप्पणियों वाला कोई भी C प्रोग्राम है और आउटपुट LaTeX, HTML, RTF या है
एसजीएमएल फ़ाइलें।

विकल्प

फ़ाइल का नाम
दस्तावेज़ के लिए फ़ाइल का नाम, एक समय में कितनी भी संख्या में फ़ाइलों का दस्तावेज़ीकरण किया जा सकता है।

-डेली
नामित फ़ाइलों को आउटपुट निर्देशिका और उनकी प्रविष्टियों से हटा दिया जाना है
क्रॉस रेफरेंस डेटाबेस और मुख्य आउटपुट फ़ाइलें हटा दी जाएंगी।

-ओडिरनाम
आउटपुट लेटेक्स फ़ाइलों के लिए उपयोग की जाने वाली निर्देशिका का नाम और उसका स्थान
क्रॉस रेफरेंस फ़ाइलें जो बनाई जाती हैं।

-एनबेसनाम
इसके बजाय आउटपुट और क्रॉस रेफरेंस फ़ाइलों के पहले भाग के लिए उपयोग किया जाने वाला नाम
cxref के, फ़ाइल एक्सटेंशन वही रहते हैं।

-Rdirname
जब स्रोत फ़ाइलें एक से अधिक निर्देशिका में हों, तो dirname को के नाम पर सेट करें
स्रोत वृक्ष की मूल निर्देशिका (यदि आसान हो तो सापेक्ष पथ का उपयोग करें जैसे `-R../ ..').
इसके बाद यह उस रूट निर्देशिका से cxref चलाएगा और `-Odirname' अवश्य होना चाहिए
उस निर्देशिका के सापेक्ष.

-सभी-टिप्पणियाँ
यदि आपको लगता है कि मौजूदा टिप्पणियाँ काम कर सकती हैं, (विवरण के लिए ऊपर देखें
विशेष टिप्पणियाँ) [खतरा! यह विकल्प अजीब परिणाम दे सकता है।]

-कोई टिप्पणी नहीं
सभी टिप्पणियों को अनदेखा कर देता है, यदि आप केवल क्रॉस संदर्भ चाहते हैं और नहीं, तो यह उपयोगी है
प्रलेखन।

-शब्दशः टिप्पणियाँ
जब कोड में आपकी टिप्पणियाँ पूर्व निर्धारित शैली में स्वरूपित की जाती हैं
जिसे आप आउटपुट पर संरक्षित करना चाहते हैं, यह विकल्प उन्हें ऐसा न करने के लिए बाध्य करेगा
पुनः स्वरूपित। [ध्यान दें, यह केवल फ़ाइल और फ़ंक्शन टिप्पणियों के लिए है।]

-ब्लॉक-टिप्पणियाँ
जब प्रोग्राम में टिप्पणियाँ 'ब्लॉक' शैली में (अग्रणी के साथ) स्वरूपित की जाती हैं
प्रत्येक पंक्ति पर '*' वर्ण), यह विकल्प उस वर्ण को हटा देगा
आउटपुट. [एकल `*', `+', `|' के लिए काम करता है या `:' प्रत्येक पंक्ति पर।]

-एक्सरेफ क्रॉस रेफरेंसिंग जानकारी तैयार करें (नीचे देखें)।
-सभी सभी क्रॉस संदर्भ।
-फ़ाइल फ़ाइलों के लिए क्रॉस संदर्भ।
-फंक फ़ंक्शंस के लिए क्रॉस संदर्भ।
-var चर के लिए क्रॉस संदर्भ।
-प्रकारों के लिए क्रॉस संदर्भ।

-चेतावनी देना चेतावनियाँ उत्पन्न करें, विकल्पों को एक साथ जोड़ा जाना चाहिए:
-सभी सभी चेतावनियाँ.
-टिप्पणी गुम टिप्पणियों की चेतावनी।
-xref अनुपलब्ध क्रॉस संदर्भों की चेतावनी।

-सूचकांक एक क्रॉस रेफरेंस इंडेक्स तैयार करें, विकल्पों को एक साथ जोड़ा जाना चाहिए:
-सभी सभी सूचकांक.
-फाइल फाइलों का सूचकांक।
-फंक कार्यों का सूचकांक।
-var चरों का सूचकांक।
-प्रकारों का सूचकांक।

-कच्चा आउटपुट का एक कच्चा रूप तैयार करें, जो वास्तव में -warn को छोड़कर अधिक उपयोग का नहीं है।

-लेटेक्स प्रत्येक स्रोत फ़ाइल और एक अतिरिक्त फ़ाइल का दस्तावेज़ीकरण करने के लिए एक LaTeX फ़ाइल बनाएँ
जिसमें इनमें से प्रत्येक फ़ाइल शामिल है।

-एचटीएमएल प्रत्येक स्रोत फ़ाइल और एक मुख्य फ़ाइल का दस्तावेज़ीकरण करने के लिए एक HTML 4.01 फ़ाइल तैयार करें
इनमें से प्रत्येक फ़ाइल का संदर्भ लें।

-एचटीएमएल-src
HTML आउटपुट और लिंक के साथ स्रोत फ़ाइल का HTML संस्करण तैयार करें।

-rtf स्रोत फ़ाइल का दस्तावेज़ीकरण करने के लिए एक रिच टेक्स्ट फ़ॉर्मेट (RTF) फ़ाइल तैयार करें।

-एसजीएमएल स्रोत फ़ाइल का दस्तावेज़ीकरण करने के लिए एक SGML फ़ाइल बनाएँ। (LinuxDoc DTD का उपयोग करके)।

-इदिरनाम
फ़ाइलों को शामिल करने के लिए पथ निर्दिष्ट करने के लिए जीसीसी विकल्प।

-डी परिभाषित करें
प्री-प्रोसेसर प्रतीक को परिभाषित करने के लिए जीसीसी विकल्प।

-उपरिभाषित
प्री-प्रोसेसर प्रतीक को अपरिभाषित करने के लिए जीसीसी विकल्प।

-सीपीपी कार्यक्रम
संकलन समय डिफ़ॉल्ट के स्थान पर उपयोग करने के लिए प्रोग्राम का नाम। कार्यक्रम
उन सभी कार्यों को करने में सक्षम होना चाहिए जो `gcc -E -C -dD' काम करने के लिए करता है। अगर
प्रोग्राम तर्क लेता है तो पूरी चीज़ उद्धरण चिह्नों में होनी चाहिए ताकि यह
cxref के एकल तर्क के रूप में व्याख्या की गई है।

--arg ... arg
प्री-प्रोसेसर को दिए जाने वाले अतिरिक्त तर्क `-' के बाद रखे जा सकते हैं
विभाजक।

C संकलक प्रतिस्थापन सीएक्सरेफ-सीसी
मौजूदा स्रोत कोड पर cxref का उपयोग सरल बनाने के लिए, अब एक शेल स्क्रिप्ट है जो ऐसा करेगी
C कंपाइलर को कॉल करें और फिर स्रोत फ़ाइल को संसाधित करने के लिए cxref को कॉल करें। इसका मतलब यह है कि
मेकफ़ाइल्स इत्यादि में CC के प्रतिस्थापन में ड्रॉप के रूप में उपयोग किया जा सकता है।

उपयोग: cxref-cc [सामान्य cc विकल्प]

स्रोत फ़ाइल का नाम विकल्पों की सूची के साथ-साथ `-D*' से निकाला जाता है,
`-I*', `-U*' झंडे और जब C कंपाइलर सफलतापूर्वक बाहर निकलता है तो cxref को कॉल किया जाएगा।
उपयोग करने के लिए C कंपाइलर का नाम CXREFCC पर्यावरण चर द्वारा नियंत्रित किया जाता है, या यदि
यह तब सीसी पर्यावरण चर सेट नहीं है, या यह सिर्फ जीसीसी विफल रहा है।

इस स्क्रिप्ट का उपयोग करने के लिए विकल्पों को शामिल करने के लिए `.cxref' कॉन्फ़िगरेशन फ़ाइल के उपयोग की आवश्यकता होती है
चूँकि C कंपाइलर के लिए कमांड लाइन पर विकल्प रखने के लिए कहीं नहीं है।

यह केवल C स्रोत फ़ाइलों को क्रॉस-रेफ़रेंस और दस्तावेज़ीकृत करेगा क्योंकि वे एकमात्र हैं
जिन्हें संकलित किया गया है, लेकिन यह सुनिश्चित करेगा कि वे इसके साथ क्रॉस-रेफ़रेड हैं
सही विकल्प आदि

सीएक्सरेफ विन्यास पट्टिका
इन कमांड लाइन तर्कों को इसके बजाय `.cxref' नामक फ़ाइल में भी डाला जा सकता है
कमांड लाइन। जब cxref चलाया जाता है तो प्रोग्राम के तर्कों की व्याख्या की जाती है
निम्नलिखित आदेश.

(1) वे जो कमांड लाइन पर हैं। (2) जो वर्तमान निर्देशिका में `.cxref' फ़ाइल में हैं।
(3) वे `.cxref' फ़ाइल में `-R' द्वारा निर्दिष्ट स्रोत ट्री रूट में हैं।

इसका मतलब यह है कि एक बहु-निर्देशिका स्रोत वृक्ष में, प्रत्येक उप-निर्देशिका में एक `.cxref' हो सकता है
फ़ाइल जिसमें केवल पंक्ति `-R..' या उपयुक्त हो। मुख्य निर्देशिका में एक हो सकता है
`.cxref' फ़ाइल जिसमें शेष विकल्प हैं। इससे जरूरत पूरी तरह खत्म हो जाती है
स्रोत फ़ाइल नामों के अलावा कमांड लाइन पर कोई भी विकल्प रखने के लिए।

`.cxref' फ़ाइल का प्रारूप कितनी भी पंक्तियों का हो, प्रत्येक में एक पंक्ति हो
कमांड लाइन तर्क (argv में से एक के बराबर)। एकमात्र विकल्प जो नहीं हो सकता
स्रोत फ़ाइलों के नाम और `-डिलीट' विकल्प का उपयोग किया जाता है। रिक्त पंक्तियाँ हैं
अनदेखा किया गया और '#' से शुरू होने वाली पंक्तियाँ टिप्पणियाँ हैं।

कार्यक्रम प्रलेखन टिप्पणियाँ
कार्यक्रम के लिए दस्तावेज़ीकरण कोड में टिप्पणियों से तैयार किया गया है
उचित रूप से स्वरूपित. क्रॉस रेफरेंसिंग कोड से ही आती है और इसके लिए किसी की आवश्यकता नहीं होती है
अतिरिक्त काम।

विशेष टिप्पणियाँ हैं `/**** ****/' (फ़ाइल के लिए) और `/*++++ ++++*/' (डेटा के लिए)
ऑब्जेक्ट) किसी भी संख्या में `*' या `+' का उपयोग मानक `/*' और `*/' टिप्पणी के अंदर किया जा सकता है
टिप्पणियों में सीमांकक, उन्हें नजरअंदाज कर दिया जाता है।

यदि कोई टिप्पणी पंक्ति रिक्त स्थान से प्रारंभ होती है और उसके बाद `+html+' होता है तो शेष
लाइन केवल HTML आउटपुट में शामिल है, और संसाधित नहीं है इसलिए इसमें HTML शामिल हो सकता है
मार्कअप, `-html-' का अर्थ है कि HTML को छोड़कर शेष पंक्ति सभी में शामिल है
आउटपुट. यही बात अन्य आउटपुट स्वरूपों पर भी लागू होती है, `+none+' का उपयोग लाइनों के लिए किया जा सकता है
किसी भी आउटपुट में प्रदर्शित नहीं होना। इसका अपवाद यह है कि कच्चा आउटपुट कोई काम नहीं करता
जाँच करेगा और सभी पंक्तियों को आउटपुट करेगा।

किसी भी स्थिति में जहां कोई टिप्पणी `,', `;' के बाद आती है या `)' केवल रिक्त स्थान द्वारा अलग किया गया और
टैब, टिप्पणी को वहां ऑब्जेक्ट पर लागू करने के लिए विराम चिह्न से पहले धकेल दिया जाता है।

कार्यक्रम को कुछ जीसीसी एक्सटेंशन के साथ पूर्ण एएनएसआई सी व्याकरण पार्सर का उपयोग करके कार्यान्वित किया जाता है,
इसका मतलब यह है कि कोड की शैली महत्वहीन है, केवल सामग्री और टिप्पणियाँ।

क्रॉस संदर्भित
निम्नलिखित मदों के लिए क्रॉस रेफरेंसिंग की जाती है

फ़ाइलें
वे फ़ाइलें जिनमें वर्तमान फ़ाइल शामिल है
(यहां तक ​​कि जब अन्य फ़ाइलों के माध्यम से शामिल किया गया हो)।

#शामिल है
वर्तमान फ़ाइल में शामिल फ़ाइलें.
इन फ़ाइलों आदि में शामिल फ़ाइलें।

चर
बाह्य चरों की परिभाषा का स्थान.
वे फ़ाइलें जिनमें वैश्विक चर की दृश्यता है।
फ़ाइलें/फ़ंक्शन जो वेरिएबल का उपयोग करते हैं।

कार्य
वह फ़ाइल जिसमें फ़ंक्शन प्रोटोटाइप किया गया है।
वे फ़ंक्शन जिन्हें फ़ंक्शन कॉल करता है.
वे फ़ंक्शन जो फ़ंक्शन को कॉल करते हैं.
फ़ाइलें और फ़ंक्शंस जो फ़ंक्शन को संदर्भित करते हैं।
वे वेरिएबल जो फ़ंक्शन में उपयोग किए जाते हैं.

इनमें से प्रत्येक आइटम को आउटपुट में क्रॉस रेफरेंस किया गया है।

क्रॉस रेफ़रेंसिंग फ़ाइलों का उपयोग करता है `cxref.variable', `cxref.function', `cxref.include' और
आउटपुट निर्देशिका में `cxref.typedef'। ये फ़ंक्शन की पूरी सूची हैं और
प्रोग्राम में परिवर्तनीय उपयोग और फ़ंक्शन कॉल पदानुक्रम उत्पन्न करने के लिए उपयोग किया जा सकता है
उदाहरण के लिए परिवर्तनीय उपयोग आरेख। प्रत्येक फ़ाइल के दो cxref पास की आवश्यकता होती है, सबसे पहले
क्रॉस रेफ़रेंसिंग फ़ाइलें बनाएं और दूसरा उनका उपयोग करें।

(यदि '-एन' विकल्प का उपयोग किया जाता है तो फ़ाइल नाम भिन्न होते हैं।)

LaTeX उत्पादन
डिफ़ॉल्ट LaTeX आउटपुट प्रत्येक स्रोत फ़ाइल के लिए एक अतिरिक्त फ़ाइल के साथ एक फ़ाइल है
`cxref.tex' जिसमें अन्य सभी फ़ाइलें शामिल हैं। यह केवल मेकफ़ाइल को अनुमति देने के लिए है
परिवर्तित फ़ाइलों को अद्यतन करें (हालाँकि संदर्भ के लिए सभी फ़ाइलों की आवश्यकता हो सकती है
पुनः जाँच की गई)। जब cxref.tex फ़ाइल लिखी गई है तो इसे उपयोगकर्ता द्वारा संशोधित किया जा सकता है,
जो भी नई फ़ाइलें जोड़ी जाती हैं उन्हें स्रोत कोड अनुभाग के अंत में जोड़ा जाता है, शेष को
फ़ाइल अपरिवर्तित है.

सूचकांक को `cxref.apdx.tex' नामक फ़ाइल में लिखा जाता है और cxref.tex को संदर्भित करने के लिए अद्यतन किया जाता है
यह करने के लिए.

तीन LaTeX शैली फ़ाइलें `page.sty', `fonts.sty' और `cxref.sty' भी लिखी गई हैं।
ये पृष्ठ को छोटे मार्जिन और छोटे फ़ॉन्ट का उपयोग करने के लिए सेट करते हैं ताकि अधिक को प्रदर्शित किया जा सके
एक पेज और cxref आउटपुट टाइपसेटिंग के लिए नए कमांड भी परिभाषित करें।

(यदि '-N' विकल्प है तो फ़ाइल नाम `cxref.tex' और `cxref.apdx.tex' भिन्न हैं
उपयोग किया गया।)

एचटीएमएल उत्पादन
डिफ़ॉल्ट HTML आउटपुट प्रत्येक स्रोत फ़ाइल के लिए एक अतिरिक्त फ़ाइल के साथ एक फ़ाइल है
`cxref.html' जिसमें अन्य सभी फ़ाइलें शामिल हैं। यह केवल मेकफ़ाइल को अनुमति देने के लिए है
परिवर्तित फ़ाइलों को अद्यतन करें (हालाँकि संदर्भ के लिए सभी फ़ाइलों की आवश्यकता हो सकती है
पुनः जाँच की गई)। जब cxref.html फ़ाइल लिखी गई है तो इसे उपयोगकर्ता द्वारा संशोधित किया जा सकता है,
जो भी नई फ़ाइलें जोड़ी जाती हैं उन्हें विषय-सूची से पहले अंत में जोड़ा जाता है, बाकी
फ़ाइल के अपरिवर्तित होने पर.

सूचकांक को `cxref.apdx.html' नामक फ़ाइल में लिखा जाता है और cxref.html को संदर्भित करने के लिए अद्यतन किया जाता है
यह करने के लिए.

(यदि '-N' विकल्प है तो फ़ाइल नाम `cxref.html' और `cxref.apdx.html' भिन्न हैं
उपयोग किया गया।)

HTML आउटपुट HTML 4.01 मानक का उपयोग करता है और सभी पृष्ठ सही ढंग से मान्य होते हैं।

आरटीएफ उत्पादन
रिच टेक्स्ट फ़ॉर्मेट Microsoft द्वारा तैयार किया गया एक काफी निम्न स्तरीय पृष्ठ विवरण प्रारूप है। यह
यह अन्य प्रारूपों की तरह एक अच्छी तरह से परिभाषित और समझने में आसान मानक नहीं है, लेकिन यह है
दस्तावेज़ विनिमय के लिए लोकप्रिय।

प्रत्येक स्रोत फ़ाइल और एक इंडेक्स फ़ाइल के लिए एक एकल आउटपुट फ़ाइल है।

SGML उत्पादन
चूंकि एसजीएमएल एक मेटा-भाषा है, इसलिए लेआउट तत्वों को भी परिभाषित करना आवश्यक है
जानकारी प्रदान करें. Cxref आउटपुट LinuxDoc दस्तावेज़ प्रारूप का उपयोग करता है और है
SGMLtools प्रोग्राम के साथ उपयोग के लिए डिज़ाइन किया गया (http://www.sgmltools.org/).

प्रत्येक स्रोत फ़ाइल और एक इंडेक्स फ़ाइल के लिए एक एकल आउटपुट फ़ाइल है।

onworks.net सेवाओं का उपयोग करके ऑनलाइन cxref का उपयोग करें