help2man - מקוון בענן

תָכְנִית:

שֵׁם

help2man - צור דף ידני פשוט

תַקצִיר

help2man [אוֹפְּצִיָה] ... ניתן לביצוע

תיאור

`help2man' יוצר דף אדם מתוך פלט `--help' ו-`--version'.

-n, --שֵׁם=STRING
תיאור לפסקה NAME

-s, --סָעִיף=SECTION
מספר קטע עבור דף ידני (1, 6, 8)

-m, --מדריך ל=טקסט
שם המדריך (פקודות משתמש, ...)

-S, --מָקוֹר=טקסט
מקור התוכנית (FSF, Debian, ...)

-L, --מקומי=STRING
בחר מיקום (ברירת מחדל "C")

-i, --לִכלוֹל=קובץ
כלול חומר מ-'FILE'

-I, --opt-include=קובץ
כלול חומר מ-'FILE' אם הוא קיים

-o, --תְפוּקָה=קובץ
שלח פלט ל'FILE'

-p, --דף מידע=טקסט
שם המדריך של Texinfo

-N, --אין מידע
לדכא מצביע למדריך של Texinfo

-l, --libtool
אל תכלול את 'lt-' משם התוכנית

- עזרה הדפס את העזרה הזו, ואז צא

--גִרְסָה
הדפס את מספר הגרסה ולאחר מכן צא

EXECUTABLE צריך לקבל אפשרויות `--help' ו-`--version' ולהפיק פלט על stdout
אם כי ניתן לציין חלופות באמצעות:

-h, --אפשרות עזרה=STRING
מחרוזת אפשרויות עזרה

-v, --גרסה-אופציה=STRING
מחרוזת אפשרויות גרסה

--גרסה-מחרוזת=STRING
מחרוזת גרסה

--no-discard-stderr
כלול stderr בעת ניתוח פלט אפשרויות

לִכלוֹל קבצים

חומר נוסף עשוי להיכלל בפלט שנוצר עם --לִכלוֹל ו
--opt-include אפשרויות. הפורמט פשוט:

[קטע]
טֶקסט

/תבנית/
טֶקסט

בלוקים של טקסט מילה במילה *roff מוכנסים לפלט בתחילת ה-
נתן [סעיף] (לא תלוי רישיות), או לאחר התאמת פסקה /דפוס/.

תבניות משתמשות בתחביר הביטוי הרגולרי של Perl ועשויות להיות אחריהן i, s or m
משנה (ראה פרלר(1)).

שורות לפני הקטע או התבנית הראשונה שמתחילות ב-'-' מעובדות כאפשרויות.
כל דבר אחר מתעלם בשקט ועשוי לשמש להערות, מילות מפתח RCS וכדומה.

סדר הפלט של המקטע (עבור אלה הכלולים) הוא:

שֵׁם
תַקצִיר
תיאור
אפשרויות
הסביבה
קבצים
דוגמאות
אַחֵר
AUTHOR
דיווח על באגים
זכויות יוצרים
ראה גם

כל [שֵׁם] or [תַקצִיר] קטעים המופיעים בקובץ include יחליפו את מה שיחליפו
הופקו אוטומטית (אם כי עדיין ניתן לעקוף את הקודם עם --שֵׁם
אם נדרש).

חלקים אחרים מוצמדים לפלט המופק אוטומטית עבור התקן
סעיפים שניתנו לעיל, או נכללו ב אַחֵר (למעלה) לפי הסדר שבו הם נתקלו
קובץ הכלול.

מיקום הטקסט בתוך הקטע עשוי להתבקש במפורש באמצעות התחביר
[<סעיף], [=סעיף] או [>סעיף] כדי למקם את הטקסט הנוסף לפני, במקום או
לאחר פלט ברירת המחדל בהתאמה.

זמינות

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

ftp://ftp.gnu.org/gnu/help2man/

השתמש ב-help2man באינטרנט באמצעות שירותי onworks.net