כיצד ליצור דף גברים של לינוקס

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

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

הבה ניצור דף אדם עבור תסריט הבאש הבא שכתבתי:

#!/bin/bash if [ "$1" == "h" ]; ואז הד "Hello" fi if [ "$1" = "b" ]; ואז הד "ביי" fi

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

תן לנו ליצור דף אדם עבור תוכנית זו. להשתמש מֶרֶץ או כל עורך לבחירתך ליצירת קובץ טקסט.

מבחן vim.1

הסיומת '.1' מסמנת שדף אדם זה מיועד לפקודת הפעלה. זו אינה כפייה אלא מוסכמה שאחריה קיימת באופן נרחב בזמן כתיבת דפי אדם. דף המדריך לאדם (גבר גבר !) מפרט את הקטגוריות:

 1 תוכניות הפעלה או פקודות מעטפת 2 קריאות מערכת (פונקציות המסופקות על ידי הליבה) 3 קריאות לספריה (פונקציות בתוך ספריות תוכניות) 4 קבצים מיוחדים (נמצאים בדרך כלל ב-/dev) 5 פורמטים ומוסכמות של קבצים כגון /etc/passwd 6 משחקים 7 שונות ( כולל חבילות מאקרו ומוסכמות), למשל man(7), groff(7) 8 פקודות ניהול מערכת (בדרך כלל רק עבור root) 9 שגרות ליבה [לא סטנדרטיות]

דף אדם נוצר באמצעות שפת הסימון הישנה מאוד של roff. יש לו פקודות (סמני קריאה) עבור כותרות וקטעים שונים.

• .TH – זו צריכה להיות הפקודה הראשונה בקובץ ה-man. הוא משמש לציון כותרת הכותרת של דף האדם.
• .SH – כותרת סעיף.
• .ב – הוא משמש להצגת הטקסט לידו בהדגשה.
• .TP - הוא משמש להצגת מידע על ארגומנט (דגל) לפקודה.
• .BR - הוא משמש להצגת טקסט מודגש ובגופן הרומי הרגיל.

להלן דף האיש עבור התוכנית שלי שנוצר באמצעות פקודות roff (פשוטות) לעיל בלבד.

.TH test.sh 1 .SH שם test.sh \- הדפס שלום או ביי .SH תקציר .B test.sh [h] [b] .SH תיאור .B test.sh זהו סקריפט לדוגמה שעושה רק 2 דברים . או שהוא מדפיס "Hello" אם הארגומנט הוא 'h' או שהוא מדפיס "ביי" אם הארגומנט הוא 'b' .SH OPTIONS .TP .BR h Print Hello .TP .BR b Print Bye

שמור את הקובץ על ידי לחיצה ראשונה על יציאה מקש ולאחר מכן הקלד :wq כדי לשמור את הקובץ ולצאת ממסוף vim.

בדוק את דף האיש שיצרנו זה עתה באמצעות הפקודה למטה:

גבר ./מבחן.1

למידע נוסף על איש שימוש, לרוץ דפי אדם פקודה בטרמינל שלך.

? עֵצָה

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