bundledoc - מקוון בענן

תָכְנִית:

שֵׁם

bundledoc - אגד את כל הקבצים הדרושים למסמך LaTeX

תַקצִיר

bundledoc [--גִרְסָה] [- עזרה] [--[לא]מִלוּלִי] [-- קובץ טקסט=פילה] [--מַדרִיך=בספרייה]
[--[לא]מקומי בלבד] [--לא לכלול=מחרוזת] [--לִכלוֹל=מפרט קבצים] [--לְהַפְגִין=פילה]
[--listdeps=[כן|לא|רק|rel]...] [--[לא]keepdirs] [--config=פילה] .dep פילה

תיאור

bundledoc הוא מעבד פוסט ל- תמונת מצב חבילה המאגדת את כל
מחלקות, חבילות וקבצים הדרושים לבניית מסמך LaTeX נתון. זה קורא את .dep
תייק את זה תמונת מצב מייצר, מוצא כל אחד מהקבצים המוזכרים בו, ואורז אותם
לתוך קובץ ארכיון בודד (למשל, א .tar.gz קובץ), מתאים למעבר בין מערכות,
שידור לעמית וכו'.

כדוגמה הפשוטה ביותר האפשרית, שקול קובץ LaTeX שנקרא, נניח, hello.tex:

\RequirePackage{snapshot} % נחוץ על ידי bundledoc
\documentclass[11pt]{מאמר}

\ התחל {document}
שלום, עולם!
\ end {document}

ה-"\RequirePackage{snapshot}" גורם ל-a hello.dep קובץ שיופק. מתי bundledoc is
לאחר מכן ניתן "hello.dep" כארגומנט, הוא מאתר את הקבצים התלויים -- snapshot.sty,
article.cls, ו מידה11.clo -- ומצרף אותם לקובץ ארכיון יחיד, יחד עם
hello.tex וכן לְהַפְגִין קובץ (מתואר ב"אפשרויות", למטה).

אפשרויות

בתיאורים הבאים, קובץ כלשהו מתייחס לשם של מסמך ה-LaTeX הראשי שלך (לא
סיומת).

bundledoc דורש את השם של קובץ התלות שהופק על ידי תמונת מצב (בדרך כלל
somefile.dep). ניתן לתת גם את האפשרויות הבאות:

--גִרְסָה
פלט את bundledoc מספר הגרסה של הסקריפט. זה עוקף את כל השאר
אפשרויות.

- עזרה
תן הודעת שימוש קצרה. זה עוקף את כל האפשרויות הנותרות.

--[לא]מִלוּלִי (ברירת מחדל: "noverbose")
bundledoc בדרך כלל אינו מוציא דבר מלבד הודעות שגיאה. עם "--verbose",
הוא מוציא הודעות סטטוס רבות.

-- קובץ טקסט=ראשי .tex פילה (בְּרִירַת מֶחדָל: somefile.tex)
תמונת מצבקובץ התלות של לא מפרט את קובץ ה-LaTeX הראשי (זה שמועבר
ל שרף גומי). על מנת ש bundledoc כדי למצוא ולצרור את הקובץ הזה, bundledoc מניח זאת
בעל שם זהה ל- תמונת מצב קובץ תלות אבל עם א .tex סיומת. אם זה
זה לא המקרה, אז השתמש ב---texfile כדי לציין את שם הקובץ הנכון.

--מַדרִיך=ארכיון בספרייה (בְּרִירַת מֶחדָל: קובץ כלשהו)
מתי bundledoc יוצר ארכיון (למשל, א .זֶפֶת or Zip. קובץ) המכיל את
הקבצים של המסמך, הוא מכניס את כולם לספרייה כדי למנוע עומס של הזרם
ספרייה עם קבצים. אם קוראים לקובץ התלות הנתון somefile.dep אז ה
הארכיון שיתקבל, כברירת מחדל, יאחסן את כל הקבצים התלויים ב-a קובץ כלשהו
מַדרִיך. כדי לשנות את שם הספרייה השתמש באפשרות "--directory".

--[לא]מקומי בלבד (ברירת מחדל: "nolocalonly")
למרות bundledoc בדרך כלל מאחסן את כל הקבצים הנקובים ב- .dep קובץ,
אפשרות "--localonly" מספרת bundledoc כדי לא לכלול את כל הקבצים שנמצאים בספרייה אחרת
מ .tex ספריית הקובץ או אחת מתיקיות המשנה שלו.

