כיצד למצוא תיעוד במערכת GNU / Linux שלי

רבים מאלה החדשים בעולם גנו / לינוקס הם מלאים בספקות ולא מצליחים למצוא תשובה מהירה לדאגותיהם, לפעמים אין להם אפילו קשר דרכו לגשת לפורום תמיכה ולבסוף מגיעים לרעיון שלינוס קשה מאוד עבורם.

רוב אלה שנקלעים למצב זה אינם מודעים לכך שהמערכת שלנו מכילה חלק טוב מהתשובות לדאגות הראשוניות שלנו. למעשה ישנם שלושה מקורות תיעוד במערכת גנו / לינוקס: דפים ידניים (דפי גבר), דפי מידע (דפי מידע) ומדריכים של יישומים ארוזים ב- / usr / share / doc.

במאמר זה נפרט על כל אחד מהמקורות הללו.

---

דפי גבר

העמודים הידניים או "דפי האיש" הם הצורות הקלאסיות של תיעוד הפניה ב- Linux וב- Unix. באופן אידיאלי, אתה יכול לחפש בעמודים הידניים אחר עזרה בכל פקודה, קובץ תצורה או שגרת ספרייה.

בפועל, לינוקס היא תוכנה חופשית, וחלק מהדפים לא נכתבו או מראים את גילם. עם זאת, דפי גבר הם המקום הראשון לחפש כשאתה זקוק לעזרה. כדי לגשת לדפי האיש, פשוט הקלד איש ואחריו הנושא שייחקר.

החלפת החלפה תתחיל, אז תלחץ q כשאני מסיים לקרוא. לדוגמא, כדי למצוא מידע על הפקודה ls, אני אכתוב:

איש $ לס

לדעת את החלקים של דפי האיש זה יכול להיות מועיל לקפוץ במהירות למידע שאתה צריך, תוכל למצוא את הסעיפים הבאים בעמוד האיש (תיבה 1):

טבלה 1: דפים ידניים

שֵׁם	שם הפקודה ותיאורה
תַקצִיר	כיצד להשתמש בפקודה
תיאור	הסבר מעמיק על אופן פעולת הפקודה
דוגמאות	הצעות לשימוש בפקודה
ראה גם	נושאים קשורים (בדרך כלל בדפי גבר)

חלקים מדפי האיש

הקבצים הכוללים את דפי האיש מאוחסנים ב / usr / share / man (או בתוך / usr / man בכמה מערכות ישנות). בתוך ספרייה זו, תמצא כי דפי המדריך מסודרים בסעיפים הבאים (תיבה 2).

טבלה 2: חלקי דפי המדריך

man1	תוכניות משתמשים
man2	שיחות מערכת
man3	פונקציות הספרייה
man4	קבצים מיוחדים
man5	פורמט קובץ
man6	משחקים
man7	שונות

דפי אדם מרובים

נושאים מסוימים קיימים ביותר ממקטע אחד. כדי להדגים זאת, אנו נשתמש בפקודה מה זה, המציג את כל דפי האיש הזמינים לנושא זה:

$ מה זה printf

printf (1) - פורמט והדפסת נתונים

printf (3) - המרת פלט מעוצבת

במקרה זה, איש printf זה יהיה בעמוד בסעיף 1 (תוכניות משתמשים). אם היינו כותבים תוכנית C, היינו מעוניינים יותר בעמוד בסעיף 3 (פונקציות הספרייה). אתה יכול להתקשר לחלק מסוים של דפי אדם על ידי ציון זה בשורת הפקודה, כדי לבקש הדפס, אנחנו יכולים לכתוב:

$ man 3 הדפסה

מציאת דף האיש הנכון

לפעמים קשה למצוא כמה דפי אדם בנושא מסוים. במקרה כזה, תוכל להשתמש איש-חבר כדי למצוא את הקטע NAME בדפי האיש. דעו שמדובר בחיפוש משנה, אז משהו כמו איש-ליס ייתן לך הרבה תפוקות, הנה דוגמה המשתמשת במילה ספציפית יותר:

$ man -k whatis whatis (1) - הדפס תיאורי עמודים ידניים

הכל על אפרופו

הדוגמה הקודמת הביאה לנו עוד כמה נקודות. ראשית, הפקודה אפרופו שווה ערך ל- איש-חבר, (למעשה, אתן לך סוד. כשתרוץ איש-חבר למעשה לרוץ אפרופו מאחורי הקלעים).

---

שורת הקוד של MANPATH

כעת נפנה לסוג התיעוד השני שנמצא במערכת GNU / Linux שלנו. כברירת מחדל, תוכנית האיש מחפשת את דפי האיש ב- / usr / share / man, / usr / local / man, / usr / X11R6 / man ואולי / opt / man. לפעמים אתה יכול למצוא את מה שאתה צריך על ידי הוספת נתיב נוסף לנתיב החיפוש. זה המקרה, פשוט ערוך /etc/man.conf בעורך טקסט והוסף שורה כמו הבאה:

MANPATH / opt / man

מכאן ואילך, כל דף גבר בספריה / opt / man יימצא. זכור שאתה צריך לרוץ שוב מקוואטיס כדי להוסיף דפי איש חדשים אלה למסד הנתונים מה זה.

---

מידע על GNU

אחד החסרונות של דפים ידניים הוא שהם אינם תומכים בהיפר טקסט ולכן אינך יכול לדלג בקלות מדף אחד לאחר. חברים של GNU מזהים את הפגם הזה, ולכן המציאו פורמט תיעוד אחר: דפי "מידע".

רבות מתוכניות GNU מגיעות עם תיעוד נרחב בפורמט דף המידע. אתה יכול להתחיל לקרוא דפי מידע באמצעות הפקודה מידע:

באופן זה נביא אינדקס של כל דפי המידע הזמינים במערכת. ניתן לנוע בהם באמצעות מקשי החצים, לעקוב אחר "קישורים" (המסומנים בכוכב) באמצעות מקש Enter ולצאת על ידי לחיצה q. המקשים מבוססים על Emacs, כך שיהיה קל לניווט אם אתה מכיר את העורך הזה.

למידע נוסף על השימוש ב מידעקרא את דף המידע שלהם. אתה אמור להיות מסוגל לנווט בהם באמצעות המקשים שהוזכרו לעיל:

מידע על מידע

---

/ usr / share / doc

יש מקור אחרון שיכול לעזור לך במערכת לינוקס. תוכניות רבות מצוידות בתיעוד נוסף בפורמטים אחרים: טקסט, PDF, PostScript, HTML, עד כמה שם.

הבט ב / usr / share / doc (/ usr / doc על מערכות ישנות). תוכלו למצוא רשימה ארוכה של ספריות, שכל אחת מהן מגיעה עם היישומים במערכת שלכם. חיפוש בתיעוד זה יכול לעתים קרובות לחשוף משהו מעניין, כגון הדרכות או תיעוד טכני נוסף. בדיקה מהירה מגלה המון חומר זמין לקריאה:

$ cd / usr / share / doc

$ למצוא. -סוג f | wc -l

---

במאמרים אחרים נתייחס למקורות תיעוד חיצוניים כגון The Linux Documentation Project (LDP), רשימות תפוצה וקבוצות דיון.

מקור: המאמר נלקח מ GUTL ונכתב על ידי מייקל ללמרט הרדיה. קישורים: https://blog.desdelinux.net, http://www.raybenjamin.com, http://forum.codecall.net, http://www.linfo.org,  http://www.esdebian.org