עדכון-yorickdoc - אונליין בענן

תָכְנִית:

שֵׁם

update-yorickdoc - בניית תיעוד HTML עבור יוריק

תַקצִיר

עדכון-yorickdoc [--conf=קובץ] [--אוטומטי] [--אוטו-עכשיו] [--מ=ספרייה] [--to=מַדרִיך]
[--xref-dir=ספרייה] [--src-dir=ספרייה] [--תבנית=קוֹבֶץ]

תיאור

update-yorickdoc הוא עטיפת קובץ סביב htmldoc.i, סקריפט Yorick שמחלץ DOCUMENT
תגובות מקבצי המקור של יוריק והופך אותן לקבוצת קבצי HTML.
update-yorickdoc מאחד קבצים מ"ספריית מקור" (ברירת מחדל: /usr/share/yorick-doc,
אפשרות שורת פקודה: --src-dir), מוחקת את ספריית היעד (ברירת מחדל:
/usr/share/doc/yorick-doc/html_xref), ואם יוריק מותקן, יקרא ל-"yorick -batch"
htmldoc.i" כדי לקמפל תיעוד HTML עבור כל הפונקציות המותקנות כעת (או
מחבילת יוריק הראשית או מחבילות תוספות).

update-yorickdoc נועד להיקרא אוטומטית בכל פעם שחבילת Yorick מופעלת
מותקן או מוסר. ניתן למנוע עדכונים אוטומטיים על ידי הגדרת "ENABLE_AUTO"
ל-0 ב-/etc/yorick-doc. ניתן גם להשתמש ב-update-yorickdoc באופן ידני כדי ליצור
תיעוד מספריות מותאמות אישית (למשל, של המשתמש עצמו) ~/יוריק/ ספרייה) או אל
מקום מותאם אישית, למשל.

ל-update-yorickdoc יש קבוצה של פרמטרים ברירת מחדל לפעולה. פרמטרים אלה הם
מודפס בסדר כרונולוגי על ידי התוכן /etc/yorick-doc, $HOME/.yorick-doc, ו-
שורת הפקודה.

נדרשים מספר קבצים כדי שסקריפט זה יפעל. קבצי ברירת מחדל מסופקים ב
ספריית המקור המוגדרת כברירת מחדל, וחבילות התוספות צריכות לספק מידע נוסף ב-
אותו מקום. ראה קבצים למטה וכן ב-/usr/share/doc/yorick-dev/yorick-policy.gz.

אפשרויות

--אוטומטי | -a
דגל זה יוצא משימוש עקב הופעת טריגרים ב-dpkg. במערכות שבהן dpkg
תומך בטריגרים, -a הופך את update-yorickdoc למצב של no-op. במערכות ישנות יותר, זה
מתנהג כמו -A למטה.

--אוטו-עכשיו | -A
דגל זה מיועד לשימוש רק בסקריפט postinst של חבילת yorick-doc,
שתורו אמור להיות מופעל בכל פעם שחבילת תוספות של יוריק מופעלת
הותקן, שודרג או הסיר. ניתן להפוך את update-yorickdoc לקובץ ללא אפשרות פעולה.
כאשר דגל זה מוגדר על ידי הגדרת ENABLE_AUTO ל-0 ב-/etc/yorick-doc.

--conf=פילה
קרא תצורה מקובץ זה. קובץ זה מנותח מכיוון שהאפשרות נמצאת ב
שורת פקודה, תוך החלפת האפשרויות הקודמות.

--מ=ספרייה1:ספרייה2...
רשימה של ספריות לסריקה אחר קבצי יוריק, המופרדות באמצעות נקודתיים. ברירת מחדל:
/usr/share/yorick/i:/usr/share/yorick/i0.

--לְטַהֵר | -p
מחקו רק את /usr/share/doc/yorick-doc/html_xref (או את הספרייה שהוגדרה באמצעות --to ו-
--xref-dir, או המשתנים המקבילים ב-/etc/yorick-doc), אל תבנה מחדש את
תיעוד לאחר מכן.

--שֶׁקֶט | -q
שקט, רק אומר בקצרה מה עושה update-yorickdoc. זה המובנה
ברירת מחדל אך ייתכן שנעקפה בקובץ תצורה.

--src-dir=בספרייה
ספרייה המכילה קבצי .packinfo, .keywords ו-.aliases בעת בניית ה-
תיעוד. כל אחד משלושת סוגי הקבצים הללו יקושר ב
סדר לקסיקוגרפי ומוזן ל-htmldoc.i באמצעות --packinfo, --keywords, ו-
אפשרויות --aliases (ראה htmldoc.i). ברירת מחדל: /usr/share/yorick-doc.

--תבנית=פילה
קובץ תבנית עבור htmldoc.i. הפורמט הנכון הוא htmldoc.i מפורט. ברירת מחדל:
/usr/share/yorick-doc/template.html.

--to=בספרייה
ספרייה ברמה העליונה של היררכיית ה-HTML של יוריק לעדכון. זוהי רמה אחת מעל
הספרייה שתימחק ו/או תיבנה מחדש. ברירת המחדל היא
/usr/share/doc/yorick-doc.

--מִלוּלִי | -v
היה מפורט, פלט הרבה מידע ניפוי שגיאות. ברירת המחדל המובנית היא להיות
שקט, רק אומר בקצרה מה עושה update-yorickdoc.

--xref-dir=מילה
ספריית המשנה של ספריית "TO" שבה יש לקמפל את התיעוד. מסוים
היפר-קישורים בתיעוד ישתמשו בערך זה. אין להגדיר אותו כ-
ספרייה שאת התוכן שלה אתה מעריך, מכיוון שספרייה זו תימחק תחילה. ברירת מחדל:
html_xref.

השתמש ב-update-yorickdoc באופן מקוון באמצעות שירותי onworks.net