--לא לכלול=מחרוזת (בְּרִירַת מֶחדָל: אף לא אחד)
בעוד "--localonly" גורם לקבצים מחוץ ל .tex עץ הספריות של הקובץ להיות
הושמט מהארכיון, "--exclude" מספק שליטה עדינה יותר על קבצים
להשמיט מהארכיון. האפשרות "--exclude", אותה ניתן לציין שוב ושוב ב-
שורת הפקודה, גורמת לכל הקבצים ששמם מכיל מחרוזת שיש להשמיט מה
ארכיון.

--לִכלוֹל=מפרט קבצים (בְּרִירַת מֶחדָל: אף לא אחד)
אפשרות "--include", שניתן לציין שוב ושוב בשורת הפקודה,
מורה bundledoc לכלול בארכיון את כל הקבצים התואמים מפרט קבצים, גם
אם הם לא מוזכרים ב- .dep קובץ.

--לְהַפְגִין=גלוי פילה (בְּרִירַת מֶחדָל: לְהַפְגִין)
בנוסף לקבצים התלויים, bundledoc כולל בקובץ הארכיון תוספת אחת
קובץ שנקרא, כברירת מחדל, ``לְהַפְגִין''. לְהַפְגִין הוא קובץ טקסט המפרט את
שמות קבצים מקוריים של כל התלות. כדי לשנות את שם הקובץ מ- ``לְהַפְגִין''
למשהו אחר, השתמש באפשרות "--manifest". כמקרה מיוחד, "--manifest="""
אומר bundledoc לא לכלול קובץ מניפסט בכלל.

--listdeps=[yes|no|only|rel]...] (ברירת מחדל: "לא")
"--listdeps" מקבל אחד או יותר מ"כן", "לא", "בלבד" או "rel" כמופרד בפסיקים
רשימה. כל עוד "לא" לא מופיע ברשימה זו, bundledoc מוציא את כל העיקריים
התלות של קובץ LaTeX. אם הרשימה מכילה "rel", אז bundledoc מוציא את
רשימה של תלות עם שמות נתיבים יחסיים. אם הרשימה מכילה "רק", אז
bundledoc יוצא לאחר הצגת הרשימה, ללא הפקת ארכיון.

--[לא]keepdirs (ברירת מחדל: "nokeepdirs")
בדרך כלל, קובץ הארכיון ש bundledoc מייצר מכיל ספרייה אחת -- ו
ספריות משנה, אם המסמך מתייחס אליהן במפורש -- שבהן כל
שקר קבצים תלויים. אם צוין "--keepdirs", כל הקבצים התלויים מאוחסנים
עם שמות הנתיבים המקוריים שלהם. לדוגמה, אם somefile.tex תלוי
figures/somefigure.eps, article.cls, ו snapshot.sty, אז ה קובץ כלשהו צוואה בארכיון
בדרך כלל מכילים את הקבצים הבאים:

· somefile/somefile.tex

· somefile/figures/somefigure.eps

· somefile/article.cls

· somefile/snapshot.sty

· somefile/MANIFEST

עם זאת, "--keepdirs" יגרום ל- קובץ כלשהו ארכיון שיכיל את המינים הבאים
של שמות קבצים במקום:

· home/me/mydocs/somefile.tex

· home/me/mydocs/figures/somefigure.eps

· usr/share/texmf/tex/latex/base/article.cls

· usr/share/texmf/tex/latex/snapshot/snapshot.sty

"--directory" אינו בשימוש כאשר "--keepdirs" בתוקף. בנוסף, אין מניפסט
הקובץ נכתב לקובץ הארכיון מכיוון שהוא מכיל מידע מיותר.

--config=תצורה פילה (בְּרִירַת מֶחדָל: )
האפשרות "--config" משמשת להצבעה bundledoc לתצורה המתאימה
(.cfg) קובץ עבור הפצת TeX ומערכת ההפעלה שלך. bundledoc מגיע עם
מעט קבצי תצורה וקל לכתוב יותר. ראה "קובצי תצורה"
(להלן) לתיאור של פורמט קובץ התצורה.

תְצוּרָה קבצים

פוּרמָט
קובצי תצורה עוקבים אחר פורמט פשוט למדי. שורות המתחילות ב-"#" הן הערות.
מתעלמים מהשורות הריקות. כל שאר השורות הן מהצורה:

