Кіріспе

Unix бағдарламалық қамтамасыз ету құжаттамасы

Man page (manual page) – Unix немесе Unix сияқты операциялық жүйелерде кездесетін бағдарламалық қамтамасыз ету құжаттамасының бір түрі. Онда компьютерлік бағдарламалар (кітапханалар мен жүйелік шақыруларды қоса алғанда), ресми стандарттар мен ережелер, тіпті абстракті ұғымдар сипатталады. Пайдаланушы man командасын орындау арқылы man бетін шақыра алады. Көрсету үшін man әдетте more немесе less сияқты терминал беттеуші бағдарламасын пайдаланады. Man беттері жиі бағдарламалық қамтамасыз ету құжаттамасының онлайн түрі деп аталады, тіпті man командасы интернетке қосылуды қажет етпесе де, бұл атау басылып шығарылатын нұсқаулықтар кең таралған кездерге дейін барған кезде пайда болды.

Тарих

Unix-тен бұрын (мысалы, GCOS) құжаттама баспа беттері түрінде болды, пайдаланушыларға (қызметкерлер, студенттер) қолжетімді, болаттан жасалған мұқабаларға жинақталды, бір монолитті болаттан жасалған кітап сөресінде бірге бекітілді, үстелге немесе тіреуге орнатылды, модульдік ақпаратты жаңарту, ауыстыру, қателерді түзету және қосымша материалдар үшін реттелген беттермен. Unix тарихының алғашқы екі жылында ешқандай құжаттама болған жоқ. Unix бағдарламашының нұсқаулығы алғаш рет 1971 жылдың 3 қарашасында жарық көрді. Алғашқы «man» беттерін Деннис Ричи мен Кен Томпсон 1971 жылы менеджері Дуг Макилройдың талабы бойынша жазды. «Man» беттерінен басқа, бағдарламашының нұсқаулығында сондай-ақ қысқа мақалалар жинағы болды, олардың кейбіреулері оқулықтар (мысалы, жалпы Unix қолданысы, C бағдарламалау тілі және Yacc сияқты құралдар), ал қалғандары операциялық жүйенің мүмкіндіктерінің егжей-тегжейлі сипаттамалары еді. Нұсқаулықтың баспа нұсқасы бастапқыда бір мұқабаға сыйып тұрды, бірақ PWB/UNIX және Research Unix-тің 7-ші нұсқасынан бастап ол екі томға бөлінді, баспа беттері 1-ші томды құрады. Құжаттаманың кейінгі нұсқалары алғашқы «man» беттерінің лакониктілігін ұстанды. Ричи үшінші нұсқаның кіріспесіне «Бастау қалай?» бөлімін қосты, ал Лоринда Черри алтыншы және жетінші нұсқалар үшін «Көк карта» (Purple Card) түріндегі анықтамалық карточкасын ұсынды. Бағдарламалық жасақтама нұсқалары нұсқаулықтың қайта қаралуына сәйкес аталды; мысалы, Unix бағдарламашының нұсқаулығының жетінші нұсқасы Unix-тің 7-ші нұсқасымен немесе 7-ші басылымымен бірге келді. Төртінші нұсқа үшін «man» беттері troff типографиялық жиынтығын және оның «man» макростары жиынтығын (Мануалдың алтыншы және жетінші нұсқалары арасында толығымен қайта қарастырылған, бірақ алдымен шектелген, содан кейін 2017 жылы табылғаннан кейін алынып тасталған) пайдаланып пішімделді.

Пішімдеу

Man парақшаларының әдепкі пішімі troff, man макро пакеті (көрініске бағытталған) немесе mdoc (семантикалық бағытталған) болып табылады. Бұл man парақшасын PostScript, PDF және басқа да әртүрлі форматтарға түрлендіріп, қарауға немесе басып шығаруға мүмкіндік береді. Кейбір Unix жүйелерінде командаға арналған пакет бар, ол пайдаланушыларға HTML шолушысы арқылы man парақшаларын қарауға мүмкіндік береді. groff және man db орнатылған жүйелерде оның орнына жоғары сапалы түпнұсқа HTML форматын пайдалану ұсынылады. GNU Emacs бағдарламасы WoMan ("WithOut man") редактордан man парақшаларын қарауға мүмкіндік береді. 2010 жылы OpenBSD man парақшаларын форматтау үшін troff-ты қолдануды тоқтатты және оның орнына PostScript, HTML, XHTML және терминалға шығаруды қолдайтын, man парақшаларына арналған арнайы компилятор/форматтаушы mandoc-ты пайдалануға көшті. Ол тек нұсқаулық парақшаларда қолданылатын, әсіресе mdoc макростарын қолданатын трофтың шектеулі бөлігін ғана қолдайды.