משתנה: ערך

הגירסה הנוכחית של bundledoc מזהה את המשתנים הבאים:

צורר
הפקודה לשימוש כדי לאגד קבוצה של קבצים לקובץ ארכיון בודד

כִּיוֹר
ההצמדה לפקודה כדי למחוק את הפלט שלה

למצוא
הפקודה למציאת קובץ בתוך עץ ה-TeX.

ניתן לפצל ערכים ארוכים מדי עבור שורה אחת על פני מספר שורות באמצעות "\" כ
סמל המשך הקו.

ישנם שני משתני סביבה bundledoc הופך זמין לשימוש על ידי
פקודות configuration-file: "BDBASE", המוגדר ל- קובץ כלשהו (כמו ב"אפשרויות"), וכן
"BDINPUTS", המוגדר לרשימה מופרדת ברווחים של קבצים שפקודה אמורה להפעיל
עַל. כלומר, כאשר הפקודה המשויכת ל"חבילה" פועלת, "BDINPUTS" מכיל
רשימת כל הקבצים שיש לאחסן בארכיון. לעומת זאת, כאשר הפקודה
המשויך ל-"find" פועל, "BDINPUTS" מכיל את שם הקובץ שיש לחפש.

דוגמאות
קובץ התצורה הבא מקביל bundledocערכי ברירת המחדל של השונות
משתני קובץ תצורה, המייצגים הפצת TeX מבוססת kpathsea הפועלת
על מערכת Unix גנרית, שאין בה בהכרח אף אחד מהכלים של GNU, כגון
מופעלת דחיסת או גנו זפת:

# קובץ תצורה "ברירת מחדל".
# מאת סקוט פאקין[מוגן בדוא"ל]>

חבילה: (tar -cvf - $BDINPUTS | דחיסה > $BDBASE.tar.Z)
sink: > /dev/null 2>&1
מצא: kpsewhich -progname=latex $BDINPUTS

הסוגריים בשורה "bundle:" אומרים למעטפת Unix להפעיל את הפקודה ב-a
subshell. זה כדי לגרום להדבקה של "כיור:" לעבוד כמו שצריך (כלומר, כך שלא יהיו שניים
">" נמצא באותה פקודה).

שימו לב כיצד הפקודות מתייחסות ל-"BDBASE" ול-"BDINPUTS" כמו כל משתני סביבה אחרים
במעטפת יוניקס, באמצעות "$" כדי לקחת את הערך שלהם. מערכות הפעלה אחרות משתמשות אחרת
מוסכמות להתייחסות למשתני סביבה. למשל, קובץ תצורה
עבור הפצת TeX מבוססת Windows תשתמש ב-"%BDBASE%" וב-"%BDINPUTS%" במקום זאת.

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

חבילה: (shar --archive-name="$BDBASE" $BDINPUTS > $BDBASE.sh)

או קובץ CAB ב-Microsoft Windows עם משהו כמו:

חבילה: cabarc -r -p N %BDBASE%cab %BDINPUTS%

דוגמאות

נניח ש myfile.dep הופק מ myfile.tex על ידי ביצוע ההוראות ב-
סעיף תיאור. הפקודה הבאה מייצרת א Zip. קובץ עם MikTeX TeX
הפצה הפועלת על Microsoft Windows:

bundledoc --config=miktex.cfg myfile.dep

(בפועל, כנראה שיש צורך לציין "--config" את הנתיב המלא אל
bundledoc's miktex.cfg קובץ תצורה.)

להלן בונה א .tar.gz ארכיון עם הפצת TeX Live פועלת על Unix-
כמו מערכת הפעלה. bundledoc יפיק פלט מילולי המתאר את פעולותיו.
כל הקבצים אינם נמצאים באותו עץ ספריות כמו myfile.tex וכל הקבצים המכילים ".fd" או
".sty" בשמותיהם מושמטים. עם זאת, כולם .ביב קבצים בספרייה הנוכחית
להיכלל בארכיון למרות שאף אחד מהם אינו מוזכר על ידי myfile.dep.
לבסוף, לא לְהַפְגִין הקובץ יופק.

bundledoc --config=texlive-unix.cfg --verbose --localonly \
--exclude=.fd --exclude=.cfg --include="*.bib" --manifest="" \
myfile.dep

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