Онлайн қызметтер

Көптеген веб-сайттар түрлі Unix-тәрізді жүйелердегі нұсқаулық парақтарға онлайн қол жетімділікті ұсынады. 2013 жылдың ақпан айында BSD қауымдастығы жаңа ашық бастапқы кодты mdoc.su қызметін іске қосты, ол негізгі заманауи BSD жобаларының man.cgi скрипттеріне бірыңғай және қысқартылған қол жетімділікті қамтамасыз етеді. Бұл *BSD нұсқаулықтары үшін бірегей nginx-ге негізделген детерминистік URL қысқарту қызметі арқылы жүзеге асырылды. Linux үшін man7.org қызметі жүйеге арналған нақты нұсқаулықтарды ұсыну үшін құрылды. ManKier қызметі кеңірек таңдауды ұсынады және TLDR беттерін де біріктіреді.

Орналасу

Барлық нұсқаулық беттерінің жалпы құрылымы қарапайым ASCII мәтіндік дисплейде көрсетуге оңтайландырылған, мүмкін, ешқандай түс беру немесе қаріп басқарусыз. Бөлімдер мыналарды қамтуы мүмкін: Макро жиынтығы атау жолына, бөлімдердің тақырыптарына, (қалың, кішкентай немесе курсив) қаріптерге, абзастарға және кіріспелерді қосу/азайтуға арналған нұсқаулармен минималды бай мәтін функцияларын ұсынады. Жаңа тіл семантикалық тұрғыдан көбірек дамыған және бағдарламаның аты, синопсис, функция атаулары және авторлардың аты сияқты стандартты бөлімдер үшін арнайы макростарды қамтиды. Бұл ақпаратты mandoc сияқты бағдарламалармен нұсқаулықтарды семантикалық іздеуді жүзеге асыру үшін пайдалануға болады. Стильді тікелей басқаруға арналған нұсқаулар да бар, бірақ арнайы макростар пайдалану жағдайларының көп бөлігін қамтиды деп күтілуде. Mandoc және groff жобалары жаңа құжаттар үшін артықшылықты формат деп санайды. Нұсқаулық беттері трофқа 10 балдық рим қаріпімен жазылған мәтін болғанымен, бұл айырмашылық көбінесе маңызсыз, өйткені нұсқаулық беттері терминалда (TTY) қарастырылады, қағазға басылмайды. Осының салдарынан "кішкентай қаріп" макросы сирек қолданылады. Керісінше, қалың және курсив мәтіні терминалмен ECMA 48 стандарты арқылы қолдалады, ал groff оларды қолдайтын терминалды анықтағанда сұралғандай шығарады. BSD mandoc болса, тек қалың және сызылған мәтінді (курсивтің орнына) телекөлденеңінің артқа жылжу және қайта басу тізбегі арқылы қолдайды, оны ECMA 48 стандартына аудару қажет. Кейбір құралдар құжаттарды аз қиын форматтан нұсқаулық беттеріне түрлендіру үшін пайдаланылды. Мысалға, GNU-ның , ол шығыс және қосымша мазмұнды қабылдап, нұсқаулық бетін жасайды. Нұсқаулық аталған шығыстан көп пайдалы болмас еді, бірақ GNU бағдарламалары үшін бұл мәселе емес, өйткені texinfo – негізгі құжаттама жүйесі. Pandoc, ronn және md2man сияқты бірқатар құралдар Markdown-нан нұсқаулық беттеріне түрлендіруді қолдайды. Бұл құралдардың барлығы форматты шығарады, өйткені Markdown DocBook-тың семантикалық мазмұнына сәйкес келуге жеткілікті мүмкіндікке ие емес. DocBook-тың құрамында нашар сапалы адам(7) түрлендіргіші бар, mandoc авторы жеке mdoc(7) түрлендіргішін жазған. Нұсқаулық беттері көбінесе ағылшын тілінде жазылады, бірақ жүйеде басқа тілдерге аудармалар болуы мүмкін. GNU және mandoc ішкі каталогтардағы жергілікті нұсқаулық беттерін іздейтіні белгілі. Сонымен қатар, кейбір Unix GUI қолданбалары (әсіресе GNOME және KDE әзірлеу орталарын пайдалана отырып жасалған) енді HTML форматында соңғы пайдаланушы құжаттамасын ұсынады және қолданба ішінде көмекті оқу үшін yelp сияқты кіріктірілген HTML қараушыларын қамтиды. Emacs-тегі HTML жүйесі texinfo-ны алмастыруға жоспарлануда.